シェルスクリプトのお知らせ

コピペばかりでつまらない！時間がかかる！とにかく面倒！

……あれ、コピペだけでできるなら、つまり完全自動化できるのでは？

というわけで、シェルスクリプトでほぼ全部やってくれるやつを作ってみました！
詳細と使用方法はこちらから！ https://github.com/joinmisskey/bash-install#readme

ドメインの購入とCloudflareのセットアップ、サーバーの確保についてはご自身でご準備ください。

不具合があれば私へのリプライ等やこちらのコメント欄にてお知らせいただければと思います。

この記事について

この『Ubuntu版Misskeyインストール方法詳説』は、最初に文語体で書かれたものを移転のたびに転載しながら使っています。
若干読みにくいかもしれませんが、書き直す余裕がないためこのまま行かせてください。

この記事では、Misskey構築の手引き (setup.md)で紹介されている通り、systemdでMisskeyを動作させています。

docker-composeなら、手作業でももうちょっと簡単に実行できるはずです。

MisskeyだけをDockerで動作させる方法は解説を断念しました。
シェルスクリプトはMisskeyだけをDockerで動作させることができるようになります。
（新バージョンのシェルスクリプトの正式リリースはまだです、安定動作を確認するまでもうしばらく待ってください。）

また、記事移転の際にコードブロック内に余分な\が含まれてしまいました。取り切れていない可能性がありますので、ご注意いただければと思います。

Ubuntu版Misskeyインストール方法詳説

はじめに

この記事では、リポジトリに同梱されている 『Misskey構築の手引き』 (setup.md) を基に、一般的なUbuntuサーバーへMisskeyをインストールし公開する方法の一挙手一投足を解説する。

Bashのコマンド入力、いくつかの設定ファイルの編集、そしてブラウザの操作だけで設定が完了するようにしている。インストールするソフトウェアについて簡単に説明しているが、気にする必要はない。

大まかな流れは上の目次をクリックし展開することで確認できる。

この記事では、具体性を重視し、特定の環境に特化した記述をしている。

OSの違い、Misskey本体や依存するソフトウェアのバージョンアップで変わってしまった部分等があるかもしれないが、ご容赦いただきたく思う。

わからない単語については、『「分かりそう」で「分からない」でも「分かった」気になれるIT用語辞典』で調べて分かった気になってほしい。

環境と条件

OSはUbuntu 20.04.1 LTSを利用する。
ハードウェア要件としては、CPUは最近のものなら最小限で動く。アーキテクチャはamd64として解説を進める。
メモリは2GB程度あればよい。
独自のドメインを購入し、CloudFlareを使用する。
ドメインはGoogle Domainsなどで予め用意しておくこと。
ここではドメインをexample.tldとして解説を進めるので、自分が買ったドメインに適宜置き換えて読むこと。

nanoの使い方

今回はテキストエディターにnanoを使う。次のように起動する。

nano /path/to/file

一般的な矢印ボタンやHome/Endなどを利用してカーソルを移動できる。

終了はCtrl+Xで、変更を保存するか聞かれた場合Y(Yes)を入力しEnterすると保存できる。

下部にコマンド一覧が表示されるので、^をCtrl、M-をAltと読み替えて参考にしよう。

ユーザーの作成

Misskeyはrootで実行しない方がよいため、専用のユーザーを作成する。

adduser --disabled-password --disabled-login misskey

基本的なソフトウェアのインストールと設定

基本的なソフトウェアのインストールを行う。

Node.js

Node.jsは、サーバーサイドJavaScript環境であり、Misskeyの基本的な実行環境である。

apt install -y curl

curl -sL https://deb.nodesource.com/setup_16.x | sudo -E bash -

apt install -y nodejs

Node.jsがインストールされたので、バージョンを確認する。

node -v

v16.x.xなどと表示されればOK。v8.x.xのように低いバージョンが表示された場合は、正しくインストールが行えていないため、サーバーを再起動してもう一度インストールし直すなどしてみよう。

PostgreSQL

PostgreSQLは、オブジェクト関係データベース管理システムであり、Misskeyの種々のデータを保存するために必要不可欠なソフトだ。

インストール

シェルスクリプトを実行し、最新バージョン（v13）をインストールしよう。

wget https://salsa.debian.org/postgresql/postgresql-common/raw/master/pgdg/apt.postgresql.org.sh

sh apt.postgresql.org.sh -i -v 13

systemctlでデーモンの状態を確認。

systemctl status postgresql

activeならOK。

ユーザーとデータベースの作成

psqlを起動。

sudo -u postgres psql

Misskeyで使うユーザーを作成する。
ユーザー名をmisskey、パスワードをhogeとする場合は次のようになる。
（LinuxのユーザーとPostgreSQLのユーザーは別物なので、混同しないよう注意すること。）

CREATE ROLE misskey LOGIN CREATEDB PASSWORD 'hoge';

データベースを作成。データベース名をmk1としている。

CREATE DATABASE mk1 OWNER misskey;

