Post

Rails 7 Deployment with Ubuntu, Capistrano, Puma and Nginx

Posted Updated
By Phuwanart Larpmark 6 min read

ในที่นี้เราจะทำการ deploy rails ไปที่ ubuntu server กัน โดยเราจะใช้ stack ดังนี้:

  • Ubuntu 22.04 LTS
  • Ruby 3.2.2
  • Rails 7.0.8
  • Puma 5
  • Capistrano

Setup Ubuntu

หลังจากติดตั้ง ubuntu server เรียบร้อยแล้วเราจะสามารถ login เป็น root (หรือชื่ออะไรก็ตามที่ใส่ตอนลง ubuntu) เข้า server ได้ด้วยคำสั่งนี้ โดยเปลี่ยน 1.2.3.4 เป็น IP ของเครื่อง

1

ssh root@1.2.3.4

พอ login เข้าได้แล้วก็ทำการอัพเดทระบบสักนึดนึง

1

sudo apt update && sudo apt upgrade -y && sudo apt-get autoremove && sudo reboot

ติดตั้ง net-tools เพื่อดู IP ของ server

1

sudo apt install net-tools

ติดตั้ง vim เป็น text editor (แล้วแต่ถนัด)

1

sudo apt install vim

Creating a Deploy User

สร้าง deploy user เพื่อใช้สำหรับลง เราจะไม่ใช้ root เพื่อความปลอดภัย

login เข้า root แล้วสร้าง user deploy และเพิ่มเข้า group sudo

1
2
3

sudo adduser deploy
sudo adduser deploy sudo
exit

จากนั้นเราจะเพิ่ม ssh key ของเรื่องเราไปที่ server เพื่อจะได้ login server ได้ง่าย ๆ โดยเครื่องมือที่เราจะใช้ชื่อ ssh-copy-id ถ้าเราใช้ Mac เราสามารถ brew install ssh-copy-id ได้เลย

1
2

ssh-copy-id root@1.2.3.4
ssh-copy-id deploy@1.2.3.4

หลังจากนี้เราจะ login เข้า deploy เพื่อทำขั้นตอนต่อไป

Installing Ruby

เริ่มจากลง package ที่จำเป็นสำหรับการ compile ruby เสียก่อน

1

sudo apt install -y git-core curl zlib1g-dev build-essential libssl-dev libreadline-dev libyaml-dev libsqlite3-dev sqlite3 libxml2-dev libxslt1-dev libcurl4-openssl-dev software-properties-common libffi-dev dirmngr gnupg apt-transport-https ca-certificates

ในที่นี้เราจะใช้ rbenv เป็นตัวจัดการเวอร์ชั่นของ ruby

1
2
3
4
5
6
7
8
9
10

git clone https://github.com/rbenv/rbenv.git ~/.rbenv
echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(rbenv init -)"' >> ~/.bashrc
exec $SHELL
git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
echo 'export PATH="$HOME/.rbenv/plugins/ruby-build/bin:$PATH"' >> ~/.bashrc
git clone https://github.com/rbenv/rbenv-vars.git ~/.rbenv/plugins/rbenv-vars
exec $SHELL
rbenv install 3.2.2
rbenv global 3.2.2

เสร็จแล้วก็ตรวจสอบสักนิดว่า rbenv ใช้งานได้แล้ว

1

curl -fsSL https://github.com/rbenv/rbenv-installer/raw/main/bin/rbenv-doctor | bash

ทำการอัพเดท gem ของระบบ

1

gem update --system

และ

1

gem install bundler

Installing NGINX

เราจะใช้ nginx เป็น webserver สามารถติดตั้งได้ตามขั้นตอนปกติ

1

sudo apt install nginx

หลังจากนั้นเราจะลบ default ที่ติดมาตอนลงออก

1

sudo rm /etc/nginx/sites-enabled/default

และทำการ restart nginx

1

sudo service nginx restart

Create Rails App

เราจะสร้าง app แบบง่าย ๆ เพื่อเป็นการทดสอบการ deploy

1

rails _7.0.8_ new appname

จากนั้นก็เอา app นี้ขึ้น github

Setup SSH keys

ในการ deploy เราจะต้องมีที่เก็บ code ไว้ ในที่นี้เราจะใช้ github ก่อนอื่นเราต้องเช็คก่อนเราสามารถต่อกับ github ได้

1

ssh -T git@github.com

ก่อนอื่นสร้าง ssh-key

1

ssh-keygen -t rsa

ให้เว้นว่างไม่ต้องใส่ password

