設定
Mitra はすべて環境変数で設定します。マウントする設定ファイルはありません。コンテナに変数を設定すれば、Mitra が起動時にそれを読みます。すべての変数は任意で、設定しない変数は後述のデフォルト値を使います。
Docker Compose では、environment ブロックに書きます:
services: mitra: image: ghcr.io/a11delavar/mitra:latest environment: MITRA_URL: 'https://mitra.example.com' MITRA_NAME: 'Family Calendar'シークレットを compose ファイルに書きたくなければ、.env ファイルや Docker secrets でも同じです。変更は Mitra を次に起動したときに反映されます:
docker compose up -dサーバーで必要な設定
Section titled “サーバーで必要な設定”ほとんど何もありません。Mitra カレンダー、CalDAV、Apple カレンダー、カレンダー購読、Notion、Todoist、Tempo は、利用者がアプリ内で自分で追加します。
外部に登録する認証情報が必要なのは2つだけです: Google カレンダー(MITRA_GOOGLE_*)とサインイン(MITRA_OIDC_*)。
HTTPS 越しに公開する
Section titled “HTTPS 越しに公開する”自分のマシン以外から Mitra に届くようにするなら、Caddy、Traefik、nginx のようなリバースプロキシの後ろに置き、プロキシに HTTPS を任せてください。Mitra 自身はコンテナ内では平文の HTTP を話します。HTTPS でしか動かない機能がいくつかあります:
- リマインダーとアプリのインストールは、ブラウザーが
https://のアドレス(およびhttp://localhost)でしか許可しません。 - サインインの Cookie が secure とマークされるのは
https://のときだけで、ほとんどの ID プロバイダーはhttps://のリダイレクトアドレスを要求します。 - Google カレンダーは
https://のリダイレクトアドレスを必要とします。
それから MITRA_URL に公開アドレスを設定します。
Caddy なら、これだけです:
mitra.example.com { reverse_proxy localhost:3000}Traefik では、サービスのラベルで Mitra へルーティングします:
services: mitra: image: ghcr.io/a11delavar/mitra:latest restart: unless-stopped volumes: - ~/mitra:/app/data labels: - "traefik.enable=true" - "traefik.http.routers.mitra.rule=Host(`mitra.example.com`)" - "traefik.http.services.mitra.loadbalancer.server.port=3000" environment: MITRA_URL: 'https://mitra.example.com'公開 URL を設定する
Section titled “公開 URL を設定する”MITRA_URL は、人がブラウザーに入力して Mitra に届くアドレスで、コンテナの内部アドレスではありません:
environment: MITRA_URL: 'https://mitra.example.com'Mitra はこれから Google カレンダーとサインインのリターンアドレスを組み立て、https:// で始まるときは Cookie を secure とマークします。http://localhost で試している間は省略できます。Mitra に正式なアドレスができたらすぐに設定してください。サインインを有効にするには必須です。
サーバーに名前を付ける
Section titled “サーバーに名前を付ける”MITRA_NAME は、サイドバー、ブラウザーのタブ、インストールしたアプリの「Mitra」を置き換えます:
environment: MITRA_NAME: 'Family Calendar'名前をクリックすると バージョン情報 ダイアログが開き、実行中のバージョンとコミットが表示されます。インストールしたアプリの名前とアイコンは「Mitra」のままです。アプリのビルド時に決まっているからです。
すべての変数
Section titled “すべての変数”| 変数 | デフォルト値 | 説明 |
|---|---|---|
MITRA_URL | (未設定) | 人が Mitra に届く公開アドレス。https://mitra.example.com など。サインインと Google カレンダーのリターンアドレス、Cookie を secure にするかどうかは、ここから決まります。localhost で試す間は任意、サインインでは必須、Google カレンダーや公開サーバーでは設定を推奨します。 |
MITRA_NAME | (Mitra。各利用者の言語で) | サイドバー、ブラウザーのタブ、インストールしたアプリに表示される名前。 |
MITRA_PORT | 3000 | サーバーが待ち受けるポート。Docker ではポートマッピングのホスト側を変えるのが普通です。プロセス自身が別のポートを待つ必要があるときだけ設定します。組み込みのヘルスチェックもこれに従います。 |
MITRA_LOG_LEVEL | info | Mitra が出力するログの量: error、warn、info、debug、trace のいずれか。各レベルは、それより静かなレベルのすべてを含みます。 |
MITRA_UPDATE_CHECK | (オン) | off(または false、0、no)にすると更新チェックを無効にします。 |
MITRA_MCP | (オン) | off(または false、0、no)にすると AI ツールが接続するアドレスを閉じます。 |
リマインダー
Section titled “リマインダー”| 変数 | デフォルト値 | 説明 |
|---|---|---|
MITRA_VAPID_SUBJECT | mailto:mitra@localhost | プッシュサービスに見せる、サーバーのリマインダーの連絡先。たいてい mailto: アドレスです。Mitra の利用者には見えません。署名キーは自動生成されるので、他に設定は不要です。 |
| 変数 | デフォルト値 | 説明 |
|---|---|---|
MITRA_PHOTON_URL | https://photon.komoot.io | 場所フィールドの背後にある Photon ジオコーダー。komoot の公開サーバーではなく、自分の Photon サーバーを指せます。 |
添付ファイル
Section titled “添付ファイル”| 変数 | デフォルト値 | 説明 |
|---|---|---|
MITRA_FILE_MAX_SIZE | 25M | 1人が項目に添付できるファイルの最大サイズ。バイト数、または k、M、G の接尾辞付きで書きます。0 にするとファイルの追加を無効にします。 |
MITRA_FILE_QUOTA | (未設定) | 各利用者が添付ファイルに保存できる総量。書き方は同じです。未設定なら制限なしです。 |
Google カレンダー
Section titled “Google カレンダー”両方を設定すると、利用者が Google カレンダーを接続できます。ID だけを設定すると Mitra は起動しません。
| 変数 | デフォルト値 | 説明 |
|---|---|---|
MITRA_GOOGLE_CLIENT_ID | (未設定) | Google Cloud コンソールの OAuth クライアント ID。 |
MITRA_GOOGLE_CLIENT_SECRET | (未設定) | OAuth クライアントシークレット。MITRA_GOOGLE_CLIENT_ID を設定したときは必須です。 |
シングルサインオン
Section titled “シングルサインオン”MITRA_OIDC_ISSUER を設定するとサインインが有効になります。必要な変数が欠けていると、Mitra は起動を拒否します。
| 変数 | デフォルト値 | 説明 |
|---|---|---|
MITRA_OIDC_ISSUER | (未設定) | OIDC プロバイダーの issuer URL。MITRA_OIDC_CLIENT_ID と MITRA_URL が必要です。 |
MITRA_OIDC_CLIENT_ID | (未設定) | プロバイダーに登録したクライアント ID。 |
MITRA_OIDC_CLIENT_SECRET | (未設定) | クライアントシークレット。パブリッククライアントでは省略してください。Mitra は常に PKCE を使います。 |
MITRA_OIDC_SCOPES | openid profile email | Mitra が要求するスコープ。スペース区切りです。openid は必須。profile と email で各利用者の名前とメールアドレスを取得します。 |
ビルドが設定する変数
Section titled “ビルドが設定する変数”サーバーでは設定しません。ビルドやイメージが設定するか、Mitra 自体の開発用です。
| 変数 | 設定元 | 説明 |
|---|---|---|
MITRA_VERSION | ビルド | イメージに組み込まれるバージョン。 |
MITRA_COMMIT | ビルド | イメージに組み込まれるコミット。 |
MITRA_DEV | 開発 | Mitra の開発中に、サンプルカレンダーのセットである デモ 連携を提供します。 |
NODE_ENV | イメージ | コンテナイメージでは production。 |
サインイン、Google カレンダー、独自のジオコーダーを使うサーバー:
services: mitra: image: ghcr.io/a11delavar/mitra:latest restart: unless-stopped ports: - '3000:3000' volumes: - ~/mitra:/app/data environment: MITRA_URL: 'https://mitra.example.com' MITRA_NAME: 'Family Calendar'
# Sign-in MITRA_OIDC_ISSUER: 'https://auth.example.com' MITRA_OIDC_CLIENT_ID: 'mitra' MITRA_OIDC_CLIENT_SECRET: '…'
# Google Calendar MITRA_GOOGLE_CLIENT_ID: '….apps.googleusercontent.com' MITRA_GOOGLE_CLIENT_SECRET: '…'
# Your own geocoder MITRA_PHOTON_URL: 'https://photon.internal.example.com'