Phusion Passenger

https://www.phusionpassenger.com/docs
Admin
Phusion Passenger is an open-source web and application server that handles HTTP requests, manages...
Tokens:193,566
Snippets:1,544
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Setup GOPATH and install gorilla/mux

Source: https://www.phusionpassenger.com/docs/advanced_guides/gls/go.html

Set the GOPATH environment variable, install the gorilla/mux package, and verify the installation.

```bash
export GOPATH=/path/to/your/go/project/root
go get -u github.com/gorilla/mux
ls $GOPATH/src/github.com/gorilla/mux/

```

--------------------------------

### Start Nginx with /opt/nginx/sbin/nginx

Source: https://www.phusionpassenger.com/docs/advanced_guides/install_and_upgrade/nginx/install/oss/rubygems_norvm.html

Starts the Nginx server installed by passenger-install-nginx-module. The command uses the default prefix /opt/nginx; substitute the actual prefix if a different one was chosen.

```shell
$ sudo /opt/nginx/sbin/nginx
```

--------------------------------

### Install Nginx with Passenger as static module

Source: https://www.phusionpassenger.com/docs/advanced_guides/install_and_upgrade/nginx/install_as_nginx_module.html

Full example showing how to configure and compile Nginx with Passenger and another module. Run from the Nginx source directory.

```bash
cd /path-to-nginx-source-dir
./configure --prefix=/opt/nginx \
  --add-module=$(passenger-config --nginx-addon-dir) \
  --add-module=/path-to-some-other-nginx-module
make
sudo make install
```

--------------------------------

### Start Nginx with sudo /opt/nginx/sbin/nginx

Source: https://www.phusionpassenger.com/docs/advanced_guides/install_and_upgrade/nginx/install/oss/rubygems_rvm.html

Starts the Nginx server installed by passenger-install-nginx-module. The command assumes the default prefix /opt/nginx; substitute the actual prefix if a different one was chosen.

```shell
copy$ sudo /opt/nginx/sbin/nginx
```

--------------------------------

### Install Go on macOS with Homebrew (interactive)

Source: https://www.phusionpassenger.com/docs/advanced_guides/gls/go.html

Install command line tools and Homebrew interactively, then install Go.

```bash
xcode-select --install
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew install go

```

--------------------------------

### Check Passenger installation instructions with brew info

Source: https://www.phusionpassenger.com/docs/advanced_guides/install_and_upgrade/nginx/install/oss/osx.html

Run 'brew info passenger' to display the Caveats section with instructions for activating Passenger in Nginx. The output is truncated with '...' in the example.

```bash
$ brew info passenger
...
==> Caveats
...

To activate Passenger, ...
(...more instructions that you should follow...)
```

--------------------------------

### Clone the Sinatra demo app

Source: https://www.phusionpassenger.com/docs/tutorials/quickstart

Clones the Sinatra demo application and changes into its directory. Use this as the starting point for the quickstart tutorial.

```shell
$ git clone https://github.com/phusion/passenger-ruby-sinatra-demo.git
$ cd passenger-ruby-sinatra-demo

```

--------------------------------

### Validate installation and check processes

Source: https://www.phusionpassenger.com/docs/tutorials/deploy_to_production/installations/oss/aws

Validate the installation with sudo passenger-config validate-install; all checks should pass. Then run sudo passenger-memory-stats to confirm Nginx and Passenger processes are running. If no Nginx or Passenger processes appear, consult the troubleshooting guide.

```bash
$ sudo passenger-config validate-install
 * Checking whether this Phusion Passenger install is in PATH... ✓
 * Checking whether there are no other Phusion Passenger installations... ✓
```

```bash
$ sudo passenger-memory-stats
Version: 5.0.8
Date   : 2015-05-28 08:46:20 +0200
...

---------- Nginx processes ----------
PID    PPID   VMSize   Private  Name
-------------------------------------
12443  4814   60.8 MB  0.2 MB   nginx: master process /usr/sbin/nginx
12538  12443  64.9 MB  5.0 MB   nginx: worker process
### Processes: 3
### Total private RSS: 5.56 MB

----- Passenger processes ------
PID    VMSize    Private   Name
--------------------------------
12517  83.2 MB   0.6 MB    PassengerAgent watchdog
12520  266.0 MB  3.4 MB    PassengerAgent server
12531  149.5 MB  1.4 MB    PassengerAgent logger
...
```

