Detaillierte Anleitung zur Installation von Misskey auf Ubuntu

Weitere Methoden zur Installation von Misskey

• Grundlegender Leitfaden zum Einrichten von Misskey (manuell)
• Liste weiterer Installationsmethoden

Ankündigung für Shell-Skripte

Wenn es nur ums Copy-Paste geht, dann kann man das doch genauso gut mit einem Shell-Skript erledigen. Also habe ich ein Shell-Skript entwickelt, das fast alles für dich macht!
Details und Anweisungen zur Verwendung des Shell-Skripts findest du hier!

Bitte melde eventuelle Probleme, indem du Erwähnung an @[email protected] sendest.

Über diesen Artikel

In diesem Artikel erkläre ich, dass ich Misskey gemäß dem Misskey-Einrichtungsleitfaden (Handbuch) mit systemd betreibe. Außerdem möchte ich darauf hinweisen, dass es mit docker-compose manuell etwas einfacher sein sollte, Misskey auszuführen.

Mit docker-compose sollte es manuell etwas einfacher sein, Misskey auszuführen.

Einführung

Dieser Artikel erklärt Schritt für Schritt, wie Misskey auf einem allgemeinen Ubuntu-Server installiert und öffentlich zugänglich gemacht wird, basierend auf dem Misskey-Einrichtungsleitfaden (Handbuch).

Die Einrichtung ist so konzipiert, dass sie nur Eingaben von Bash-Befehlen, das Bearbeiten einiger Konfigurationsdateien und die Bedienung des Browsers erfordert, um abgeschlossen zu werden. Es wird eine kurze Erklärung zur zu installierenden Software gegeben, aber dies ist nicht weiter von Bedeutung.

In diesem Artikel wird besonderer Wert auf Konkretheit gelegt und spezifische Umgebungen detailliert beschrieben.

Es könnten Unterschiede im Betriebssystem, in Misskey selbst oder in den Versionen der abhängigen Software auftreten, weshalb einige Teile sich verändert haben könnten. Wir bitten um Verständnis.

Bei unklaren Begriffen wird empfohlen, im IT-Wörterbuch nachzuschlagen, um sich ein besseres Verständnis zu verschaffen.

Umgebung und Bedingungen

• Als Betriebssystem wird Ubuntu 22.04 LTS verwendet.
• Bezüglich der Hardwareanforderungen reicht eine aktuelle CPU für den minimalen Betrieb aus. Die Architektur ist auf amd64 und arm64 ausgelegt.
• Ein Arbeitsspeicher von etwa 4 GB ist empfehlenswert.
  • Zuvor wurde erklärt, dass durch die Einführung von Vite der Build mit etwa 1,5 GB möglich war. (aber in letzter Zeit sind die Anforderungen für den Frontend-Build wieder gestiegen.)
• Eine eigene Domain wird erworben und Cloudflare wird verwendet.
• Die Domain sollte im Voraus bei Cloudflare Registrar oder einem ähnlichen Dienst registriert werden.
• Hier wird die Domain example.tld verwendet, daher sollte diese entsprechend durch die gekaufte Domain ersetzt werden. Im Falle einer Entwicklungsumgebung ist localhost zu verwenden (weitere Erläuterungen im Abschnitt zu den Konfigurationsdateien).

Verwendung von Nano

Dieses Mal werden wir den Texteditor nano verwenden. Starten wie folgt:

nano /path/to/file

Sie können die Pfeiltasten sowie die Home/End-Tasten verwenden, um den Cursor zu bewegen.

Beenden Sie das Programm mit Ctrl+X. Wenn Sie gefragt werden, ob Sie Änderungen speichern möchten, geben Sie Y (Yes) ein und drücken Sie Enter, um die Änderungen zu speichern.

Eine Liste der Befehle wird unten angezeigt. Ersetzen Sie ^ durch Ctrl und M- durch Alt, um sie zu verwenden.

Erstellung eines Benutzers

Da Misskey nicht als root ausgeführt werden sollte, wird ein dedizierter Benutzer erstellt.

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

Installation und Konfiguration grundlegender Software

Grundlegende Software installieren.

Node.js

Node.js ist eine serverseitige JavaScript-Laufzeitumgebung und die grundlegende Ausführungsumgebung für Misskey.

sudo rm /usr/share/keyrings/nodesource.gpg;
curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | sudo gpg --dearmor -o /usr/share/keyrings/nodesource.gpg;
NODE_MAJOR=20; echo "deb [signed-by=/usr/share/keyrings/nodesource.gpg] https://deb.nodesource.com/node_$NODE_MAJOR.x nodistro main" | sudo tee /etc/apt/sources.list.d/nodesource.list;
sudo apt update;
sudo apt install -y nodejs;

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

