elythia

Elythia

Elythiaは、Goで書かれたActivityPubサーバーです。Misskeyから生まれ、Misskeyのクライアントや連合との互換性を保ちながら、独自の機能を育てています。

特徴

• Misskeyのクライアントがそのまま使える — 本家のAPIとの互換を保ち、独自の拡張は原則として追加で行います(本家と意図的に違えた挙動は差分カタログに記録しています)
• Webの画面も同梱 — Misskeyのフロントエンドを取り込み、独自の改良を加えて配信しています
• TS版Misskeyから乗り換えられる — 既存のDBを引き継いで起動できます。手順と注意は移行ガイドを参照してください(TS版へ戻すことは保証していません)
• Goで再構築 — バックエンドをGoで一から書き直しています
• プラグインで広げられる — コアを変えずに、APIや画面の追加、定期ジョブ、プラグインが管理するアカウントへの通知の処理などを足せます(ビルド時に組み込み)
• ActivityPubで連合 — MisskeyやMastodonなど、ほかのサーバーの利用者と交流できます
• 互換性をCIで検証 — APIの応答の形、本家のテスト、実際のMisskey・Mastodonとの連合を、CIで確かめています

クイックスタート

最短: pull して起動 (ビルド不要)

フロントエンドアセットを同梱した bundled イメージを使う。ビルドが一切要らない。

動かすだけなら docker ブランチを使う。 compose と設定のひな形だけが入った orphan ブランチで、Go のソースも frontend の ソースも含まないため数十 KB で済む (develop は .git だけで 672MB ある)。

git clone --depth 1 -b docker https://github.com/Elythia-Network/elythia.git mk
cd mk

mkdir -p files && sudo chown -R 991:991 files
docker compose up -d

# ブラウザで http://localhost:3000 を開く

ソースを持っている場合は同じことを Makefile から実行できる。

mkdir -p files && sudo chown -R 991:991 files
make image-up

設定を変える場合は .config/docker.yml を用意し、docker-compose.image.yml の app と migrate 両方の volumes コメントを外す。詳細はデプロイを参照。

ソースからビルドする (Docker Compose)

git clone https://github.com/Elythia-Network/elythia.git
cd elythia

1. フロントエンドをビルドする (初回のみ、3-10分)

make e2e-frontend-build

フロントエンドは本体の frontend/ (Misskey TS の fork を取り込んだ pnpm workspace) からビルドする。SPA の JS/CSS は約 200MB あるため image に焼き込まず、成果物の frontend/built を bind-mount で渡している。これを省くとフロントエンドのアセットが 404 になり画面が表示されない。

2. 設定ファイルを用意する

cp .config/docker.yml.example .config/docker.yml
# .config/docker.yml の url を実際のアドレスに変更する

url は必須項目。.config/docker.yml.example の既定値は http://localhost:3000 なので、そのままでは連合できない (https://example.tld/ は default.yml.example 側の値)。編集したら docker-compose.yml の app と migrate の両方にある volumes のコメントを外す。

- ./.config/docker.yml:/app/.config/default.yml:ro

migrate 側にも同じ mount を入れないと、マイグレーションと本体が別の DB を見にいく。

ローカルで試すだけなら、この手順は省略して既定の設定のまま起動してもよい。

3. ドライブ用ディレクトリの所有権を設定する

mkdir -p files && sudo chown -R 991:991 files

コンテナは Misskey TS 互換の UID/GID 991 で動くため、この所有権でないとファイルをアップロードできない。

4. 起動する

docker compose up -d

DB マイグレーションは one-shot の migrate サービスが自動適用し、その完走を待って app が起動する。手動で流す必要はない。

ブラウザで http://localhost:3000 を開き、最初のアカウントを作成する。

より詳しい構成 (UDS、prebuilt image、systemd、逆プロキシ) はデプロイを参照。

アップデート

# pull → ビルド → 再起動 → 配信アセットの検証まで通す
make docker-update   # Docker Compose 構成
make uds-update      # UDS 構成

注意点:

• frontend/ のソースが動いたらフロントエンドを再ビルドする。成果物の frontend/built は git の管理の外にあり、git pull では変わらない。make pull (内部で make update) は、再ビルドが要るかどうかを知らせる。make *-update は再ビルドまで行う
• フロントエンドを再ビルドしたら必ず Elythia を再起動する。エントリポイントを起動時に 1 回だけ解決してキャッシュするため、再起動しないと消えた古いファイルを参照し続けて 404 になる。docker compose up -d では再起動されない — イメージと設定が変わらなければコンテナは作り直されず、フロントエンドは bind-mount なので何も変わらないため。make *-update / make *-restart は restart を明示したうえで、配信中のアセットが実在するかまで検証する (#2885)
• ビルド中はフロントエンドが 404 になる。配信中のディレクトリを作り直すため。ビルドが失敗した場合は 404 のまま残るので、成功するまで直すこと
• ブラウザ側に Service Worker が残っている場合はハードリロードする

バイナリ直接実行や UDS 構成でのアップデート手順はデプロイを参照。

ローカルビルド

前提: Go 1.27+、PostgreSQL 18推奨 (16以降で動作、CI検証は18)、Redis 7+、Docker (テスト用)

git clone https://github.com/Elythia-Network/elythia.git
cd elythia

# 設定ファイルを作成 (→ docs/configuration.md 参照)
cp .config/default.yml.example .config/default.yml
# default.yml を環境に合わせて編集

# マイグレーション適用 (接続先は上で編集した default.yml から読む)
make migrate-up

# ビルド & 起動
make build
./built/elythia serve -config .config/default.yml

# 開発モード (go run)
make dev

テスト

# 全テスト (PostgreSQL が要る。→ docs/testing.md)
make test

# 特定パッケージ
go test ./internal/api/notes/...

# レース検出 + カバレッジ (CIと同条件)
go test -race -count=1 -shuffle=3 -timeout 10m \
  -coverprofile=coverage.out -covermode=atomic ./...

ドキュメント

ライセンス

GNU AGPL-3.0