--------------------------------

### Install gems and initialize Capistrano

Source: https://www.phusionpassenger.com/docs/advanced_guides/deployment_and_scaling/nginx/automating_app_updates/ruby

Run bundle install to install the gem bundle, then run bundle exec cap install to initialize Capistrano. The output shows the created files: config/deploy.rb, config/deploy/staging.rb, config/deploy/production.rb, and Capfile.

```shell
$ bundle install
...
$ bundle exec cap install
mkdir -p config/deploy
create config/deploy.rb
create config/deploy/staging.rb
create config/deploy/production.rb
mkdir -p lib/capistrano/tasks
create Capfile
Capified
```

--------------------------------

### Release build and start with Passenger

Source: https://www.phusionpassenger.com/docs/advanced_guides/gls/swift.html

Build a release version, start the app with the passenger start command, and verify it with curl. Uses the PORT environment variable and the executable from the release build.

```bash
vapor build --release
passenger start --app-start-command "env PORT=\$PORT $(swift build --configuration release --show-bin-path)/Run serve --env prod --hostname 0.0.0.0"`.
# in another terminal
curl http://localhost:3000
```

--------------------------------

### passenger_app_start_command example with $PORT placeholder

Source: https://www.phusionpassenger.com/docs/references/config_reference

Specifies the command Passenger uses to start the app on a chosen port. The $PORT placeholder is replaced with an actual port number, e.g., /usr/local/bin/myapp --foreground --port 5000. This is the minimum configuration for Generic Language Support (GLS).

```nginx
passenger_app_start_command "/usr/local/bin/myapp --foreground --port $PORT";
```

--------------------------------

### Install chrony and enable NTP

Source: https://www.phusionpassenger.com/docs/tutorials/deploy_to_production/installations

Install and enable chrony, open the NTP firewall port, and restart chronyd to correct the system date.

```bash
sudo dnf -y install chrony
sudo systemctl enable chronyd
sudo firewall-cmd --permanent --add-service=ntp
sudo firewall-cmd --reload
sudo systemctl restart chronyd
```

--------------------------------

### Start Passenger server with bundle exec passenger start

Source: https://www.phusionpassenger.com/docs/tutorials/quickstart

Starts the Passenger Standalone server in development mode. The output shows the server's PID file, log file, environment, and the URL it is accessible at.

```shell
$ bundle exec passenger start
======= Phusion Passenger Standalone web server started =======
PID file: /Users/phusion/myapp/tmp/pids/passenger.3000.pid
Log file: /Users/phusion/myapp/log/passenger.3000.log
Environment: development
Accessible via: http://0.0.0.0:3000/

You can stop Phusion Passenger Standalone by pressing Ctrl-C.
===============================================================

```

--------------------------------

### Install Nginx with apt-get

Source: https://www.phusionpassenger.com/docs/tutorials/deploy_to_production/installations

Installs Nginx from the system repository. Required before installing the Passenger Nginx module if Nginx is not already present.

```bash
sudo apt-get install nginx
```

--------------------------------

### passenger_pre_start wrong example: missing sub-URI

Source: https://www.phusionpassenger.com/docs/references/config_reference

Incorrect example: omitting the sub-URI in passenger_pre_start causes the option to have no effect. The sub-URI must be included.

```nginx
passenger_pre_start http://myblog.com/;    # <----- WRONG! Missing "/store" part.

```

--------------------------------

### Correct example: two server blocks with passenger_app_group_name

Source: https://www.phusionpassenger.com/docs/references

Correct configuration that assigns unique passenger_app_group_name values so each customer gets its own application process and environment variables. Use this when running multiple versions of the same app for different customers.

```nginx
copyserver {
    listen 80;
    server_name customer1.foo.com;
    root /webapps/foo/public;
    passenger_enabled on;
    passenger_env_var CUSTOMER_NAME customer1;
    passenger_app_group_name foo_customer1;
}

