Misskeyの自鯖を建てるための解説

Twitter is dead

Twitter は死んだ、開発者用 API にとんでもない制限がついてもはや無料でできることは何もなくなってしまった。

結局、SNS を盛り上げるためにはサードパティのアプリだったり外部連携だったりが充実していなければいけないので、それがなくなったということはすなわち Twitter は SNS としてお亡くなりになってしまったということを意味する。

正直、他人の投稿を見るだけなら Twitter である必要はないし、課金しても広告が半分しか消えないというイミフな現状には正直辟易している。

じゃあいっそのこと別のプラットフォームに移ろうかということになった。

別のプラットフォーム

じゃあ別のプラットフォームとして何を選ぶのかとなったときに、真っ先に浮かんだのは Mastodon でした。

が、なんかこれは特に理由もなく好きじゃなかった。なんでかはわからないけれど。

他には Twitter の後継とも言える Bluesky などもあったのですが、これはベータユーザーしか使えませんでした。

若干 SNS とは違うのですが Discord の OSS 版っぽい Mattermost も候補に上がったのですが、今回選ばれたのは Misskey でした。何故なら Docker で簡単に導入できると書いてあったから。

が、いろいろな理由で導入にはちょっと時間がかかりました。

なので解決方法などについて備忘録的にメモしておこうと思います。

導入方法

見ればわかるのですがスペックはガチ目に必要最低限です。

Ubuntu 22.04LTS
1 CPU
1GB RAM
512MB Swap
Tokyo Region
25GB SSD

でもこれで月々$5 なので、1000 円以下でサーバーが運営できるかと思えば安いものです。別にこれ以外にも利用方法はありますし。

注意点としてはメモリが 1GB しかないのでイメージをビルドしようとするとパッケージインストールでコケます

必要なもの

Docker
docker-compose

それぞれバージョンを調べてみたら以下のような感じでした。

今リリースされている最新のものを使えば間違いはないと思います。

1
$ docker -v
2
Docker version 23.0.3, build 3e7cbfd
3
$ docker-compose -v
4
docker-compose version 1.29.2, build 5becea4c

Docker 導入

ここのサイトが超わかりやすいので、上から順番にコピペして下さい。

1
sudo apt update
2
sudo apt install apt-transport-https ca-certificates curl software-properties-common
3
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
4
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
5
sudo apt update
6
apt-cache policy docker-ce
7
sudo apt install docker-ce

docker-compose 導入

ここのサイトが超わかりやすいので、上から順番にコピペしてください。

1
mkdir -p ~/.docker/cli-plugins/
2
curl -SL https://github.com/docker/compose/releases/download/v2.3.3/docker-compose-linux-x86_64 -o ~/.docker/cli-plugins/docker-compose
3
chmod +x ~/.docker/cli-plugins/docker-compose

一般ユーザーで Docker を利用可能にする

現状だとsudoをつけないとdockerが使えないので、パリピでも使えるようにします。

以下のコマンドを入力して一度ログインし直せばおｋ。

1
sudo usermod -aG docker $USER

再ログイン後docker infoとでもやればわかります。

1
$ docker info
2
Client:
3
Context: default
4
Debug Mode: false
5
Plugins:
6
buildx: Docker Buildx (Docker Inc.)
7
Version: v0.10.4
8
Path: /usr/libexec/docker/cli-plugins/docker-buildx
9
compose: Docker Compose (Docker Inc.)
10
Version: v2.17.2
11
Path: /usr/libexec/docker/cli-plugins/docker-compose
12