exit

Redis

Redisは、NoSQLのインメモリデータベースソフトであり、データベースや連合との通信を管理するなどのために必要だ。

add-apt-repository ppa:chris-lea/redis-server

#(Enterを押す)

apt update

apt install -y redis-server

systemctl start redis-server

systemctl enable redis-server

systemctlでデーモンの状態を確認。

systemctl status redis-server

activeならOK。

nginx

nginxは、主としてリバースプロキシに用いられるWebサーバーソフトである。Misskeyには必須ではないが、キャッシュ等をするとパフォーマンスが向上したり、httpからhttpsへの転送などをするために、インストールしておこう。

nginx.orgのドキュメント http://nginx.org/en/linux_packages.html#Ubuntu に従ってインストールする。

apt install -y curl gnupg2 ca-certificates lsb-release

echo "deb http://nginx.org/packages/ubuntu `lsb_release -cs` nginx" | tee /etc/apt/sources.list.d/nginx.list

curl -o /tmp/nginx_signing.key https://nginx.org/keys/nginx_signing.key

gpg --dry-run --quiet --import --import-options show-only /tmp/nginx_signing.key

このとき出力に 573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62 とあるか確認する。

sudo mv /tmp/nginx_signing.key /etc/apt/trusted.gpg.d/nginx_signing.asc

apt update

apt install -y nginx

systemctlでデーモンの状態を確認。

systemctl status nginx

activeならOK。そうでなければ、次のコマンドを実行。

systemctl start nginx

systemctl enable nginx

http://localhost にアクセスし、*Welcome to nginx!*と表示されればOK。
curlで確認するのもよいだろう。

curl http://localhost

その他

Git（バージョン管理ソフト）およびbuild-essential（Misskeyのビルド時に必要）をインストールする。

apt update

apt install -y git build-essential

追加の設定とインストール

サーバーをインターネットに公開する準備をする。

ファイヤーウォール

今回は、ファイヤーウォールとしてufwを使用する。

次では、接続許可をホワイトリスト形式とし、22番SSHポートを接続回数制限を設けながら開放、80番HTTPポート及び443番HTTPSポートを開放とした。

ufw enable

ufw default deny

ufw limit 22

ufw allow 80

ufw allow 443

ufwのステータスを確認しておく。

ufw status

systemctlで永続化する。

systemctl enable ufw

メモ

ufwは、netfilter(iptables)を人間が操作しやすいようにするアプリです。インストールスクリプトではnetfilterを直接操作しています。

CloudFlare

CloudFlareは、自分のドメインに対してDNSサーバー・リバースプロキシ・CDNをいっぺんに提供してくれるたいへん便利なサービスである。

CloudFlareを経由せずにサーバーを公開することも可能だが、たいへん便利なので導入することをお勧めする。

CloudFlareにサインアップし、購入したドメインを案内に従って登録する。

DNSの登録画面でサーバーのIPアドレスを入力しておくとよい。

ドメインを購入した所によっては適用に3日程度かかる場合がある。

Certbot (Let’s Encrypt) の設定

HTTPS･WSS通信に使用する証明書をCloudFlareを使う方式でLet’s Encryptから取得する。

certbotとCloudFlareプラグインをインストール

apt install -y certbot python3-certbot-dns-cloudflare

CloudflareのAPIキーを取得する。以下の手順で取得されたい。

https://dash.cloudflare.com/profile/api-tokens にアクセス
Global API KeyのViewを選択
パスワードを入力しhCaptchaを解除、Viewを選択

CloudFlareの情報を記載した設定ファイル/etc/cloudflare/cloudflare.iniを作成する。

mkdir /etc/cloudflare
nano /etc/cloudflare/cloudflare.ini

dns_cloudflare_email（下の例ではbar@fuga.foo）にはCloudFlareで登録しているメールアドレスを設定する。

dns_cloudflare_email = bar@fuga.foo
dns_cloudflare_api_key = xxxxxxxxxxxxxxxxxxxxxxxxxx

これを保存し、パーミッションを600に設定。

chmod 600 /etc/cloudflare/cloudflare.ini

準備ができたのでコマンドを実行する。途中の2箇所のexample.tldは自分のものに置き換えること。

certbot certonly --dns-cloudflare --dns-cloudflare-credentials /etc/cloudflare/cloudflare.ini --dns-cloudflare-propagation-seconds 60 --server https://acme-v02.api.letsencrypt.org/directory -d example.tld -d *.example.tld

*Congratulations!*と表示されたらOK。生成された.pemファイルのパスは今後使うので記録しておくこと。

自動更新の設定はインストールと同時に行われているため不要。

Misskeyのインストール

これで前準備はあらかた終わったので、Misskeyを準備していく。

setup.mdの3. を順に実行する。なお、一部アレンジを加えている。

misskeyユーザーに変更。

su - misskey

Gitでファイル類を展開。

git clone -b master https://github.com/misskey-dev/misskey.git

cd misskey

git checkout master

