Mastodon 生產部署指南

junbaor發表於2019-03-02
AST

翻譯：github.com/tootsuite/d…

Mastodon 生產指南

免責宣告:

本指南是針對 Ubuntu Server 16.04 編寫的, 如果使用其他作業系統，則可能會遇到問題。我們歡迎對其他發行版的指南作出貢獻。

此文件希望你有足夠高的技術管理 Linux 伺服器。

這本指南是什麼?

本指南介紹了 Mastodon 例項的部署過程。

我們用 example.com 表示域名或者子域名。 example.com 應該替換成你自己的域名或者子域名。

先決條件

本指南需要以下內容:

DNS

在伺服器上完成任何操作之前，應先新增 DNS 記錄。

新增的記錄:

  • A 記錄 (IPv4 地址) 解析到 example.com
  • AAAA 記錄 (IPv6 地址) 解析到 example.com

一個有用但是非必須的提醒

使用 tmux 將會對本指南有所幫助。

不僅如此, 如果您斷開連線, 這不僅可以幫助您找回失去的位置, 還可以開啟多個終端視窗, 用來切換上下文 (root 使用者和 mastodon 使用者).

你可以從包管理器安裝 tmux :

apt -y install tmux複製程式碼

依賴安裝

所有的依賴項都應該以 root 身份安裝.

node.js 倉庫

您需要新增一個外部儲存庫，以便我們可以使用需要的 node.js 版本。

我們執行此指令碼來新增儲存庫:

apt -y install curl
curl -sL https://deb.nodesource.com/setup_6.x | bash -複製程式碼

這個 node.js 儲存庫已經新增完成.

Yarn 倉庫

需要新增另一個儲存庫, 以便我們可以獲得 Mastodon 使用的 Yarn 版本.

你應該這樣新增儲存庫:

curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list
apt update複製程式碼

各種其他依賴

現在你需要安裝 Yarn 加上一些更多的軟體.

依賴關係說明

  • imagemagick – Mastodon 使用 imagemagick 進行影像相關操作
  • ffmpeg – Mastodon 使用 ffmpeg 將 GIF 轉換為 MP4
  • libprotobuf-dev 和 protobuf-compiler – Mastodon 用他們進行語言檢測
  • nginx – nginx 是我們的前端 Web 伺服器
  • redis-* – Mastodon 使用 redis 所謂其記憶體資料結構儲存
  • postgresql-* – Mastodon 使用 PostgreSQL 作為 SQL 資料庫
  • nodejs – Node 用於 Mastodon 的 流式 API
  • yarn – Yarn 是 Node.js 的包管理器
  • 其他的 -dev 包, g++ – 這些是使用 ruby-build 編譯 Ruby 所需要的.
apt -y install imagemagick ffmpeg libpq-dev libxml2-dev libxslt1-dev file git-core g++ libprotobuf-dev protobuf-compiler pkg-config nodejs gcc autoconf bison build-essential libssl-dev libyaml-dev libreadline6-dev zlib1g-dev libncurses5-dev libffi-dev libgdbm3 libgdbm-dev nginx redis-server redis-tools postgresql postgresql-contrib letsencrypt yarn libidn11-dev libicu-dev複製程式碼

需要非 root 使用者新增的依賴關係

首先建立這個使用者:

adduser mastodon複製程式碼

以 mastodon 使用者身份登入:

sudo su - mastodon複製程式碼

我們需要設定 rbenv 和 ruby-build:

git clone https://github.com/rbenv/rbenv.git ~/.rbenv
cd ~/.rbenv && src/configure && make -C src
echo `export PATH="$HOME/.rbenv/bin:$PATH"` >> ~/.bashrc
echo `eval "$(rbenv init -)"` >> ~/.bashrc
# 重啟 shell
exec bash
# 檢查 rbenv 是否正確安裝
type rbenv
# 安裝 ruby-build 為 rbenv 外掛
git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build複製程式碼

現在 rbenv 和 ruby-build 已經安裝成功, 我們需要安裝
Mastodon 使用的 Ruby 版本。這個版本也需要安裝啟用。

要啟用 Ruby, 請執行:

rbenv install 2.4.2
rbenv global 2.4.2複製程式碼

這將需要一些時間. 在命令執行時, 伸展一下, 喝點水.

node.js 和 Ruby 依賴

現在 Ruby 已啟用, 我們將克隆 Mastodon git 倉庫 並安裝 Ruby 和 node.js 依賴.

執行以下命令克隆並安裝:

# 返回到 mastodon 使用者的家目錄
cd ~
# 克隆 mastodon git 倉庫到 ~/live
git clone https://github.com/tootsuite/mastodon.git live
# 改變當前目錄到 ~live
cd ~/live
# 遷出 mastodon 最後一個穩定 tag 版本
git checkout $(git tag -l | grep -v `rc[0-9]*$` | sort -V | tail -n 1)
# 安裝 bundler
gem install bundler
# 使用 bundler 安裝其餘的 Ruby 依賴項
bundle install --deployment --without development test
# 使用 yarn 安裝 node.js 依賴項
yarn install --pure-lockfile複製程式碼