13
Server:
14
Containers: 5
15
Running: 5
16
Paused: 0
17
Stopped: 0
18
Images: 5
19
Server Version: 23.0.3
20
Storage Driver: overlay2
21
Backing Filesystem: extfs
22
Supports d_type: true
23
Using metacopy: false
24
Native Overlay Diff: true
25
userxattr: false
26
Logging Driver: json-file
27
Cgroup Driver: systemd
28
Cgroup Version: 2
29
Plugins:
30
Volume: local
31
Network: bridge host ipvlan macvlan null overlay
32
Log: awslogs fluentd gcplogs gelf journald json-file local logentries splunk syslog
33
Swarm: inactive
34
Runtimes: io.containerd.runc.v2 runc
35
Default Runtime: runc
36
Init Binary: docker-init
37
containerd version: 2806fc1057397dbaeefbea0e4e17bddfbd388f38
38
runc version: v1.1.5-0-gf19387a
39
init version: de40ad0
40
Security Options:
41
apparmor
42
seccomp
43
Profile: builtin
44
cgroupns
45
Kernel Version: 5.15.0-60-generic
46
Operating System: Ubuntu 22.04.2 LTS
47
OSType: linux
48
Architecture: x86_64
49
CPUs: 1
50
Total Memory: 969.4MiB
51
Name: localhost
52
ID: 892f4fe0-6a00-40b5-ba29-d491cd1ddec3
53
Docker Root Dir: /var/lib/docker
54
Debug Mode: false
55
Registry: https://index.docker.io/v1/
56
Experimental: false
57
Insecure Registries:
58
127.0.0.0/8
59
Live Restore Enabled: false

サーバーを立てよう

公式サイトにある導入手順のようにビルドしようとするとコケるので、ビルド済みのイメージを利用します。

デフォルトだとポート 3000 でアクセスしなきゃだったりとめんどくさいので、nginx-proxyとletsencrypt-nginx-proxy-companionを導入して自動で HTTPS かつ TSL がかかるようにしておきます。

ドメイン登録は自分は Cloudflare を使いましたが、各自何でも好きなのを選べば良いと思います。

ソースコードの取得

まずはソースコードをとってきます。

1
git clone -b master https://github.com/misskey-dev/misskey.git
2
cd misskey
3
git checkout master

とってきたら設定ファイルをコピーします。

1
cp .config/docker_example.yml .config/default.yml
2
cp .config/docker_example.env .config/docker.env
3
cp ./docker-compose.yml.example ./docker-compose.yml

この三つのファイルを編集します。必要になるのは「ユーザー名」「パスワード」「ドメイン名」の三つです。

docker-compose.yml

1
version: "3"
2

3
services:
4
  web:
5
    image: misskey/misskey:latest
6
    restart: always
7
    links:
8
      - db
9
      - redis
10
    depends_on:
11
      db:
12
        condition: service_healthy
13
      redis:
14
        condition: service_healthy
15
    ports:
16
      - "3000:3000"
17
    networks:
18
      - internal_network
19
      - external_network
20
    volumes:
21
      - ./files:/misskey/files
22
      - ./.config:/misskey/.config:ro
23
    environment:
24
      VIRTUAL_HOST: { ドメイン名 }
25
      VIRTUAL_POST: 3000
26
      LETSENCRYPT_HOST: { ドメイン名 }
27
      LETSENCRYPT_EMAIL: { メールアドレス }
28

29
  redis:
30
    restart: always
31
    image: redis:7-alpine
32
    networks:
33
      - internal_network
34
    volumes:
35
      - ./redis:/data
36
    healthcheck:
37
      test: "redis-cli ping"
38
      interval: 5s
39
      retries: 20
40

41
  db:
42
    restart: always
43
    image: postgres:15-alpine
44
    networks:
45
      - internal_network
46
    env_file:
47
      - .config/docker.env
48
    volumes:
49
      - ./db:/var/lib/postgresql/data
50
    healthcheck:
51
      test: "pg_isready -U $$POSTGRES_USER -d $$POSTGRES_DB"
52
      interval: 5s
53
      retries: 20
54

55
  nginx-proxy:
56
    image: jwilder/nginx-proxy
57
    container_name: nginx-proxy
58
    ports:
59
      - 80:80
60
      - 443:443
61
    volumes:
62
      - /var/run/docker.sock:/tmp/docker.sock:ro
63
      - ./certs:/etc/nginx/certs:ro
64
      - /etc/nginx/vhost.d
65
      - /usr/share/nginx/html
66
    restart: always
