-
Notifications
You must be signed in to change notification settings - Fork 1
設定ファイル
以下の順に検索を行っている。どこに置いても良い。
所有者はmulukhiya-toot-proxyの実行ユーザーで、640か600のパーミッションを推奨。
- /usr/local/etc/mulukhiya-toot-proxy/local.yaml
- /usr/local/etc/mulukhiya-toot-proxy/local.yml
- /etc/mulukhiya-toot-proxy/local.yaml
- /etc/mulukhiya-toot-proxy/local.yml
- 設置先ディレクトリ/config/local.yaml
- 設置先ディレクトリ/config/local.yml
以下、YPath表記にて。
appliation.yamlの記述が既定値なので、既定値と同じ設定は書く必要なし。
ここに書かれていない設定項目が、application.yamlには多くある。
それらの設定項目は内部的なもので、予告なくデフォルト値の変更を行うことがあるので、
その点はご承知いただきたい。
development か production を。
デフォルトは development なので、本番環境に production を指定する場合のみ要設定。
コントローラーの名前を指定。mastodonかmisskeyかdolphin。
デフォルトはmastodonなので、Mastodonで使用する場合は指定不要。
*のところは、ハンドラのアンダースコア名。
利用しないハンドラはtrueに設定。
テストやヘルスチェックに使用するアクセストークンを記述。
全てのテストが、このトークンの持ち主の権限で実行される。Mastodonの場合、このアカウントに以下の設定を行っておくこと。
- トークンに
readwritefollowを付与。 - モデレータへの昇格
Dolphinの場合は、今のところ SELECT username,token FROM "user" WHERE token IS NOT NULL 等で調べる必要あり。
（調べる方法が他にないか、確認中）
お知らせの投稿や、エラーメッセージの通知を行う、ボットアカウントのアクセストークンを記述。
Mastodonの場合、このアカウントに以下の設定を行っておくこと。
- トークンに
write:statuseswrite:mediaを付与。
Dolphinの場合は、今のところ SELECT username,token FROM "user" WHERE token IS NOT NULL 等で調べる必要あり。
（調べる方法が他にないか、確認中）
例外発生時の通知先。Slackのwebhookと互換性のあるURLを列挙。
ここにモロヘイヤ自身のwebhookを設定することも可能だが、無意味と思われるw
明示的な設定を強く推奨。
モロヘイヤの誤動作は最悪のケースでは「トゥートが行えない」ことにつながり、インスタンスの
メンバーが異常をトゥートで報告することすらできなくなると考えられる。
この為、アラートを受け取る手段は極力確保しておくべき。
Discordも可。
その場合は、末尾に /slack を加えることをお忘れなく。
Amazonのアソシエイトタグをお持ちであれば、それを指定。
Amazonアソシエイトのアクセスキーを指定。
Amazonアソシエイトのシークレットキーを指定。
Amazonのアフィリエイトを使用する場合は true を指定。
URLの末尾に /amazon/associate_tag で設定したタグが、 ?tag=hogefuga 形式で追加される。
アフィリエイトを使用しない場合は指定不要。
Twitter連携機能を使用する場合は、コンシューマキーを指定。
Twitter連携機能を使用する場合は、コンシューマシークレットを指定。
Twitterむけに付加するハッシュタグを配列で。
インスタンスのルートURLを記述。必須。
トゥートの最大文字長。デフォルトは500。
インスタンスを改造し、500より大きな数値にしている場合は要修正。
「トゥート」を別の文言にしているインスタンスでは、要修正。
検索APIの件数上限。デフォルトは40。（Mastodon本来のデフォルトは20）
インスタンスのルートURLを記述。必須。
ノートの最大文字長。デフォルトは500。
インスタンスの設定と一致させる。
「ノート」を別の文言にしているインスタンスでは、要修正。
インスタンスのルートURLを記述。必須。
ノートの最大文字長。デフォルトは500。
インスタンスを改造し、500より大きな数値にしている場合は要修正。
「ノート」を別の文言にしているインスタンスでは、要修正。
インスタンスのルートURLを記述。必須。
ステータスの最大文字長。デフォルトは5000。
インスタンスの設定と一致させる。
「ステータス」を別の文言にしているインスタンスでは、要修正。
画像長辺ピクセル数の上限。この大きさに合わせてリサイズされる。
デフォルトは1280。これより大きな数字にするには、今のところMastodonの本体改造も必要。
SpotifyのClient IDを指定。
Spotify再生のリンクを挿入する為に必要。
SpotifyのClient Secretを指定。
Spotify再生のリンクを挿入する為に必要。
デフォルトはja,en-US;q=0.9,en;q=0.8。
SpotifyのAPIにリクエストヘッダ Accept-Language として送信される。
iTunes Search APIを利用する際のパラメータ。
日本のiTunes Storeを検索対象にするなら、 ja を指定。
iTunes Search APIを利用する際のパラメータ。
戻り値の言語を日本語にするなら、 ja_jp を指定。
APIキーを設定。YouTube APIを使用するときに必要。
PostgreSQLへの接続情報。一般的なDSN（URL）の書式で。
パスワードが必要な場合は、 postgres://user:password@localhost:5432/dbname 形式で。
Redisへの接続情報。ユーザー設定の格納に使用する。一般的なDSN（URL）の書式で。
MastodonのSidekiqが使用するサーバID（通常0）とは別のIDを推奨。
Sidekiqが使用するRedisの接続情報。一般的なDSN（URL）の書式で。
MastodonのSidekiqが使用するサーバID（通常0）とは別のIDを推奨。
SidekiqのダッシュボードにBASIC認証をかける場合のユーザー名。
デフォルトは admin 。
SidekiqのダッシュボードにBASIC認証をかける場合のパスワード。
平文でもよいが、以下の手順で生成したハッシュを指定すればほんの少しマシなので、こちらを推奨。
ruby -e 'puts "your_password".crypt(`hostname`)'
BASIC認証が不要な場合は空欄 '' にしておく。（この指定がデフォルト）
@relayctl@hashtag-relay.dtp-mstdn.jp 等、特別な振る舞いをするエージェントアカウントを列挙する。
デフォルトハッシュタグの配列。各タグは、先頭の#を除いた形で記述。省略可。
ハッシュタグ化するワードの最短の文字数。デフォルトは3。
この設定は生成される辞書には影響を与えず、辞書の中の単語を無視するかどうかの判断に使われる。
よって、この設定値を修正した後に辞書の更新を行う必要はない。
画像が添付されているトゥートに加えるハッシュタグの名前。デフォルトは image。
機能そのものを無効にしたい場合はnullを指定。
画像が添付されているトゥートに加えるハッシュタグの名前。デフォルトは video。
機能そのものを無効にしたい場合はnullを指定。
音源が添付されているトゥートに加えるハッシュタグの名前。デフォルトは audio。
機能そのものを無効にしたい場合はnullを指定。
ハッシュタグ辞書のURL。複数指定可能。
デフォルトではテスト用の辞書がいくつか登録されている為、公開されている辞書等も参考にして、要修正。
ハッシュタグ辞書URLの型。デフォルトはmulti_field。
relativeやmecabの指定が必要な場合は明示的に指定。
ハッシュタグ辞書URLに対応する要素名の配列。multi_field型の場合は必要。
番組表APIのURLを記述。
webhookのURL生成に使われるソルト。
任意の文字列を指定可だが、パスワード同様の厳重な管理を。
デフォルト値は mulukhiya 、ステージング環境では必ずしも設定不要。
WebUIのアクセストークンを、ブラウザに保存する際の暗号化（内部的には OpenSSL::Cipher::AES 使用）に使われる。
厳重な管理を。ステージング環境では必ずしも設定不要。