AnalytodonはGPL-3.0で公開されているオープンソースソフトウェアです。データとインフラを完全にご自身で管理しながら、独自のインスタンスを運用できます。
Analytodonは次のコンポーネントで構成されています。
本番環境ではリバースプロキシ(Caddy、nginx、Traefikなど)が必要です。外部に公開する必要があるのはフロントエンドだけです。
Analytodonには3つの暗号用シークレットが必要です。先に進む前に、.envファイルへ直接生成してください。こうすると、値がクリップボードやターミナルの履歴に残りません。
# AES-256 encryption key (64-char hex) – protects OAuth tokens
echo "ENCRYPTION_KEY=$(openssl rand -hex 32)" >> .env
# JWT secret – signs access tokens
echo "JWT_SECRET=$(openssl rand -base64 48)" >> .env
# Session secret – frontend session cookies
echo "SESSION_SECRET=$(openssl rand -base64 48)" >> .env
ENCRYPTION_KEYは、保存されるMastodonのOAuthトークンを暗号化します。初期設定後に変更すると、連携済みのすべてのMastodonアカウントにアクセスできなくなります。安全な場所に保管してください。バックエンドとCLIの両方のサービスで、同じキーを使用する必要があります。
ビルド済みのイメージがGitHub Container
Registryで公開されています。ご自身でビルドする必要はなく、取得に認証も不要です。各イメージにはビルド元のコミットSHAのタグも付いているので、latestを追いかける代わりに、特定のバージョンに固定できます。現在、イメージはlinux/amd64向けにのみビルドされています。その他のアーキテクチャでは、リポジトリのDockerfileを使ってソースからビルドしてください。
次の内容でdocker-compose.ymlを作成します。
services:
backend:
image: ghcr.io/blazer82/analytodon-backend:latest
environment:
- JWT_SECRET=${JWT_SECRET}
- JWT_EXPIRES_IN=1h
- JWT_REFRESH_TOKEN_EXPIRES_IN=7d
- DB_CLIENT_URL=mongodb://mongo:27017/analytodon
- MASTODON_APP_NAME=Analytodon
- FRONTEND_URL=https://your-domain.com
- MARKETING_URL=https://your-domain.com
- ENCRYPTION_KEY=${ENCRYPTION_KEY}
depends_on:
- mongo
restart: unless-stopped
frontend:
image: ghcr.io/blazer82/analytodon-frontend:latest
ports:
- "127.0.0.1:3002:3000"
environment:
- API_URL=http://backend:3000
- SESSION_SECRET=${SESSION_SECRET}
- MARKETING_URL=https://your-domain.com
depends_on:
- backend
restart: unless-stopped
cli:
image: ghcr.io/blazer82/analytodon-cli:latest
environment:
- MONGODB_URI=mongodb://mongo:27017
- MONGODB_DATABASE=analytodon
- ENCRYPTION_KEY=${ENCRYPTION_KEY}
- APP_URL=https://your-domain.com
depends_on:
- mongo
restart: unless-stopped
mongo:
image: mongo:8
volumes:
- mongo-data:/data/db
restart: unless-stopped
volumes:
mongo-data:
このComposeファイルは、先ほど生成した.envファイルからシークレットを読み込みます(下記の「環境ファイル」を参照)。
上の「シークレットの生成」の手順で、3つのシークレットはすでに.envファイルに書き込まれています。このファイルをdocker-compose.ymlと同じディレクトリに置いてください。Docker
Composeが自動的に変数を読み込み、Composeファイル内の${...}プレースホルダーに代入します。ファイルの内容は次のようになります。
# Generated secrets (see Generate Secrets above)
ENCRYPTION_KEY=your-64-char-hex-key
JWT_SECRET=your-jwt-secret
SESSION_SECRET=your-session-secret
レポートメールやその他の設定項目については、下記の環境変数リファレンスをご覧ください。
外部に公開する必要があるのはフロントエンド(ポート3002)だけです。バックエンドとCLIは、Dockerのネットワークを通じて内部で通信します。
Caddyの設定例:
your-domain.com {
reverse_proxy localhost:3002
}
nginxやTraefikを使う場合は、すべてのトラフィックをポート3002に転送するよう設定してください。
すべてのサービスを起動します。
docker compose up -d
ブラウザでhttps://your-domain.comを開きます。Analytodonのログインページが表示されるはずです。最初のアカウントを登録し、ご利用のMastodonサーバーと連携してください。
最新のイメージを取得して再起動します。
docker compose pull
docker compose up -d
Docker Composeは、イメージが実際に変更されたコンテナだけを再作成します。MongoDBのボリュームには手を加えないため、アップデート後もデータは保持されます。
以下の表は、各サービスの主な設定項目をまとめたものです。
| 変数 | 説明 | 必須 |
|---|---|---|
JWT_SECRET |
アクセストークンの署名に使うシークレット | はい |
JWT_EXPIRES_IN |
アクセストークンの有効期間(デフォルト: 1h) | いいえ |
JWT_REFRESH_TOKEN_EXPIRES_IN |
リフレッシュトークンの有効期間(デフォルト: 7d) | いいえ |
DB_CLIENT_URL |
MongoDBの接続文字列 | はい |
MASTODON_APP_NAME |
OAuthの承認画面に表示される名前(デフォルト: Analytodon) | いいえ |
FRONTEND_URL |
フロントエンドの公開URL | はい |
MARKETING_URL |
マーケティングサイトのURL | いいえ |
ENCRYPTION_KEY |
OAuthトークンの暗号化に使う64文字の16進数キー | はい |
EMAIL_HOST |
SMTPサーバーのホスト名 | いいえ |
EMAIL_PORT |
SMTPサーバーのポート | いいえ |
EMAIL_USER |
SMTPのユーザー名 | いいえ |
EMAIL_PASS |
SMTPのパスワード | いいえ |
EMAIL_SECURE |
SMTPでTLSを使用するか(true/false) | いいえ |
EMAIL_FROM_NAME |
メールの送信者名 | いいえ |
EMAIL_FROM_ADDRESS |
メールの送信元アドレス | いいえ |
EMAIL_API_KEY |
メールサービス用のAPIキー | いいえ |
DISABLE_NEW_REGISTRATIONS |
新規登録を停止する(デフォルト: false) | いいえ |
DISABLE_EMAIL_VERIFICATION |
新規登録を自動的に確認済みにする。SMTPなしで運用する場合に使用(デフォルト: false) | いいえ |
EMAIL_HOSTを未設定のままにし、DISABLE_EMAIL_VERIFICATIONをtrueに設定してください。メールは送信されずにログへ出力され、新規登録は自動的に確認済みになるため、確認画面で止まることがありません。EMAIL_USERとEMAIL_PASSは両方が設定されている場合にのみ使用されるので、認証なしで送信を受け付けるリレーでは、設定しなくても動作します。
| 変数 | 説明 | 必須 |
|---|---|---|
API_URL |
バックエンドの内部URL(例: http://backend:3000) | はい |
SESSION_SECRET |
セッションCookie用のシークレット | はい |
MARKETING_URL |
マーケティングサイトのURL | いいえ |
SUPPORT_EMAIL |
サポート用の連絡先メールアドレス | いいえ |
DISABLE_NEW_REGISTRATIONS |
新規登録を停止する(デフォルト: false) | いいえ |
| 変数 | 説明 | 必須 |
|---|---|---|
MONGODB_URI |
MongoDBの接続文字列 | はい |
MONGODB_DATABASE |
データベース名 | はい |
ENCRYPTION_KEY |
バックエンドのキーと一致している必要があります | はい |
APP_URL |
アプリケーションの公開URL | はい |
EMAIL_API_KEY |
メールサービス用のAPIキー | いいえ |
LOG_LEVEL |
ログの詳細度(デフォルト: info) | いいえ |
環境変数の完全かつ最新の一覧は、GitHubリポジトリのREADME(英語)をご覧ください。