We got nominated! Help us out and vote for GitHub as Best Bootstrapped Startup of 2008. (You can vote once a day.) [ hide ]

public
Description: Phusion Passenger (mod_rails)
Homepage: http://www.modrails.com/
Clone URL: git://github.com/FooBarWidget/passenger.git
Click here to lend your support to: passenger and make a donation at www.pledgie.com !
Change some names for trademark compliance.
Hongli Lai (Phusion) (author)
Thu May 22 07:47:54 -0700 2008
commit  ff059ca1ddea544b0a0865eb311a4e3f50db38bd
tree    d2da2addf0c717d140e456a9989080a69a81f859
parent  a02d73bb8e181287e2b030af490b3f950173ab7c
...
4
5
6
7
 
8
9
10
...
17
18
19
20
 
21
22
23
...
31
32
33
34
 
35
36
37
...
4
5
6
 
7
8
9
10
...
17
18
19
 
20
21
22
23
...
31
32
33
 
34
35
36
37
0
@@ -4,7 +4,7 @@
0
 
0
 The tests need the following software installed:
0
 
0
-* All the usual Passenger dependencies.
0
+* All the usual Phusion Passenger dependencies.
0
 * Ruby on Rails >= 2.0.1
0
 * rspec >= 1.1.2
0
 * mime-types >= 1.15
0
@@ -17,7 +17,7 @@ The following software is optional:
0
 * The font "Bitstream Vera Sans", used in the class diagrams. See http://www.gnome.org/fonts