必要なnpmパッケージをインストール。

npx yarn install

Misskeyを設定する

default.yml

設定ファイル.config/default.ymlを作成。

nano .config/default.yml

次の内容を貼り付け、適宜置き換える。設定値の変更が必要な箇所は●で、これまでの流れの中で設定した値を用いる箇所は〇で示した。

この設定ファイルはYAML形式で書かれており、行頭のスペースの数などを間違えるとMisskeyが動かないので、特に注意すること。

設定できる値と記述方法は.config/example.ymlに書かれている。

# ● Misskeyを公開するURL
url: https://example.tld/

# 　 ポートを3000とする。
port: 3000

# ● PostgreSQLの設定。
db:
  host: localhost
  port: 5432
  db  : mk1 # 〇 PostgreSQLのデータベース名
  user: misskey # 〇 PostgreSQLのユーザー名
  pass: hoge # ● PostgreSQLのパスワード

# 　 Redisの設定。
redis:
  host: localhost
  port: 6379

# 　 IDタイプの設定。
id: 'aid'

# 　 syslog
syslog:
  host: localhost
  port: 514

指定できたら保存する。

nginxの設定

nginxの設定を行う。

ルート権限で行う。

exit

/etc/nginx/conf.d/misskey.confを作成する。

nano /etc/nginx/conf.d/misskey.conf

Misskey Hubの設定例をnanoへコピー＆ペーストし、次の部分を自分のものに書き換える。

18行目と30行目のドメイン名
34-35行目の証明書へのパスをCertbotで取得したものに (基本的にexample.tldを置き換えるだけでOK)
56行目 (If it's behind another reverse proxy or CDN, remove the following.) から4行を削除

変更を保存する。

設定ファイルがきちんと機能するか確認。

nginx -t

OKならば、nginxデーモンを再起動。

systemctl restart nginx

ステータスを確認。

systemctl status nginx

activeであればOK。

Misskeyのビルド

misskeyユーザーにログインし直す。

su - misskey

ビルドをする。yes we can…

cd misskey
NODE_ENV=production npm run build

サーバーでビルドできない場合

RAMの不足が考えられる。

Misskeyのビルドやデータベースのマイグレーション（初期化を含む）には、RAMが2GB以上必要になっている。
RAMが足りない場合、以下のような解決策が考えられる。

サーバーにスワップを追加する
ローカルでビルドしたもの（builtディレクトリ）をsftpで転送する

データベースの初期化

npm run init

Misskeyを起動する

NODE_ENV=production npx yarn start

Now listening on port 3000 on http://example.tld と表示されたら、設定したURLにアクセスする。

Misskeyのウェルカムページが表示されるはずだ。

アカウントの作成、ノートの作成やファイルのアップロードといった一通りの操作が正しく行えるか確認しよう。

アクセスできない場合

CloudFlareのDNSを確認する

CloudFlareのDNS設定が正しいIPアドレスになっているかもう一度確認しよう。

ルーターの設定を確認する

自宅サーバーの場合、ルーターがサーバーと外部との80ポート・443ポートの通信を許可する設定になっているかどうか確認しよう。

クラウドの場合でも、ネットワーク設定でポート開放が必要な場合が多い。

Misskeyのデーモンを作成

いったんCtrl+Cでプロセスをキルし、Misskeyをデーモンで起動する設定をしよう。

ルート権限で行う。

exit

/etc/systemd/system/misskey.serviceを作成する。

nano /etc/systemd/system/misskey.service

次の内容を貼り付け、保存する。

[Unit]
Description=Misskey daemon

[Service]
Type=simple
User=misskey
ExecStart=/usr/bin/npm start
WorkingDirectory=/home/misskey/misskey
Environment="NODE_ENV=production"
TimeoutSec=60
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=misskey
Restart=always

[Install]
WantedBy=multi-user.target

systemdを設定し、misskeyデーモンを開始。

systemctl daemon-reload

systemctl enable misskey

systemctl start misskey

systemctlでデーモンの状態を確認。起動に少し時間がかかるため、15秒程度待ってからのほうが良い。

systemctl status misskey

activeならOK。

これでMisskeyのインストールはほぼ完了だ。

Misskeyサーバーに自分のアカウントを登録・ログインし、設定を続けよう。

Misskeyの設定を続ける

Misskeyのアップデートについて

アップデートについてもシェルスクリプトがあります。
https://github.com/joinmisskey/bash-install/blob/main/update.systemd.sh

手作業でやる場合は次の通りです。
参考: setup.md#Misskeyを最新バージョンにアップデートする方法

作業中はMisskeyを使うことができません。

sudo systemctl stop misskey

su - misskey

git pull;
npx yarn install;
npm run clean;
NODE_ENV=production npm run build;
npm run migrate;

exit

Case 1: apt upgradeをする場合

sudo apt update -y
sudo apt full-upgrade -y
sudo reboot

再起動後はMisskeyは自動で起動します。

Case 2: そのまま起動

sudo systemctl start misskey