# corepack enable
sudo corepack enable

Wenn v20.x.x oder ähnlich angezeigt wird, ist alles in Ordnung. Wenn eine niedrigere Version wie v8.x.x angezeigt wird, ist die Installation nicht korrekt durchgeführt worden. Starten den Server neu und versuche, die Installation erneut durchzuführen.

PostgreSQL

PostgreSQL ist ein objektrelationales Datenbankmanagementsystem und eine unverzichtbare Software zur Speicherung der verschiedenen Daten von Misskey.

Installieren

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

sudo apt install -y postgresql-common

sudo sh /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh -i -v 15;

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

activeならOK。

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

psqlを起動。

sudo -u postgres psql

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

CREATE ROLE misskey LOGIN PASSWORD 'hoge';

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

CREATE DATABASE mk1 OWNER misskey;
\q

Redis

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

https://redis.io/docs/getting-started/installation/install-redis-on-linux/

sudo snap install redis

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

systemctl status redis-server

activeならOK。

nginx

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

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

sudo apt install -y curl ca-certificates gnupg2 lsb-release ubuntu-keyring

curl https://nginx.org/keys/nginx_signing.key | gpg --dearmor | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null

gpg --dry-run --quiet --no-keyring --import --import-options import-show /usr/share/keyrings/nginx-archive-keyring.gpg

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

echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] http://nginx.org/packages/ubuntu `lsb_release -cs` nginx" | sudo tee /etc/apt/sources.list.d/nginx.list

echo -e "Package: *\nPin: origin nginx.org\nPin: release o=nginx\nPin-Priority: 900\n" | sudo tee /etc/apt/preferences.d/99nginx

sudo apt update

sudo apt install -y nginx

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

systemctl status nginx

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

sudo systemctl start nginx

sudo systemctl enable nginx

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

curl http://localhost

その他

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

sudo apt update

sudo apt install -y git build-essential

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

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

ファイヤーウォール

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

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

sudo ufw enable

sudo ufw default deny

sudo ufw limit 22

sudo ufw allow 80

sudo ufw allow 443

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

sudo ufw status

systemctlで永続化する。

sudo systemctl enable ufw

Cloudflare

Cloudflareは、自分のドメインに対してDNSサーバー・リバースプロキシ・CDNをいっぺんに提供してくれるたいへん便利なサービスである。
Cloudflareを経由せずにサーバーを公開することも可能だが、たいへん便利なので導入することをお勧めする。 → CDNの設定

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

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

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

Certbot (Let’s Encrypt) の設定

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

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

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

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

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

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

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

dns_cloudflare_email（下の例では[email protected]）にはCloudflareで登録しているメールアドレスを設定する。

dns_cloudflare_email = [email protected]
dns_cloudflare_api_key = xxxxxxxxxxxxxxxxxxxxxxxxxx

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

sudo chmod 600 /etc/cloudflare/cloudflare.ini

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

sudo 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を準備していく。

misskeyユーザーに変更。

sudo su - misskey

Gitでファイル類を展開。

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

cd misskey

git checkout master

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

NODE_ENV=production pnpm install --frozen-lockfile

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: 'aidx'

# 　 syslog
syslog:
  host: localhost
  port: 514

指定できたら保存する。

nginxの設定

nginxの設定を行う。

ルート権限で行う。

exit

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

sudo 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行を削除

変更を保存する。

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

sudo nginx -t

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

sudo systemctl restart nginx

ステータスを確認。

sudo systemctl status nginx

activeであればOK。

Misskeyのビルド

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

sudo su - misskey

ビルドをする。yes we can…

cd misskey
NODE_ENV=production pnpm run build

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

RAMの不足が考えられる。

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

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

データベースの初期化

pnpm run init

Misskeyを起動する

NODE_ENV=production pnpm run 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を作成する。

sudo 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=journal
StandardError=journal
SyslogIdentifier=misskey
Restart=always

[Install]
WantedBy=multi-user.target

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

sudo systemctl daemon-reload

sudo systemctl enable misskey

sudo systemctl start misskey

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

sudo systemctl status misskey

activeならOK。

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

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

Misskeyの設定を続ける

• Misskeyサーバーで最初に設定するべきサーバー設定とその他設定の説明
• Squidプロキシを設定してMisskeyを守る
• Misskeyのデータベースをバックアップしよう【OCIオブジェクトストレージ編】

Misskeyのアップデート

Misskeyのアップデート方法

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

sudo systemctl stop misskey

su - misskey

git pull;
NODE_ENV=production pnpm install --frozen-lockfile
pnpm run clean;
NODE_ENV=production pnpm run build;
pnpm 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