Mercurial > repos > other > Puppet

comparison modules/apache/README.passenger.md @ 0:956e484adc12

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial public release of Puppet configs
author IBBoard <dev@ibboard.co.uk>
date Sat, 16 Aug 2014 19:47:38 +0000
parents
children 37675581a273
comparison
equal deleted inserted replaced
-1:000000000000 0:956e484adc12
1 # Passenger
2
3 Just enabling the Passenger module is insufficient for the use of Passenger in production. Passenger should be tunable to better fit the environment in which it is run while being aware of the resources it required.
4
5 To this end the Apache passenger module has been modified to apply system wide Passenger tuning declarations to `passenger.conf`. Declarations specific to a virtual host should be passed through when defining a `vhost` (e.g. `rack_base_uris` parameter on the `apache::vhost` class, check `README.md`).
6
7 Also, general apache module loading parameters can be supplied to enable using a customized passenger module in place of a default-package-based version of the module.
8
9 # Parameters for `apache::mod::passenger`
10
11 The following declarations are supported and can be passed to `apache::mod::passenger` as parameters, for example:
12
13 ```
14 class {'apache::mod::passenger':
15 passenger_high_performance => 'on',
16 rails_autodetect => 'off',
17 mod_lib_path => '/usr/lib/apache2/custom_modules',
18 }
19 ```
20
21 The general form is using the all lower case version of the declaration.
22
23 ## Parameters used with passenger.conf
24
25 If you pass a default value to `apache::mod::passenger` it will be ignored and not passed through to the configuration file.
26
27 ### passenger_high_performance
28
29 Default is `off`, when turned `on` Passenger runs in a higher performance mode that can be less compatible with other Apache modules.
30
31 http://www.modrails.com/documentation/Users%20guide%20Apache.html#PassengerHighPerformance
32
33 ### passenger_max_pool_size
34
35 Set's the maximum number of Passenger application processes that may simultaneously run. The default value is 6.
36
37 http://www.modrails.com/documentation/Users%20guide%20Apache.html#_passengermaxpoolsize_lt_integer_gt
38
39 ### passenger_pool_idle_time
40
41 The maximum number of seconds a Passenger Application process will be allowed to remain idle before being shut down. The default value is 300.
42
43 http://www.modrails.com/documentation/Users%20guide%20Apache.html#PassengerPoolIdleTime
44
45 ### passenger_max_requests
46
47 The maximum number of request a Passenger application will process before being restarted. The default value is 0, which indicates that a process will only shut down if the Pool Idle Time (see above) expires.
48
49 http://www.modrails.com/documentation/Users%20guide%20Apache.html#PassengerMaxRequests
50
51 ### passenger_stat_throttle_rate
52
53 Sets how often Passenger performs file system checks, at most once every _x_ seconds. Default is 0, which means the checks are performed with every request.
54
55 http://www.modrails.com/documentation/Users%20guide%20Apache.html#_passengerstatthrottlerate_lt_integer_gt
56
57 ### rack_autodetect
58
59 Should Passenger automatically detect if the document root of a virtual host is a Rack application. The default is `on`
60
61 http://www.modrails.com/documentation/Users%20guide%20Apache.html#_rackautodetect_lt_on_off_gt
62
63 ### rails_autodetect
64
65 Should Passenger automatically detect if the document root of a virtual host is a Rails application. The default is on.
66
67 http://www.modrails.com/documentation/Users%20guide%20Apache.html#_railsautodetect_lt_on_off_gt
68
69 ### passenger_use_global_queue
70
71 Allows toggling of PassengerUseGlobalQueue. NOTE: PassengerUseGlobalQueue is the default in Passenger 4.x and the versions >= 4.x have disabled this configuration option altogether. Use with caution.
72
73 ## Parameters used to load the module
74
75 Unlike the tuning parameters specified above, the following parameters are only used when loading customized passenger modules.
76
77 ### mod_package
78
79 Allows overriding the default package name used for the passenger module package.
80
81 ### mod_package_ensure
82
83 Allows overriding the package installation setting used by puppet when installing the passenger module. The default is 'present'.
84
85 ### mod_id
86
87 Allows overriding the value used by apache to identify the passenger module. The default is 'passenger_module'.
88
89 ### mod_lib_path
90
91 Allows overriding the directory path used by apache when loading the passenger module. The default is the value of `$apache::params::lib_path`.
92
93 ### mod_lib
94
95 Allows overriding the library file name used by apache when loading the passenger module. The default is 'mod_passenger.so'.
96
97 ### mod_path
98
99 Allows overriding the full path to the library file used by apache when loading the passenger module. The default is the concatenation of the `mod_lib_path` and `mod_lib` parameters.
100
101 # Dependencies
102
103 RedHat-based systems will need to configure additional package repositories in order to install Passenger, specifically:
104
105 * [Extra Packages for Enterprise Linux](https://fedoraproject.org/wiki/EPEL)
106 * [Phusion Passenger](http://passenger.stealthymonkeys.com)
107
108 Configuration of these repositories is beyond the scope of this module and is left to the user.
109
110 # Attribution
111
112 The Passenger tuning parameters for the `apache::mod::puppet` Puppet class was modified by Aaron Hicks (hicksa@landcareresearch.co.nz) for work on the NeSI Project and the Tuakiri New Zealand Access Federation as a fork from the PuppetLabs Apache module on GitHub.
113
114 * https://github.com/puppetlabs/puppetlabs-apache
115 * https://github.com/nesi/puppetlabs-apache
116 * http://www.nesi.org.nz//
117 * https://tuakiri.ac.nz/confluence/display/Tuakiri/Home
118
119 # Copyright and License
120
121 Copyright (C) 2012 [Puppet Labs](https://www.puppetlabs.com/) Inc
122
123 Puppet Labs can be contacted at: info@puppetlabs.com
124
125 Licensed under the Apache License, Version 2.0 (the "License");
126 you may not use this file except in compliance with the License.
127 You may obtain a copy of the License at
128
129 http://www.apache.org/licenses/LICENSE-2.0
130
131 Unless required by applicable law or agreed to in writing, software
132 distributed under the License is distributed on an "AS IS" BASIS,
133 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
134 See the License for the specific language governing permissions and
135 limitations under the License.