0
 * AsciiDoc >= 8.2.5, for converting various doc/*.txt documents to HTML
0
 
0
-== Compiling Passenger
0
+== Compiling Phusion Passenger
0
 
0
 Run the following command to compile everything:
0
 
0
@@ -31,7 +31,7 @@ The most important directories are:
0
 [ ext/passenger ]
0
   Native extensions for Ruby, used by the spawn server.
0
 [ ext/apache2 ]
0
- The Passenger Apache 2 module (mod_passenger).
0
+ The Phusion Passenger Apache 2 module (mod_passenger).
0
 [ bin ]
0
   Executables.
0
 [ doc ]
0
...
1
2
3
4
 
 
5
6
7
...
1
2
 
 
3
4
5
6
7
0
@@ -1,7 +1,7 @@
0
 == Introduction
0
 
0
-Passenger probably requires no introduction. We kindly refer the reader to
0
-http://www.modrails.com/ for general information.
0
+Phusion Passenger probably requires no introduction. We kindly refer the reader
0
+to http://www.modrails.com/ for general information.
0
 
0
 == Installation
0
 
...
1
 
2
3
4
5
6
7
 
 
 
8
9
10
11
12
 
 
13
14
15
...
19
20
21
22
23
 
 
24
25
 
26
27
28
...
36
37
38
39
40
 
 
41
42
43
44
45
46
47
 
48
49
50
51
52
53
54
 
55
56
57
58
59
 
 
 
 
 
 
60
61
62
...
71
72
73
74
75
 
 
76
77
78
79
80
 
 
 
 
81
82
83
84
 
 
85
86
87
...
94
95
96
97
98
 
 
99
100
101
102
103
 
 
 
104
105
106
...
118
119
120
121
 
122
123
124
...
145
146
147
148
 
149
150
151
...
173
174
175
176
 
177
178
179
...
241
242
243
244
245
 
 
246
247
248
...
252
253
254
255
256
257
258
 
 
 
 
259
260
261
 
262
263
 
264
265
266
 
 
267
268
269
270
 
 
271
272
273
274
275
276
277
278
 
 
 
279
280
281
...
297
298
299
300
 
301
302
303
...
331
332
333
334
 
335
336
337
...
358
359
360
361
362
 
 
363
364
365
366
367
368
369
370
371
 
 
 
372
373
374
375
 
 
376
377
378
...
466
467
468
469
470
471
 
 
 
472
473
474
...
504
505
506
507
 
508
509
510
 
 
511
512
513
...
 
1
2
3
4
 
 
 
5
6
7
8
9
10
 
 
11
12
13
14
15
...
19
20
21
 
 
22
23
24
 
25
26
27
28
...
36
37
38
 
 
39
40
41
42
43
44
45
46
 
47
48
49
50
51
52
53
 
54
55
 
 
 
 
56
57
58
59
60
61
62
63
64
...
73
74
75
 
 
76
77
78
79
 
 
 
80
81
82
83
84
85
 
 
86
87
88
89
90
...
97
98
99
 
 
100
101
102
103
 
 
 
104
105
106
107
108
109
...
121
122
123
 
124
125
126
127
...
148
149
150
 
151
152
153
154
...
176
177
178
 
179
180
181
182
...
244
245
246
 
 
247
248
249
250
251
...
255
256
257
 
 
 
 
258
259
260
261
262
263
 
264
265
 
266
267
 
 
268
269
270
271
 
 
272
273
274
275
276
277
278
 
 
 
279
280
281
282
283
284
...
300
301
302
 
303
304
305
306
...
334
335
336
 
337
338
339
340
...
361
362
363
 
 
364
365
366
367
368
369
370
371
 
 
 
372
373
374
375
376
 
 
377
378
379
380
381
...
469
470
471
 
 
 
472
473
474
475
476
477
...
507
508
509
 
510
511
 
 
512
513
514
515
516
0
@@ -1,15 +1,15 @@
0
-= Passenger users guide =
0
+= Phusion Passenger users guide =
0
 
0
 image:images/phusion_banner.png[link="http://www.phusion.nl/"]
0
 
0
-Passenger is an Apache module, which makes deploying Ruby on Rails applications
0
-on Apache a breeze. It follows the usual Ruby on Rails conventions, such as
0
-"Don't-Repeat-Yourself" and ease of setup.
0
+Phusion Passenger is an Apache module, which makes deploying Ruby on Rails
0
+applications on Apache a breeze. It follows the usual Ruby on Rails conventions,
0
+such as "Don't-Repeat-Yourself" and ease of setup.
0
 
0
 This users guide will teach you:
0
 
0
-- How to install Passenger.
0
-- How to configure Passenger.
0
+- How to install Phusion Passenger.
0
+- How to configure Phusion Passenger.
0
 - How to deploy a Ruby on Rails application.
0
 - How to solve common problems.
0
 
0
@@ -19,10 +19,10 @@ using the commandline.
0
 
0
 == Supported operating systems ==
0
 
0
-Passenger works on any POSIX-compliant operating system. In other words:
0
-practically any operating system on earth, except Microsoft Windows.
0
+Phusion Passenger works on any POSIX-compliant operating system. In other
0
+words: practically any operating system on earth, except Microsoft Windows.
0
 
0
-Passenger has been tested on:
0
+Phusion Passenger has been tested on:
0
 
0
 - Ubuntu Linux 6.06 (x86)
0
 - Ubuntu Linux 7.10 (x86)
0
@@ -36,27 +36,29 @@ Passenger has been tested on:
0
 - MacOS X Tiger (x86)
0
 - MacOS X Leopard (x86)
0
 
0
-Other operating systems have not been tested, but Passenger will probably work
0
-fine on them. Please
0
+Other operating systems have not been tested, but Phusion Passenger will probably
0
+work fine on them. Please
0
 link:http://code.google.com/p/phusion-passenger/issues/list[report a bug]
0
 or
0
 link:http://groups.google.com/group/phusion-passenger[join our discussion list]
0
 if it doesn't.
0
 
0
 
0
-== Installing Passenger ==
0
+== Installing Phusion Passenger ==
0
 
0
 === Generic installation instructions ===
0
 
0
 [[install_passenger]]
0
 ==== Overview of download and installation methods ====
0
 
0
-There are two ways to install Passenger:
0
+There are two ways to install Phusion Passenger:
0
 
0
-1. By installing the Passenger gem, as instructed on the
0
- link:http://www.modrails.com/install.html[``Install'' page on the Passenger website].
0
-2. By downloading a native Linux package (e.g. Debian package) from the Passenger website.
0
-3. By downloading the source tarball from the Passenger website
0
+1. By installing the Phusion Passenger gem, as instructed on the
0
+ link:http://www.modrails.com/install.html[``Install'' page on the Phusion
0
+ Passenger website].
0
+2. By downloading a native Linux package (e.g. Debian package) from the
0
+ Phusion Passenger website.
0
+3. By downloading the source tarball from the Phusion Passenger website
0
    ('passenger-x.x.x.tar.gz').
0
 
0
 In our opinion, installing the gem or the native package is easiest.
0
@@ -71,17 +73,18 @@ you.
0
 [[specifying_correct_apache_install]]
0
 ==== Specifying the correct Apache installation ====
0
 
0
-NOTE: You can skip this section if you've installed Passenger via a native Linux
0
-package, because no compilation is necessary.
0
+NOTE: You can skip this section if you've installed Phusion Passenger via a
0
+native Linux package, because no compilation is necessary.
0
 
0
 If your system has multiple Apache installations (this is likely the case on
0
-MacOS X), then you will need to tell the Passenger installer which one to use.
0
-If you only have one Apache installation (the case on most Linux systems), then
0
-you can skip this section because Passenger will automatically detect it.
0
+MacOS X), then you will need to tell the Phusion Passenger installer which one
0
+to use. If you only have one Apache installation (the case on most Linux
0
+systems), then you can skip this section because Phusion Passenger will
0
+automatically detect it.
0
 
0
 Every Apache installation has its own `apxs` program. You will need to tell
0
-Passenger the location of this program, by specifying the `APXS2` environment
0
-variable. Suppose that you want to use the Apache installation in
0
+Phusion Passenger the location of this program, by specifying the `APXS2`
0
+environment variable. Suppose that you want to use the Apache installation in
0
 '/opt/apache2'. Then, assuming that the corresponding `apxs` program is located
0
 '/opt/apache2/bin/apxs', type:
0
 ----------------------------------
0
@@ -94,13 +97,13 @@ be located in the `sbin` folder instead of the `bin` folder.
0
 [[specifying_ruby_installation]]
0
 ==== Specifying the correct Ruby installation ====
0
 
0
-NOTE: You can skip this section if you've installed Passenger via a native Linux
0
-package, because no compilation is necessary.
0
+NOTE: You can skip this section if you've installed Phusion Passenger via a
0
+native Linux package, because no compilation is necessary.
0
 
0
 If your system has multiple Ruby installations (this is likely the case on
0
-MacOS X), then you will need to tell the Passenger installer which one to use.
0
-If you only have one Ruby installation (the case on most Linux systems), then
0
-you can skip this section because Passenger will automatically detect it.
0
+MacOS X), then you will need to tell the Phusion Passenger installer which one
0
+to use. If you only have one Ruby installation (the case on most Linux systems),
0
+then you can skip this section because Phusion Passenger will automatically detect it.
0
 
0
 To specify the Ruby installation, prepend your Ruby installation's `bin`
0
 directory to the `PATH` environment variable. For example, if you have the
0
@@ -118,7 +121,7 @@ export PATH=/opt/myruby/bin:$PATH
0
 
0
 ==== Installing via the gem ====
0
 
0
-Please install the gem and then run the Passenger installer, by typing the
0
+Please install the gem and then run the Phusion Passenger installer, by typing the
0
 following commands:
0
 ------------------------------------------------------
0
 gem install passenger-x.x.x.gem
0
@@ -145,7 +148,7 @@ will do in this case, is showing the correct Apache configurations.
0
 
0
 ==== Installing via the source tarball ====
0
 
0
-Extract the tarball to whatever location you prefer. The Passenger files
0
+Extract the tarball to whatever location you prefer. The Phusion Passenger files
0
 are to reside in that location permanently. For example, if you would like
0
 Passenger to reside in `/opt/passenger-x.x.x`:
0
 ------------------------------------------------------
0
@@ -173,7 +176,7 @@ on installing Phusion Passenger on OS X].
0
 
0
 ==== Ubuntu Linux ====
0
 
0
-Ben Hughes has written an link:http://www.railsgarden.com/2008/04/12/configurating-passenger-mod_rails-on-slicehost-with-ubuntu-710/[article on installing Passenger on Ubuntu].
0
+Ben Hughes has written an link:http://www.railsgarden.com/2008/04/12/configurating-passenger-mod_rails-on-slicehost-with-ubuntu-710/[article on installing Phusion Passenger on Ubuntu].
0
 
0
 
0
 == Deploying a Ruby on Rails application ==
0
@@ -241,8 +244,8 @@ There are two ways to restart the application:
0
 
0
 1. By restarting Apache.
0
 2. By creating or modifying the file 'tmp/restart.txt' in the Rails
0
- application's root folder. Passenger will automatically restart the
0
- application.
0
+ application's root folder. Phusion Passenger will automatically
0
+ restart the application.
0
 
0
 For example, to restart our example MyCook application, we type this in the
0
 command line:
0
@@ -252,30 +255,30 @@ touch /webapps/mycook/tmp/restart.txt
0
 
0
 === Migrations ===
0
 
0
-Passenger is not related to Ruby on Rails migrations in any way. To run
0
-migrations on your deployment server, please login to your deployment server
0
-(e.g. with 'ssh') and type `rake db:migrate RAILS_ENV=production` in a shell
0
-console, just like one would normally run migrations.
0
+Phusion Passenger is not related to Ruby on Rails migrations in any way. To
0
+run migrations on your deployment server, please login to your deployment
0
+server (e.g. with 'ssh') and type `rake db:migrate RAILS_ENV=production` in
0
+a shell console, just like one would normally run migrations.
0
 
0
 
0
-== Configuring Passenger ==
0
+== Configuring Phusion Passenger ==
0
 
0
-After installation, Passenger does not need any further configurations.
0
+After installation, Phusion Passenger does not need any further configurations.
0
 Nevertheless, the system administrator may be interested in changing
0
-Passenger's behavior. Passenger's Apache module supports the following
0
-configuration options:
0
+Phusion Passenger's behavior. Phusion Passenger's Apache module supports the
0
+following configuration options:
0
 
0
 === PassengerRoot <directory> ===
0
-The location to the Passenger root directory. This configuration option is
0
-essential to Passenger. The correct value is given by the installer,
0
+The location to the Phusion Passenger root directory. This configuration option
0
+is essential to Phusion Passenger. The correct value is given by the installer,
0
 and should usually not be changed manually.
0
 
0
 This required option may only occur once, in the global server configuration.
0
 
0
 === PassengerLogLevel <integer> ===
0
-This option allows one to specify how much information Passenger should write
0
-to the Apache error log file. A higher log level value means that more information
0
-will be logged.
0
+This option allows one to specify how much information Phusion Passenger should
0
+write to the Apache error log file. A higher log level value means that more
0
+information will be logged.
0
 
0
 Possible values are:
0
 
0
@@ -297,7 +300,7 @@ This option may occur multiple times, in the global server configuration or in a
0
 virtual host configuration block.
0
 
0
 === RailsAutoDetect <on|off> ===
0
-Whether Passenger should automatically detect whether a virtual host's
0
+Whether Phusion Passenger should automatically detect whether a virtual host's
0
 document root is a Ruby on Rails application. The default is 'on'.
0
 
0
 This option may occur in the global server configuration or in a virtual host
0
@@ -331,7 +334,7 @@ RailsAutoDetect off
0
 
0
 [[RailsAllowModRewrite]]
0
 === RailsAllowModRewrite <on|off> ===
0
-If enabled, Passenger will not override mod_rewrite rules. Please read
0
+If enabled, Phusion Passenger will not override mod_rewrite rules. Please read
0
 <<conflicting_apache_modules,Conflicting Apache modules>> for details.
0
 
0
 This option may occur once, in the global server configuration or in a virtual host
0
@@ -358,21 +361,21 @@ This subsection attempts to describe spawn methods, but it's okay if you don't (
0
 understand it, as it's mostly a technical detail. You can basically follow this rule of thumb:
0
 
0
 ************************************************
0
-If your application works on Mongrel, but not on Passenger, then set `RailsSpawnMethod`
0
-to 'conservative'. Otherwise, leave it at 'smart' (the default).
0
+If your application works on Mongrel, but not on Phusion Passenger, then set
0
+`RailsSpawnMethod` to 'conservative'. Otherwise, leave it at 'smart' (the default).
0
 ************************************************
0
 
0
 However, we do recommend you to try to understand it. The 'smart' spawn method brings
0
 many benefits.
0
 =========================================================
0
 
0
-Internally, Passenger spawns multiple Ruby on Rails processes in order to handle requests.
0
-But there are multiple ways with which processes can be spawned, each having its own set of
0
-pros and cons. Supported spawn methods are:
0
+Internally, Phusion Passenger spawns multiple Ruby on Rails processes in order to handle
0
+requests. But there are multiple ways with which processes can be spawned, each having
0
+its own set of pros and cons. Supported spawn methods are:
0
 
0
 smart::
0
-When this spawn method is used, Passenger will attempt to cache Ruby on Rails framework
0
-code and application code for a limited period of time.
0
+When this spawn method is used, Phusion Passenger will attempt to cache Ruby on Rails
0
+framework code and application code for a limited period of time.
0
 +
0
 *Pros:*
0
 This can significantly decrease spawn time (by as much as 90%). And, when Ruby Enterprise
0
@@ -466,9 +469,9 @@ The default value is 'on'.
0
 
0
 [[RailsDefaultUser]]
0
 === RailsDefaultUser <username> ===
0
-Passenger enables <<user_switching,user switching support>> by default.
0
-This configuration option allows one to specify which user Rails
0
-applications must run as, if user switching fails or is disabled.
0
+Phusion Passenger enables <<user_switching,user switching support>>
0
+by default. This configuration option allows one to specify which user
0
+Rails applications must run as, if user switching fails or is disabled.
0
 
0
 This option may only occur once, in the global server configuration.
0
 The default value is 'nobody'.
0
@@ -504,10 +507,10 @@ See also link:http://code.google.com/p/phusion-passenger/issues/detail?id=12[thi
0
 
0
 .Symptoms
0
 *******************************************************************************
0
-Installing Passenger fails because of one of the following errors:
0
+Installing Phusion Passenger fails because of one of the following errors:
0
 
0
-- The Passenger installer tells you that the Ruby development headers aren't
0
- installed.
0
+- The Phusion Passenger installer tells you that the Ruby development headers
0
+ aren't installed.
0
 - The error message ``'no such file to load -- mkmf''' occurs.
0
 - The error message ``'ruby.h: No such file or directory''' occurs.
0
 *******************************************************************************

Comments

    No one has commented yet.