server {
    listen 80;
    server_name customer2.foo.com;
    root /webapps/foo/public;
    passenger_enabled on;
    passenger_env_var CUSTOMER_NAME customer2;
    passenger_app_group_name foo_customer2;
}

```

--------------------------------

### Install system packages on Debian/Ubuntu

Source: https://www.phusionpassenger.com/docs/tutorials/deploy_to_production/installations/oss/aws/ruby/nginx

Installs curl, gnupg, and build-essential on Debian or Ubuntu systems. Required for further installation steps and for installing common Ruby gems.

```bash
$ sudo apt-get update
$ sudo apt-get install -y curl gnupg build-essential
```

--------------------------------

### Install Passenger dynamic Nginx module via dnf

Source: https://www.phusionpassenger.com/docs/tutorials/deploy_to_production/installations

Install prerequisites, add the Phusion Passenger RPM repository, and install the Passenger dynamic Nginx module. If the first install fails, it enables the CR repository and retries.

```bash
copy# Install various prerequisites
sudo dnf install -y  curl

# Add our el10 RPM repository
sudo dnf config-manager --add-repo https://oss-binaries.phusionpassenger.com/yum/definitions/el-passenger.repo

# Install Passenger dynamic Nginx module
sudo dnf install -y nginx-mod-http-passenger || { sudo dnf config-manager --enable cr && sudo dnf install -y nginx-mod-http-passenger ; }
```

--------------------------------

### Install system packages on Red Hat/CentOS/Rocky/Alma/Fedora/Amazon Linux/Scientific Linux

Source: https://www.phusionpassenger.com/docs/tutorials/deploy_to_production/installations/oss/aws/ruby/nginx

Installs curl, gpg, gcc, gcc-c++, make, which, and tar on Red Hat-based systems. Required for further installation steps and for installing common Ruby gems.

```bash
$ sudo dnf install -y curl gpg gcc gcc-c++ make which tar
```

--------------------------------

### Install Node.js on Ubuntu

Source: https://www.phusionpassenger.com/docs/tutorials/deploy_to_production/installations

Install Node.js on Ubuntu using apt-get and symlink the node binary to /usr/local/bin/node.

```bash
$ sudo apt-get install -y nodejs &&
$ sudo ln -sf /usr/bin/nodejs /usr/local/bin/node
```

--------------------------------

### Enable EPEL repository

Source: https://www.phusionpassenger.com/docs/tutorials/deploy_to_production/installations

Installs EPEL repository and enables it on Enterprise Linux.

```bash
sudo dnf install -y dnf-utils
sudo dnf install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-$(rpm -E %rhel).noarch.rpm
sudo dnf config-manager --enable epel
sudo dnf clean all && sudo dnf update -y
```

--------------------------------

### Install Bundler with gem

Source: https://www.phusionpassenger.com/docs/tutorials/deploy_to_production/installations

Installs Bundler, a tool for managing application gem dependencies, without generating documentation.

```shell
$ gem install bundler --no-rdoc --no-ri

```

--------------------------------

### passenger_min_instances example with passenger_max_pool_size and passenger_pool_idle_time

Source: https://www.phusionpassenger.com/docs/references/config_reference

Sets passenger_min_instances to 3 for the foobar.com server block, with passenger_max_pool_size 15 and passenger_pool_idle_time 10. When Nginx starts, no processes exist for foobar.com; the first visitor triggers one immediate process and two background spawns. After the idle timeout, the 3 processes are kept, and under a traffic spike Passenger spawns up to 12 more (15 - 3 = 12) and later cleans up 12, keeping 3.

```nginx
copyhttp {
    ...
    passenger_max_pool_size 15;
    passenger_pool_idle_time 10;

    server {
        listen 80;
        server_name foobar.com;
        root /webapps/foobar/public;
        passenger_min_instances 3;
    }
}

