使用 Nginx + Puma 部署 Rails 应用

以前部署 Rails 应用使用的是 Nginx + Passenger，非常方便。这次没用这个方案是因为我买了一个每月2.5刀的最低配的 VPS，根本安装不了 Passenger......。于是我在网上搜了一下其他方案，Rails 应用服务器大概常见的有这么3种：unicorn、puma、passenger。3 个都支持集群， puma 和 passenger 企业版支持多线程，unicorn 不支持多线程。passenger 除了支持 ruby on rails 外也支持其他的语言，如 python、nodejs。看起来个人使用 puma 是一个非常不错的选择，免费开源，功能强大，可配置性也很好，而且它是 rails 默认的服务器。

大概的原理

Nginx 作为反向代理服务器，负责监听主机域名的 HTTP 请求。接到客户端的请求后，通过 upstream 指令将请求交给 Puma 应用服务器处理，它们之间通过 unix socket 建立连系。Puma 负责监听 sockets，接到请求后调用 APP 生成页面，将结果返回给 Nginx 服务器，Nginx 再把结果返回给客户。

Nginx + Puma 配置

1. 安装 Nginx

unbuntu 下直接通过 apt-get 安装就可以了。

sudo apt-get install nginx

nginx 配置文件 /etc/nginx/sites-enabled/default

upstream app {
    // 改成实际 puma.sock 的文件路径
    server unix:/home/vagrant/foo/shared/sockets/puma.sock;
}

server {
    listen 80;
    // 改成实际服务器域名
    server_name 192.168.1.2;

    // 改成实际 APP 路径
    root /home/vagrant/foo/public;

    try_files $uri/index.html $uri @app;

    location @app {
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $http_host;
        proxy_redirect off;
        proxy_pass http://app;
    }

    error_page 500 502 503 504 /500.html;
    keepalive_timeout 10;
}

安装 Puma

在 Gemfile 文件里添加，rails 5 是默认的，就不需要了。

gem 'puma', '~> 3.7'

执行 bundle install。

puma 配置文件 config/puma.rb。

# workers 数改成实际 CPU 数，可通过 grep -c processor /proc/cpuinfo 查询
workers 1
threads 1, 6
daemonize true
rails_env = ENV['RAILS_ENV'] || "production"
environment rails_env
app_dir = File.expand_path("../..", __FILE__)
shared_dir = "#{app_dir}/shared"
bind "unix://#{shared_dir}/sockets/puma.sock"
stdout_redirect "#{shared_dir}/log/puma.stdout.log", "#{shared_dir}/log/puma.stderr.log", true
pidfile "#{shared_dir}/pids/puma.pid"
state_path "#{shared_dir}/pids/puma.state"

on_worker_boot do
  require "active_record"
  ActiveRecord::Base.connection.disconnect! rescue ActiveRecord::ConnectionNotEstablished
  ActiveRecord::Base.establish_connection(YAML.load_file("#{app_dir}/config/database.yml")[rails_env])
end

新建 puma 的日志、PID、和 Sockets 文件夹。

mkdir -p shared/log shared/pids shared/sockets

设置 rails 生成环境的 SECRET_KEY。

生成 key
$ rake secret

打开 bash 配置文件
$ vim ~/.bashrc

添加环境变量
export SECRET_KEY_BASE="这里是 rake secret 生成的字符串"

重新加载 bash 配置
$ source ~/.bashrc

如果只是临时试试，也可以在命令行上执行
$ export SECRET_KEY_BASE="`rake secret`"

新建 puma 控制脚本

在 APP 目录下新建 pumactrl.sh 文件
$ vim pumactrl.sh

#!/bin/bash

case "$1" in
    "")
        echo -n "please provide a parameter (start, stop, reload)."
        ;;
    start)
        echo -n "starting puma..."
        puma
        ;;
    stop)
        echo "stoping puma..."
        kill `cat "shared/pids/puma.pid"`
        ;;
    reload)
        echo "reloading puma..."
        kill `cat "shared/pids/puma.pid"`
        puma
        ;;
esac

重启服务器

重启 Nginx
$ sudo service nginx restart

启动 puma 服务器
$ ./pumactrl.sh start

如果一切正常，打开浏览器就可以看到你的网站首页了。不过我是反复试了很多次才成功的......。有时候编程的复杂性不在于代码逻辑本身，而是其他很多繁杂琐碎的东西同时揉在一起产生的。

有几个点需要注意：

• 仔细检查配置里的各种路径
• puma 配置里的 bind "unix://#{shared_dir}/sockets/puma.sock" 前缀是双斜杠
• 如果是生产环境下，需要先执行一下 rails assets:precompile
• 出现问题的时候检查日志

  // nginx 日志
  /var/log/nginx/error.log
  
  // puma日志
  shared/log/puma.stderr.log
  
  // rails app 日志
  log/production.log
  

小结

服务器虽然能正常跑起来了，但是没有做更细致的配置，可能性能不是很好，这个得更深一步的研究才能做了。为了方便部署，可以将 capistrano3-puma Gem 添加进来，这个留待下次完成。