แล้วเราสามารถดู key ที่สร้างด้วยคำสั่งนี้

1

cat ~/.ssh/id_rsa.pub

ทำตามขั้นตอนนี้ Set up deploy keys จากนั้นรันคำสั่ง ssh -T git@github.com อีกครั้ง ต้องขึ้นว่าสำเร็จ เป็นอันจบ

Setup Production Variables

ก่อนที่จะ deploy ครั้งแรกให้เราเข้าไปสร้างโฟลเดอร์ตาม location ที่กำหนดตาม set :deploy_to ใน config/deploy.rb จากนั้นสร้างไฟล์ .rbenv-vars

1
2
3

$ mkdir [DEPLOY_TO]
$ cd [DEPLOY_TO]
$ vim .rbenv-vars

จากนั้นเพิ่มตามนี้ลงไนไฟล์

1
2

SECRET_KEY_BASE=<random sequence> # use local `rails secret`
RAILS_ENV=production

SECRET_KEY_BASE เราสามารถสร้างได้ด้วยคำสั่งนี้บนเครื่อง local

1

rails secret

Setup Capistrano

เราจะใช้ capistrano สำหรับ automate deployments เพื่อให้การ deploy ทำได้ง่าย ๆ

เพิ่ม gem ที่จำเป็นใน Gemfile:

1
2
3
4
5
6
7

group :development do
  gem "bcrypt_pbkdf"
  gem "capistrano"
  gem "capistrano3-puma", "~> 5"
  gem "capistrano-rails"
  gem "ed25519"
end

ติดตั้ง gem ที่เพิ่มเข้ามา

1

bundle

ใช้ capistrano สร้างไฟล์ที่จำเป็นในการ deploy

1
2
3
4
5
6
7
8

$ 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

จากนั้นแก้ไฟล์ Capfile ตามนี้

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

# Load DSL and set up stages
require "capistrano/setup"

# Include default deployment tasks
require "capistrano/deploy"

# Load the SCM plugin appropriate to your project:
#
# require "capistrano/scm/hg"
# install_plugin Capistrano::SCM::Hg
# or
# require "capistrano/scm/svn"
# install_plugin Capistrano::SCM::Svn
# or
require "capistrano/scm/git"
install_plugin Capistrano::SCM::Git

# Include tasks from other gems included in your Gemfile
#
# For documentation on these, see for example:
#
#   https://github.com/capistrano/rvm
#   https://github.com/capistrano/rbenv
#   https://github.com/capistrano/chruby
#   https://github.com/capistrano/bundler
#   https://github.com/capistrano/rails
#   https://github.com/capistrano/passenger
#
# require "capistrano/rvm"
require "capistrano/rbenv"
# require "capistrano/chruby"
require "capistrano/bundler"
require "capistrano/rails/assets"
require "capistrano/rails/migrations"
# require "capistrano/passenger"

require "capistrano/puma"
install_plugin Capistrano::Puma
install_plugin Capistrano::Puma::Systemd
require "capistrano/puma/nginx"
install_plugin Capistrano::Puma::Nginx

# Load custom tasks from `lib/capistrano/tasks` if you have any defined
Dir.glob("lib/capistrano/tasks/*.rake").each { |r| import r }

จากนั้นแก้ไข้ไฟล์ config/deploy.rb ตามนี้

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

# config valid for current version and patch releases of Capistrano
lock "~> 3.18.0"

set :application, "[APP_NAME]"
set :user, "[DEPLOY_USER]"
set :repo_url, "[GIT SSH ADDRESS: git@github.com:username/appname.git]"

# Default branch is :master
# ask :branch, `git rev-parse --abbrev-ref HEAD`.chomp
set :branch, "main"

# Default deploy_to directory is /var/www/my_app_name
# set :deploy_to, "/var/www/my_app_name"
set :deploy_to, "/home/#{fetch :user}/#{fetch :application}"

# Default value for :format is :airbrussh.
# set :format, :airbrussh

# You can configure the Airbrussh format using :format_options.
# These are the defaults.
# set :format_options, command_output: true, log_file: "log/capistrano.log", color: :auto, truncate: :auto

# Default value for :pty is false
# set :pty, true

# Default value for :linked_files is []
append :linked_files, "config/database.yml", "config/master.key"

# Default value for linked_dirs is []
# append :linked_dirs, "log", "tmp/pids", "tmp/cache", "tmp/sockets", "public/system", "vendor", "storage"
append :linked_dirs, "log", "tmp/pids", "tmp/cache", "tmp/sockets", "public/system", "vendor/bundle", ".bundle", "storage"

