Object

Constants

APACHE2_DIRECTORY_CONFIGURATION_OPTIONS

This file defines all supported Apache per-directory configuration options. The build system automatically generates the corresponding Apache module boilerplate code from the definitions in this file.

Main configuration options are not defined in this file, but are defined in ext/apache2/Configuraion.cpp instead.

The following boilerplate code is generated:

* command_rec array members (ConfigurationCommands.cpp.erb)

Options:

* name - The configuration option name. Required.
* context - The context in which this configuration option is valid.
            Defaults to ["OR_OPTIONS", "ACCESS_CONF", "RSRC_CONF"]
* type - This configuration option's value type. Allowed types:
         :string, :integer, :flag
* min_value - If `type` is :integer, then this specifies the minimum
              allowed value. When nil (the default), there is no minimum.
* desc - A description for this configuration option. Required.

COMMON_LIBRARY

LOCATION_CONFIGURATION_OPTIONS

This file defines all supported Nginx per-location configuration options. The build system automatically generates the corresponding Nginx module boilerplate code from the definitions in this file.

Main configuration options are not defined in this file, but are defined in ext/nginx/Configuraion.c instead.

The following boilerplate code is generated:

* ngx_command_t array members (ConfigurationCommands.c.erb)
* Location configuration structure definition (ConfigurationFields.h.erb)
* Location configuration structure initialization (CreateLocationConfig.c.erb)
* Location configuration merging (MergeLocationConfig.c.erb)
* Conversion of configuration options to CGI headers (CacheLocationConfig.c.erb)

Options:

* name - The configuration option name. Required.
* context - The context in which this configuration option is valid.
            Defaults to [:main, :srv, :loc, :lif]
* type - This configuration option's value type. Allowed types:
         :string, :integer, :flag, :string_array, :string_keyval
* take - Tells Nginx how many parameters and what kind of parameter
         this configuration option takes. It should be set to a string
         such as "NGX_CONF_FLAG".
         By default this is automatically inferred from `type`: for
         example if `type` is :string then ConfigurationCommands.c.erb
         will infer that `NGX_CONF_TAKE1` should be used.
* function - The name of the function that should be used to store the
             configuration value into the corresponding structure. This function
             is not auto-generated, so it must be the name of an existing
             function. By default, the function name is automatically inferred
             from `type`. For example if `type` is string then `function` is
             inferred to be `ngx_conf_set_str_slot`.
             If you set this to a string then you are responsible for defining
             said function in Configuration.c.
* struct - The type of the struct that the field is contained in. Something like
           "NGX_HTTP_LOC_CONF_OFFSET" (which is also the default).
* field - The name that should be used for the auto-generated field in
          the location configuration structure. Defaults to the configuration
          name without the 'passenger_' prefix. Set this to nil if you do not
          want a structure field to be auto-generated. If the field name contains
          a dot (.e.g `upstream_config.pass_headers`) then the structure field will
          also not be auto-generated, because it is assumed to belong to an existing
          structure field.
* header - The name of the corresponding CGI header. By default CGI header
           generation code is automatically generated, using the configuration
           option's name in uppercase as the CGI header name.
           Setting this to nil, or setting `field` to a value containing a dot,
           will disable auto-generation of CGI header generation code. You are
           then responsible for writing CGI header passing code yourself in
           ContentHandler.c.
* auto_generate_nginx_merge_code - Whether location configuration merging
          code should be automatically generated. Defaults to true. If you set
          this to false then you are responsible for writing merging code
          yourself in Configuration.c.
* alias_for - Set this if this configuration option is an alias for another
              option. Alias definitions must only have the `name` and `alias_for`
              fields, nothing else.

NGINX_LIBS_SELECTOR

Objects that must be linked into the Nginx binary.