config_options.rb

Path: lib/phusion_passenger/apache2/config_options.rb
Last Update: Mon Aug 28 10:15:08 +0000 2017

Phusion Passenger - www.phusionpassenger.com/ Copyright (c) 2013 Phusion

"Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Constants

APACHE2_DIRECTORY_CONFIGURATION_OPTIONS = [ { :name => "PassengerRuby", :type => :string, :desc => "The Ruby interpreter to use.", :header_expression => "config->ruby ? config->ruby : serverConfig.defaultRuby"   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.
 * 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 will disable auto-generation of CGI header
            generation code. You are then responsible for writing CGI header
            passing code yourself in Hooks.cpp.

[Validate]