# Default value for default_env is {}
# set :default_env, { path: "/opt/ruby/bin:$PATH" }

# Default value for local_user is ENV['USER']
# set :local_user, -> { `git config user.name`.chomp }

# Default value for keep_releases is 5
# set :keep_releases, 5

# Uncomment the following to require manually verifying the host key before first deploy.
# set :ssh_options, verify_host_key: :secure

set :rbenv_ruby, "3.2.2"

และสุดท้ายแก้ไขไฟล์ config/deploy/production.rb

1

server "[PRODUCTION_IP]", user: "[DEPLOY_USER]", roles: %w[app db web]

Deploy

เริ่มแรกให้รัน deploy:check ก่อน เพื่อเป็นการสร้างโครงสร้างของโฟลเดอร์บนเครื่องที่เราจะ deploy

1

cap production deploy:check

แน่นอนว่ามาถึงตรงนี้จะมี error ว่าไม่ไฟล์อย่าง database.yml, master.key ซึ่งเป็นรายชื่อไฟล์ที่เราทำหนดใน linked_files นั่นแหละ ให้เราทำการ copy ไปไว้ในเครื่อง deploy ก่อน

1
2

scp config/database.yml [DEPLOY_USER]@[PRODUCTION_IP]:[DEPLOY_TO]/shared/config/database.yml
scp config/master.key [DEPLOY_USER]@[PRODUCTION_IP]:[DEPLOY_TO]/shared/config/master.key

จากนั้นให้รันคำสั่งนี้

1

cap production puma:config

จากนั้นเป็นการ config ให้ใช้ puma ผ่าน systemd

1
2

cap production puma:systemd:config
cap production puma:systemd:enable

ในขั้นตอนนี้อาจจะมีการขอสิทธิ์ sudo ในตอนรันคำสั่ง ซึ่งจะมี error ประมาณนี้:

1
2
3
4
5
6
7
8
9

01 sudo /bin/systemctl restart puma_appname_production
01 sudo
01 :
01 a terminal is required to read the password; either use the -S option to read from standard input or configure an askpass helper
01
01 sudo
01 :
01 a password is required
01

ให้เรา login เข้า deploy user แล้วทำตามนี้:

1

sudo visudo

จากนั้นเพิ่ม deploy ALL=(ALL) NOPASSWD:ALL หลังบรรทัด %sudo ALL=(ALL:ALL) ALL

1
2
3
4

# Allow members of group sudo to execute any command
%sudo   ALL=(ALL:ALL) ALL

deploy  ALL=(ALL) NOPASSWD:ALL

ขั้นต่อไปรันคำสั่งนี้เพื่อเป็นการ config nginx

1

cap production puma:nginx_config

เมื่อเสร็จแล้วเราก็ต้อง restart nginx อีกสักรอบ

1

sudo service nginx restart

จากนั้นให้ทำการ deploy ได้เลย

1

cap production deploy

แล้วไปที่ browser แล้วไปที่ PRODUCTION_IP

บางที่เราอาจจะเจอกับ 503 bad gateway ซึ่งเมื่อดู log แล้วจะเป็นการฟ้องเรื่อง permission

1
2
3

tail -f /var/log/nginx/error.log

...failed (13: Permission denied)...

ให้เราทำการแก้ permission ของ deploy user ได้ด้วยคำสั่งนี้

1
2

cd /home
sudo chmod o=rx $USER/

และบางทีอาจจะเจอ 500 Internal Server Error ให้ไปดู log ของ puma_error.log หากเจอว่า

1

Permission denied @ rb_io_reopen - /home/.../shared/log/puma_access.log (Errno::EACCES)

ให้ทำการแก้ไข permission ของโฟลเดอร์ appname เสียก่อน

1

sudo chown $USER:$USER -R /home/$USER/appname/

จากนั้นก็ทำการ restart puma

1

cap production puma:restart

Conclusion

การ deploy แบบเริ่มต้นที่จำเป็นมีเท่านี้ ซึ่งในที่นี้เรายังขาดการติดตั้ง database และ background process ซึ่งส่วนตัวแล้วไม่ยากเท่าไรแล้วหลังเราผ่านการ deploy แบบเริ่มต้นมาแล้ว ไว้มีโอกาสจะมาทำเพิ่มเติมให้

References

Posts
rails deploy ubuntu capistrano puma nginx
This post is licensed under CC BY 4.0 by the author.