```

--------------------------------

### Enable EPEL repository

Source: https://www.phusionpassenger.com/docs/tutorials/deploy_to_production/installations

Install EPEL and enable it. This is required for Passenger on Enterprise Linux.

```bash
copy$ sudo dnf install -y dnf-utils
$ sudo dnf install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-$(rpm -E %rhel).noarch.rpm
$ sudo dnf config-manager --enable epel
$ sudo dnf clean all && sudo dnf update -y
```

--------------------------------

### Install Passenger Nginx module via APT

Source: https://www.phusionpassenger.com/docs/tutorials/deploy_to_production/installations

Adds Phusion's APT repository and installs the Passenger Nginx module. Requires an existing Nginx installation from the system repository; using a different Nginx repo requires compiling a dynamic module instead.

```bash
# Install our PGP key and add HTTPS support for APT
sudo apt-get install -y dirmngr gnupg apt-transport-https ca-certificates curl

curl https://oss-binaries.phusionpassenger.com/auto-software-signing-gpg-key-2025.txt | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/phusion.gpg >/dev/null

# Add our APT repository
sudo sh -c 'echo deb https://oss-binaries.phusionpassenger.com/apt/passenger trixie main > /etc/apt/sources.list.d/passenger.list'
sudo apt-get update

# Install Passenger + Nginx module
sudo apt-get install -y libnginx-mod-http-passenger
```

--------------------------------

### Install curl, gpg, and compiler toolchain

Source: https://www.phusionpassenger.com/docs/tutorials/deploy_to_production/installations

Install required packages on Debian/Ubuntu (apt) or Red Hat/CentOS/Rocky/Alma/Fedora/Amazon Linux/Scientific Linux (dnf). The compiler toolchain is needed for installing common Ruby gems.

```bash
$ sudo apt-get update
$ sudo apt-get install -y curl gnupg build-essential
```

```bash
$ sudo dnf install -y curl gpg gcc gcc-c++ make which tar
```

--------------------------------

### Install latest Ruby with RVM

Source: https://www.phusionpassenger.com/docs/tutorials/deploy_to_production/installations

Installs the latest Ruby version and sets it as the default using RVM. Run this when you do not have a specific Ruby version requirement.

```shell
$ rvm install ruby
$ rvm --default use ruby

```

--------------------------------

### Install RVM and configure rvmsudo_secure_path

Source: https://www.phusionpassenger.com/docs/tutorials/deploy_to_production/installations/oss/aws

Install RVM on the production server. The first block imports the RVM GPG keys, downloads and runs the RVM installer, and adds the current user to the rvm group. The second block conditionally sets the rvmsudo_secure_path environment variable when sudo is configured with secure_path, which is common on Linux but not macOS. After running these commands, you must relogin to activate RVM; RVM does not work in gnu screen or other terminal multiplexers.

```bash
$ sudo gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
$ curl -sSL https://get.rvm.io | sudo bash -s stable
$ sudo usermod -a -G rvm `whoami`
```

```bash
$ if sudo grep -q secure_path /etc/sudoers; then sudo sh -c "echo export rvmsudo_secure_path=1 >> /etc/profile.d/rvm_secure_path.sh" && echo Environment variable installed; fi
```

--------------------------------

### Create mod-http-passenger.conf with passenger_root and passenger_ruby

Source: https://www.phusionpassenger.com/docs/tutorials/deploy_to_production/installations

Example configuration lines to add to /etc/nginx/conf.d/mod-http-passenger.conf when the file is missing. Sets the Passenger root and Ruby interpreter paths.

```nginx
passenger_root /usr/lib/ruby/vendor_ruby/phusion_passenger/locations.ini;
passenger_ruby /usr/bin/passenger_free_ruby;
```

--------------------------------

### Install RVM with gpg and curl

Source: https://www.phusionpassenger.com/docs/tutorials/deploy_to_production/installations

Install RVM on the production server. You may need to use gpg2 instead of gpg on some systems. After installation, relogin to activate RVM; it won't work otherwise, and it won't work in gnu screen or another terminal multiplexer.

```bash
$ sudo gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
$ curl -sSL https://get.rvm.io | sudo bash -s stable
$ sudo usermod -a -G rvm `whoami`
```

--------------------------------

### Create project directories and main.go

Source: https://www.phusionpassenger.com/docs/advanced_guides/gls/go.html

Create the project directory structure and an empty main.go file.

```bash
mkdir -p $GOPATH/src/localhost/testing/helloworld/
cd $GOPATH/src/localhost/testing/helloworld/
touch $GOPATH/src/localhost/testing/helloworld/main.go