以上就是 mastodon 使用者現在所需要做的, 你可以 exit 返回到 root 使用者.

建立 PostgreSQL 資料庫

Mastodon 需要訪問 PostgreSQL 例項.

為 PostgreSQL 例項建立一個使用者:

# 用 postgres 使用者啟動 psql
sudo -u postgres psql

# 跟從提示
CREATE USER mastodon CREATEDB;
q複製程式碼

請注意 我們不設定任務形式的密碼, 這是因為我們將使用 ident 身份驗證. 允許本地在沒有密碼的情況下訪問資料庫.

nginx 配置

你需要配置 nginx 來訪問 Mastodon 例項.

提醒: 將出現的 example.com 替換為你自己例項的域名或者子域名

cd 到 /etc/nginx/sites-available 並開啟一個新的檔案:

nano /etc/nginx/sites-available/example.com.conf

複製貼上一下內容並進行必要的修改:

map $http_upgrade $connection_upgrade {
  default upgrade;
  ``      close;
}

server {
  listen 80;
  listen [::]:80;
  server_name example.com;
  # Useful for Let`s Encrypt
  location /.well-known/acme-challenge/ { allow all; }
  location / { return 301 https://$host$request_uri; }
}

server {
  listen 443 ssl http2;
  listen [::]:443 ssl http2;
  server_name example.com;

  ssl_protocols TLSv1.2;
  ssl_ciphers HIGH:!MEDIUM:!LOW:!aNULL:!NULL:!SHA;
  ssl_prefer_server_ciphers on;
  ssl_session_cache shared:SSL:10m;

  ssl_certificate     /etc/letsencrypt/live/example.com/fullchain.pem;
  ssl_certificate_key /etc/letsencrypt/live/example.com/privkey.pem;

  keepalive_timeout    70;
  sendfile             on;
  client_max_body_size 0;

  root /home/mastodon/live/public;

  gzip on;
  gzip_disable "msie6";
  gzip_vary on;
  gzip_proxied any;
  gzip_comp_level 6;
  gzip_buffers 16 8k;
  gzip_http_version 1.1;
  gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript;

  add_header Strict-Transport-Security "max-age=31536000";

  location / {
    try_files $uri @proxy;
  }

  location ~ ^/(emoji|packs|system/accounts/avatars|system/media_attachments/files) {
    add_header Cache-Control "public, max-age=31536000, immutable";
    try_files $uri @proxy;
  }

  location /sw.js {
    add_header Cache-Control "public, max-age=0";
    try_files $uri @proxy;
  }

  location @proxy {
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto https;
    proxy_set_header Proxy "";
    proxy_pass_header Server;

    proxy_pass http://127.0.0.1:3000;
    proxy_buffering off;
    proxy_redirect off;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection $connection_upgrade;

    tcp_nodelay on;
  }

  location /api/v1/streaming {
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto https;
    proxy_set_header Proxy "";

    proxy_pass http://127.0.0.1:4000;
    proxy_buffering off;
    proxy_redirect off;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection $connection_upgrade;

    tcp_nodelay on;
  }

  error_page 500 501 502 503 504 /500.html;
}複製程式碼

啟用新增的 nginx 配置:

cd /etc/nginx/sites-enabled
ln -s ../sites-available/example.com.conf複製程式碼

此配置假設您正在使用 Let`s Encrypt 作為您的 TLS 證照提供程式.

如您要使用 Let`s Encrypt 作為您的 TLS 證照提供者, 請參閱下一個子部分. 否則請編輯 ssl_certificate 和 ssl_certificate_key 為相應的值.

Let`s Encrypt

如果您使用 Let`s Encrypt 作為您的 TLS 證照提供者, 則此部分與您相關.

生成證照

我們需要生成 Let`s Encrypt 證照.

確保 `example.com` 替換為 Mastodon 例項的域名.

確保此時 nginx 已停止:

systemctl stop nginx複製程式碼

我們將建立證照, 一次在獨立模式下使用 TLS SNI 驗證, 第二次使用 webroot 方法. 由於
nginx 和 Let`s Encrypt 的工作原理, 這是必須的.

letsencrypt certonly --standalone -d example.com複製程式碼

成功完成後, 我們將使用 webroot 方法. nginx 需要處於執行狀態:

systemctl start nginx
# letsencrypt 工具將詢問您是否要發出新的證照, 請選擇該選項
letsencrypt certonly --webroot -d example.com -w /home/mastodon/live/public/複製程式碼

自動更新 Let`s Encrypt 證照

Let`s Encrypt 證照的有效期為 90 天.

您需要在到期日期之前更新證照. 不這樣做會使您例項的使用者無法訪問其他與您聯合的例項.

我們可以建立一個每天執行的 cron 作業:

nano /etc/cron.daily/letsencrypt-renew複製程式碼

將此指令碼複製並貼上到該檔案中:

#!/usr/bin/env bash
letsencrypt renew
systemctl reload nginx複製程式碼

儲存檔案並推出.

該指令碼新增執行許可權並重新啟動 cron 守護程式, 以便指令碼每天執行:

chmod +x /etc/cron.daily/letsencrypt-renew
systemctl restart cron複製程式碼

就是這樣. 您的伺服器將續訂您的 Let`s Encrypt 證照.

Mastodon 應用配置

我們將配置 Mastodon 應用程式.

為此我們切換到 mastodon 系統使用者:

sudo su - mastodon複製程式碼

將當前目錄更改為 ~live 並編輯 Mastodon 應用配置:

cd ~/live
cp .env.production.sample .env.production
nano .env.production複製程式碼

為了本指南的目錄, 這些是要編輯的值:

# Your Redis host
REDIS_HOST=127.0.0.1
# Your Redis port
REDIS_PORT=6379
# Your PostgreSQL host
DB_HOST=/var/run/postgresql
# Your PostgreSQL user
DB_USER=mastodon
# Your PostgreSQL DB name
DB_NAME=mastodon_production
# Leave DB password empty
DB_PASS=
# Your DB_PORT
DB_PORT=5432

# Your instance`s domain
LOCAL_DOMAIN=example.com
# We have HTTPS enabled
LOCAL_HTTPS=true

# Application secrets
# Generate each with `RAILS_ENV=production bundle exec rake secret`
PAPERCLIP_SECRET=
SECRET_KEY_BASE=
OTP_SECRET=

# Web Push VAPID keys
# Generate with `RAILS_ENV=production bundle exec rake mastodon:webpush:generate_vapid_key`
VAPID_PRIVATE_KEY=
VAPID_PUBLIC_KEY=

# All SMTP details, Mailgun and Sparkpost have free tiers
SMTP_SERVER=
SMTP_PORT=
SMTP_LOGIN=
SMTP_PASSWORD=
SMTP_FROM_ADDRESS=複製程式碼

我們現在需要首次設定 PostgreSQL 資料庫:

RAILS_ENV=production bundle exec rails db:setup複製程式碼

我們需要預編譯所有的 CSS 和 JavaScript 檔案:

RAILS_ENV=production bundle exec rails assets:precompile複製程式碼

資源預編譯需要幾分鐘, 所以這是休息一下的好時機.

Mastodon 系統服務檔案

我們需要為每個 Mastodon 服務提供三個 systemd 服務檔案.

現在切換回 root 使用者.

對於 Mastodon web 服務, 將以下內容放在 /etc/systemd/system/mastodon-web.service:

[Unit]
Description=mastodon-web
After=network.target

[Service]
Type=simple
User=mastodon
WorkingDirectory=/home/mastodon/live
Environment="RAILS_ENV=production"
Environment="PORT=3000"
ExecStart=/home/mastodon/.rbenv/shims/bundle exec puma -C config/puma.rb
ExecReload=/bin/kill -SIGUSR1 $MAINPID
TimeoutSec=15
Restart=always

[Install]
WantedBy=multi-user.target複製程式碼

對於 Mastodon 後臺佇列服務, 將以下內容放在 /etc/systemd/system/mastodon-sidekiq.service:

[Unit]
Description=mastodon-sidekiq
After=network.target

[Service]
Type=simple
User=mastodon
WorkingDirectory=/home/mastodon/live
Environment="RAILS_ENV=production"
Environment="DB_POOL=5"
ExecStart=/home/mastodon/.rbenv/shims/bundle exec sidekiq -c 5 -q default -q mailers -q pull -q push
TimeoutSec=15
Restart=always

[Install]
WantedBy=multi-user.target複製程式碼

對於 Mastodon 流 API 服務, 將以下內容放在 /etc/systemd/system/mastodon-streaming.service:

[Unit]
Description=mastodon-streaming
After=network.target

[Service]
Type=simple
User=mastodon
WorkingDirectory=/home/mastodon/live
Environment="NODE_ENV=production"
Environment="PORT=4000"
ExecStart=/usr/bin/npm run start
TimeoutSec=15
Restart=always

[Install]
WantedBy=multi-user.target複製程式碼

現在您需要啟用這些服務:

systemctl enable /etc/systemd/system/mastodon-*.service複製程式碼

現在啟動服務:

systemctl start mastodon-*.service複製程式碼

檢查它們是否正常執行:

systemctl status mastodon-*.service複製程式碼

就這些! 如果一切都正常完成, 當您在網路瀏覽器中訪問 https://example.com 時, 會出現一個 Mastodon 例項.

祝賀你並歡迎來賓!

相關文章