67
    networks:
68
      - external_network
69

70
  letsencrypt:
71
    image: jrcs/letsencrypt-nginx-proxy-companion
72
    container_name: letsencrypt
73
    volumes:
74
      - /var/run/docker.sock:/var/run/docker.sock:ro
75
      - ./certs:/etc/nginx/certs:rw
76
    volumes_from:
77
      - nginx-proxy
78
    restart: always
79

80
networks:
81
  internal_network:
82
    internal: true
83
  external_network:
84
    external: true

ここ、無駄にexternal_networkを設定しているのですが要らない可能性もあります。ひょっとしたらdocker-compose upしたときになんか怒られるかも知れないので、そのときは表示された推奨コマンド（内容を忘れた）を打ち込んでください。

.config/default.yml

ここで設定するユーザー名とパスワードはデータベースを弄る以外では利用しないので、めちゃくちゃ堅いやつにしておくと良いです。

1
#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
2
# Misskey configuration
3
#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4

5
#   ┌─────┐
6
#───┘ URL └─────────────────────────────────────────────────────
7

8
# Final accessible URL seen by a user.
9
url: https://{ ドメイン名 }
10

11
# ONCE YOU HAVE STARTED THE INSTANCE, DO NOT CHANGE THE
12
# URL SETTINGS AFTER THAT!
13

14
#   ┌───────────────────────┐
15
#───┘ Port and TLS settings └───────────────────────────────────
16

17
#
18
# Misskey requires a reverse proxy to support HTTPS connections.
19
#
20
#                 +----- https://example.tld/ ------------+
21
#   +------+      |+-------------+      +----------------+|
22
#   | User | ---> || Proxy (443) | ---> | Misskey (3000) ||
23
#   +------+      |+-------------+      +----------------+|
24
#                 +---------------------------------------+
25
#
26
#   You need to set up a reverse proxy. (e.g. nginx)
27
#   An encrypted connection with HTTPS is highly recommended
28
#   because tokens may be transferred in GET requests.
29

30
# The port that your Misskey server should listen on.
31
port: 3000
32

33
#   ┌──────────────────────────┐
34
#───┘ PostgreSQL configuration └────────────────────────────────
35

36
db:
37
  host: db
38
  port: 5432
39

40
  # Database name
41
  db: misskey
42

43
  # Auth
44
  user: { ユーザー名 }
45
  pass: { パスワード }
46

47
  # Whether disable Caching queries
48
  #disableCache: true
49

50
  # Extra Connection options
51
  #extra:
52
  #  ssl: true
53

54
dbReplications: false

.config/docker.env

1
# db settings
2
POSTGRES_PASSWORD={ パスワード }
3
POSTGRES_USER={ ユーザー名 }
4
POSTGRES_DB=misskey

立ち上げ

1
docker-compose up

だけで立ち上がります。うちのサーバーの場合、立つのに一分くらいかかりました。動作チェックをするだけなら、グローバル IP アドレスのポート 3000 でアクセスすればおｋです。

DNS 設定

A レコードに追加します。自分の場合はsplatnet3.comというドメインを持っていたので、それにサブドメインを生やしました。

Type	Name	Content	Proxy status	TTL
A	mihari	xxx.xxx.xxx.xxx	DNS only	Auto

上がそのまま設定したやつです。

最適化

で、ここでちょっと引っかかったのですが Cloudflare の最適化であるAuto Minifyが有効化されているとViteのコードが変に最適化されて動かなくなります。

それでは困るのでPage Rulesで指定したウェブサイトでは自動最適化が実行されないようにします。

よくわからない人はAuto Minify: Offになるように設定すれば良いです。

詳しいやり方は英語だけどこの辺がわかりやすいです。

パーミッション設定

普通に起動すると~/misskey/filesにアクセス権限がなくて画像のアップロードに失敗します。

1
sudo chmod 777 ~/misskey/files

で強引に書き込み権限を付けました。多分もっといい方法があるので緩募。

完成

無事にサーバーが立ち上がりました。嬉しいね。