基本的な設定項目

設定例

environment: production
controller: misskey
user_config:
  redis:
    dsn: redis://localhost:6379/1
handler:
  nextcloud_clipping_command:
    disable: true
  nextcloud_bookmark:
    disable: true
crypt:
  password: your_password
agent:
  test:
    token: test_token
  info:
    token: info_token
    follow:
      templage: welcome_example
  accts:
    - '@relayctl@hashtag-relay.dtp-mstdn.jp'

詳細

/environment

• development か production を。
• デフォルトは development なので、本番環境に production を指定する場合のみ要設定。

/controller

• コントローラーの名前を指定。
• mastodon,misskey,pleroma,meisskeyのいずれか。
• デフォルトはmastodonなので、Mastodonで使用する場合は指定不要。

/user_config/redis/dsn

• ユーザー設定の格納等に使用する、Redisへの接続情報。
• DSN（URL）で指定。
• MastodonのSidekiqが使用するサーバID（通常0）とは別のIDを推奨。

/handler/*/disable

• *のところは、ハンドラのアンダースコア名。
• 利用しないハンドラはtrueに設定。

/crypt/salt

• webhookのURL生成等に使われるソルト。
• デフォルト値は /crypt/password と同じ値。設定する必要は必ずしもなし。
• 任意の文字列を指定可だが、パスワード同様の厳重な管理を。

/crypt/password

• モロヘイヤHOMEのアクセストークンをブラウザに保存する際の暗号化（内部的には OpenSSL::Cipher::AES 使用）に使われる。
• 厳重な管理を。ステージング環境では必ずしも設定不要。

/agent/test/token

• テストボットのアクセストークンを記述。
• モロヘイヤHOMEに表示されるトークン（暗号化トークン）でも、平文のトークンでも、どちらも設定可。
• モロヘイヤHOMEに表示される暗号化トークンは、必ずシングルクォート ' でくくる。

/agent/info/token

• お知らせボットのアクセストークンを記述。
• モロヘイヤHOMEに表示されるトークン（暗号化トークン）でも、平文のトークンでも、どちらも設定可。
• ウェルカムメッセージ機能を使用する場合は、お知らせボットむけの専用トークンをモロヘイヤHOMEで作成。（必要な権限が少し違う）
• モロヘイヤHOMEに表示される暗号化トークンは、必ずシングルクォート ' でくくる。

/agent/info/welcome/template

• ウェルカムメッセージのテンプレート。デフォルトは welcome 。
• WelcomeMentionHandlerで使用。

/agent/accts/*

• @relayctl@hashtag-relay.dtp-mstdn.jp 等、特別な振る舞いをするエージェントアカウントを列挙する。

/cli/progress_bar/format

• 一部のrakeタスクに表示されるプログレスバーの書式。デフォルトは '%c/%C (%p%%)| %B'。
• 公式wiki参照。