0
-= P
assenger users guide =
0
+= P
husion Passenger users guide =
0
image:images/phusion_banner.png[link="http://www.phusion.nl/"]
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
This users guide will teach you:
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
@@ -19,10 +19,10 @@ using the commandline.
0
== Supported operating systems ==
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
-P
assenger has been tested on:
0
+P
husion Passenger has been tested on:
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 Leopard (x86)
0
-Other operating systems have not been tested, but Passenger will probably work
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
link:http://groups.google.com/group/phusion-passenger[join our discussion list]
0
-== Installing P
assenger ==
0
+== Installing P
husion Passenger ==
0
=== Generic installation instructions ===
0
==== Overview of download and installation methods ====
0
-There are two ways to install P
assenger:
0
+There are two ways to install P
husion Passenger:
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
+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
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
-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
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
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
-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
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
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
==== Installing via the gem ====
0
-Please install the gem and then run the P
assenger installer, by typing the
0
+Please install the gem and then run the P
husion Passenger installer, by typing the
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
==== Installing via the source tarball ====
0
-Extract the tarball to whatever location you prefer. The P
assenger files
0
+Extract the tarball to whatever location you prefer. The P
husion 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
-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 P
assenger 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 P
husion Passenger on Ubuntu].
0
== Deploying a Ruby on Rails application ==
0
@@ -241,8 +244,8 @@ There are two ways to restart the application:
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's root folder. Phusion Passenger will automatically
0
+ restart the application.
0
For example, to restart our example MyCook application, we type this in the
0
@@ -252,30 +255,30 @@ touch /webapps/mycook/tmp/restart.txt
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
-== Configuring P
assenger ==
0
+== Configuring P
husion Passenger ==
0
-After installation, P
assenger does not need any further configurations.
0
+After installation, P
husion 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
+Phusion Passenger's behavior. Phusion Passenger's Apache module supports the
0
+following configuration options:
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
This required option may only occur once, in the global server configuration.
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
+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
@@ -297,7 +300,7 @@ This option may occur multiple times, in the global server configuration or in a
0
virtual host configuration block.
0
=== RailsAutoDetect <on|off> ===
0
-Whether P
assenger should automatically detect whether a virtual host's
0
+Whether P
husion Passenger should automatically detect whether a virtual host's
0
document root is a Ruby on Rails application. The default is 'on'.
0
This option may occur in the global server configuration or in a virtual host
0
@@ -331,7 +334,7 @@ RailsAutoDetect off
0
[[RailsAllowModRewrite]]
0
=== RailsAllowModRewrite <on|off> ===
0
-If enabled, P
assenger will not override mod_rewrite rules. Please read
0
+If enabled, P
husion Passenger will not override mod_rewrite rules. Please read
0
<<conflicting_apache_modules,Conflicting Apache modules>> for details.
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
-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
However, we do recommend you to try to understand it. The 'smart' spawn method brings
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
-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
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
=== 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
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
-Installing P
assenger fails because of one of the following errors:
0
+Installing P
husion Passenger fails because of one of the following errors:
0
-- The Passenger installer tells you that the Ruby development headers aren't
0
+- The Phusion Passenger installer tells you that the Ruby development headers
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.