OLD | NEW |
1 # spawn-fcgi module # | 1 # spawn_fcgi module # |
2 Author : Lars Fronius <lars@jimdo.com> | 2 Author : Lars Fronius <lars@jimdo.com> |
3 | 3 |
4 Version : 0.1 | 4 Version : 0.1 |
5 | 5 |
6 Licence : GPLv3 | 6 Licence : GPLv3 |
7 | 7 |
8 Fully puppet-lint compliant module for configuring spawn-fcgi pools via puppet. | 8 Fully puppet-lint compliant module for configuring spawn-fcgi pools via puppet. |
9 | 9 |
10 ## Intro ## | 10 ## Intro ## |
11 ``` | 11 ``` |
12 This module installs spawn-fcgi. | 12 This module installs spawn-fcgi. |
13 It is fully tested on Debian Squeeze. | 13 It is fully tested on Debian Squeeze. |
14 | 14 |
15 It installs an init-script, which uses worker pool configs from /etc/spawn-fcgi/ | 15 It installs an init-script, which uses worker pool configs from /etc/spawn-fcgi/ |
16 | 16 |
17 Pool-Configuration is made by 'spawn-fcgi::pool' definition. | 17 Pool-Configuration is made by 'spawn_fcgi::pool' definition. |
18 There is a wrapper for php-pool definitions in 'spawn-fcgi::php-pool' | 18 There is a wrapper for php-pool definitions in 'spawn_fcgi::php_pool' |
19 | 19 |
20 See below for details. | 20 See below for details. |
21 ``` | 21 ``` |
22 ## Class: spawn-fcgi ## | 22 ## Class: spawn_fcgi ## |
23 ``` | 23 ``` |
24 This class manage spawn-fcgi installation and init.d placement. | 24 This class manage spawn_fcgi installation and init.d placement. |
25 Use spawn-fcgi::pool or spawn-fcgi::php-pool for configuring spawn-fcgi worker p
ools. | 25 Use spawn_fcgi::pool or spawn_fcgi::php_pool for configuring spawn-fcgi worker p
ools. |
26 ``` | 26 ``` |
27 | 27 |
28 ## Define: spawn-fcgi::pool ## | 28 ## Define: spawn_fcgi::pool ## |
29 ``` | 29 ``` |
30 Defines spawn-fcgi pools. Places all pool snippets into | 30 Defines spawn-fcgi pools. Places all pool snippets into |
31 /etc/spawn-fcgi, where they will be automatically loaded | 31 /etc/spawn-fcgi, where they will be automatically loaded |
32 | 32 |
33 Parameters : | 33 Parameters : |
34 * ensure: typically set to "present" or "absent". | 34 * ensure: typically set to "present" or "absent". |
35 Defaults to "present" | 35 Defaults to "present" |
36 * pool_name: set name of pool, which is used to identify config template | 36 * pool_name: set name of pool, which is used to identify config template |
37 Defaults to 'pool' | 37 Defaults to 'pool' |
38 * content: set the content of the pool snippet. | 38 * content: set the content of the pool snippet. |
39 Defaults to 'template("spawn-fcgi/pool.d/$pool_name.conf.erb")', | 39 Defaults to 'template("spawn_fcgi/pool.d/$pool_name.conf.erb")', |
40 Undefined loads generic 'template("spawn-fcgi/pool.d/pool.conf.erb")' | 40 Undefined loads generic 'template("spawn_fcgi/pool.d/pool.conf.erb")' |
41 * order: specifies the load order for this pool snippet. | 41 * order: specifies the load order for this pool snippet. |
42 Defaults to "500" | 42 Defaults to "500" |
43 * fcgi_app: set binary to load fcgi-procs from | 43 * fcgi_app: set binary to load fcgi-procs from |
44 Defaults to '/bin/false' | 44 Defaults to '/bin/false' |
45 * fcgi_app_args: set the arguments to load binary with | 45 * fcgi_app_args: set the arguments to load binary with |
46 * ip: set the ip the fcgi pool should listen on | 46 * ip: set the ip the fcgi pool should listen on |
47 Defaults to '127.0.0.1' | 47 Defaults to '127.0.0.1' |
48 * port: set the port fcgi pool should listen on | 48 * port: set the port fcgi pool should listen on |
49 Defaults to '9000' | 49 Defaults to '9000' |
50 * socket: set path where to spawn unix-socket | 50 * socket: set path where to spawn unix-socket |
51 Only works if no ip is specified! | 51 Only works if no ip is specified! |
52 * mode: set file-mode of unix-socket | 52 * mode: set file-mode of unix-socket |
53 Only works when socket is specified. | 53 Only works when socket is specified. |
54 * children: set number fcgi children to spawn | 54 * children: set number fcgi children to spawn |
55 * chroot: set chroot for fcgi procs | 55 * chroot: set chroot for fcgi procs |
56 * user: set user to run fcgi procs with | 56 * user: set user to run fcgi procs with |
57 Defaults to 'www-data' | 57 Defaults to 'www-data' |
58 * group: set group to run fcgi procs with | 58 * group: set group to run fcgi procs with |
59 Defaults to 'www-data' | 59 Defaults to 'www-data' |
60 ``` | 60 ``` |
61 | 61 |
62 ## Define: spawn-fcgi::php-pool ## | 62 ## Define: spawn_fcgi::php_pool ## |
63 ``` | 63 ``` |
64 Define : spawn-fcgi::php-pool | 64 Define : spawn_fcgi::php_pool |
65 | 65 |
66 Define a spawn-fcgi pool snippet for php worker. Places all pool snippets into | 66 Define a spawn-fcgi pool snippet for php worker. Places all pool snippets into |
67 /etc/spawn-fcgi, where they will be automatically loaded. | 67 /etc/spawn-fcgi, where they will be automatically loaded. |
68 | 68 |
69 Parameters : | 69 Parameters : |
70 * ensure: typically set to "present" or "absent". | 70 * ensure: typically set to "present" or "absent". |
71 Defaults to "present" | 71 Defaults to "present" |
72 * pool_name: set name of pool, which is used to identify config template | 72 * pool_name: set name of pool, which is used to identify config template |
73 Defaults to 'pool' | 73 Defaults to 'pool' |
74 * content: set the content of the pool snippet. | 74 * content: set the content of the pool snippet. |
75 Defaults to 'template("spawn-fcgi/pool.d/$pool_name.conf.erb")', | 75 Defaults to 'template("spawn_fcgi/pool.d/$pool_name.conf.erb")', |
76 Undefined loads generic 'template("spawn-fcgi/pool.d/pool.conf.erb")' | 76 Undefined loads generic 'template("spawn_fcgi/pool.d/pool.conf.erb")' |
77 * order: specifies the load order for this pool snippet. | 77 * order: specifies the load order for this pool snippet. |
78 Defaults to "500" | 78 Defaults to "500" |
79 * ip: set the ip the fcgi pool should listen on | 79 * ip: set the ip the fcgi pool should listen on |
80 Defaults to '127.0.0.1' | 80 Defaults to '127.0.0.1' |
81 * port: set the port fcgi pool should listen on | 81 * port: set the port fcgi pool should listen on |
82 Defaults to '9000' | 82 Defaults to '9000' |
83 * socket: set path where to spawn unix-socket | 83 * socket: set path where to spawn unix-socket |
84 Only works if no ip is specified! | 84 Only works if no ip is specified! |
85 * mode: set file-mode of unix-socket | 85 * mode: set file-mode of unix-socket |
86 Only works when socket is specified. | 86 Only works when socket is specified. |
87 * children: set number fcgi children to spawn | 87 * children: set number fcgi children to spawn |
88 * chroot: set chroot for fcgi procs | 88 * chroot: set chroot for fcgi procs |
89 * user: set user to run fcgi procs with | 89 * user: set user to run fcgi procs with |
90 Defaults to 'www-data' | 90 Defaults to 'www-data' |
91 * group: set group to run fcgi procs with | 91 * group: set group to run fcgi procs with |
92 Defaults to 'www-data' | 92 Defaults to 'www-data' |
93 ``` | 93 ``` |
94 ## Sample Usage ## | 94 ## Sample Usage ## |
95 ``` | 95 ``` |
96 include spawn-fcgi | 96 include spawn_fcgi |
97 spawn-fcgi::php-pool { "global": | 97 spawn_fcgi::php_pool { "global": |
98 ensure => present, | 98 ensure => present, |
99 order => '000', | 99 order => '000', |
100 children => '15' | 100 children => '15' |
101 } | 101 } |
102 ``` | 102 ``` |
OLD | NEW |