```

--------------------------------

### Run Passenger Nginx module installer

Source: https://www.phusionpassenger.com/docs/advanced_guides/install_and_upgrade/nginx/install/oss/rubygems_rvm.html

Starts the interactive Passenger Nginx module installer. Follow the on-screen instructions to complete the installation.

```bash
$ passenger-install-nginx-module
```

--------------------------------

### Install Node.js on Enterprise Linux with dnf

Source: https://www.phusionpassenger.com/docs/tutorials/deploy_to_production/installations

Install Node.js on Red Hat, CentOS, Rocky, Alma, Fedora, Amazon Linux, or Scientific Linux using dnf with the EPEL repository.

```bash
$ sudo dnf install -y "https://dl.fedoraproject.org/pub/epel/epel-release-latest-$(rpm -E %rhel).noarch.rpm"
$ sudo dnf install -y --enablerepo=epel nodejs npm
```

--------------------------------

### Wrong example: two server blocks without passenger_app_group_name

Source: https://www.phusionpassenger.com/docs/references

Shows a configuration that fails because both server blocks share the same application group name, so Passenger treats them as the same app and reuses the first process. Use this as a contrast to the corrected example that sets passenger_app_group_name.

```nginx
copy# WRONG example! Doesn't work!

server {
    listen 80;
    server_name customer1.foo.com;
    root /webapps/foo/public;
    passenger_enabled on;
    passenger_env_var CUSTOMER_NAME customer1;
}

server {
    listen 80;
    server_name customer2.foo.com;
    root /webapps/foo/public;
    passenger_enabled on;
    passenger_env_var CUSTOMER_NAME customer2;
}

```

--------------------------------

### Create project directory with curl and unzip

Source: https://www.phusionpassenger.com/docs/advanced_guides/gls/java.html

Creates the project directory by downloading and extracting the Spring guide archive, moving the initial project into place, and cleaning up unneeded files. Run these commands in the directory where you want the project to live.

```bash
copycurl -LO https://github.com/spring-guides/gs-serving-web-content/archive/master.zip
unzip master.zip
rm master.zip
mv gs-serving-web-content-master/initial/ ./
rm -rf gs-serving-web-content-master
cd initial
rm -rf *gradle* mvnw.cmd src/main/resources

```

--------------------------------

### Validate Passenger installation with passenger-config

Source: https://www.phusionpassenger.com/docs/advanced_guides/install_and_upgrade/nginx/install/oss/osx.html

Runs the validation script to check for common installation issues. The example output shows checks for PATH and duplicate installations passing.

```bash
$ sudo /usr/local/bin/passenger-config validate-install
 * Checking whether this Phusion Passenger install is in PATH... ✓
 * Checking whether there are no other Phusion Passenger installations... ✓
```

--------------------------------

### Install Node.js on Debian 7+ via NodeSource

Source: https://www.phusionpassenger.com/docs/tutorials/deploy_to_production/installations

Install Node.js on Debian 7 or later from the NodeSource APT repository. Requires apt-transport-https and ca-certificates.

```bash
$ sudo apt-get update &&
$ sudo apt-get install -y apt-transport-https ca-certificates &&
$ curl --fail -ssL -o setup-nodejs https://deb.nodesource.com/setup_8.x &&
$ sudo bash setup-nodejs &&
$ sudo apt-get install -y nodejs build-essential
```

--------------------------------

### Streaming response examples in Ruby (Rails and Rack)

Source: https://www.phusionpassenger.com/docs/references/config_reference

Two Ruby examples that stream responses incrementally. The first uses ActionController's render with a lambda that writes and flushes each entry. The second defines a Rack response object whose each method yields entries with a one-second delay. Both illustrate streaming behavior that is affected when passenger_buffer_response is enabled.

```ruby
render :text => lambda { |response, output|
  10.times do |i|
    output.write("entry #{i}\n")
    output.flush
    sleep 1
  end
}

```

```ruby
class Response
  def each
    10.times do |i|
      yield("entry #{i}\n")
      sleep 1
    end
  end
end

app = lambda do |env|
  [200, { "Content-Type" => "text/plain" }, Response.new]
end

```
Tokens:
Raw