コンテンツにスキップ
HolyArrsDocsHolyArrs.com

環境変数

上級者

HolyArrs のコンテナが読み取るすべての変数です。ほとんどのインストールでは、PUID、PGID、TZ だけを設定します。

よく使うもの

よく使うもの へのリンク
変数 内容 既定値 例
PUID, PGID HolyArrs を実行するユーザーとグループです。/config とメディアフォルダーの所有者である必要があります。 1000, 1000 PUID=1000
TZ スケジュールとログに使うタイムゾーンです。 Etc/UTC TZ=Europe/Amsterdam
UMASK 新しいファイルから外す権限ビットです。新しいファイルにだけ影響します。 022 UMASK=002
HOLYARRS_SAVE_PATH ダウンローダーから見た、ダウンローダーの保存フォルダーです。ダウンロードのたびに送られます。 なし /data/downloads
HOLYARRS_URL_BASE リバースプロキシの後ろで、HolyArrs をパスの下で公開します。/ にすると、設定に保存したパスを無視します。 なし /holyarrs
HOLYARRS_ALLOWED_HOSTS HolyArrs へのアクセスに使う追加のホスト名です。カンマ区切りで指定します。 IP と localhost holyarrs.example.com
HOLYARRS_TRUSTED_PROXIES リバースプロキシのアドレスまたはネットワークです。カンマ区切りで指定します。クライアントの本当のアドレスを知るために必要です。 なし 172.18.0.0/16
HOLYARRS_MASTER_KEY_FILE 保管庫のマスターキーを専用のファイルから読み取ります。PUID のユーザーが読み取れる必要があります。 /config/holyarrs.key /keys/holyarrs.key

ファイルから値を読み取る

ファイルから値を読み取る へのリンク

どの変数でも、前に FILE__ を付けると、Docker secret などのファイルから値を読み取ります。

environment:
  - FILE__HOLYARRS_ALLOWED_HOSTS=/run/secrets/holyarrs_hosts

HolyArrs は、ファイル末尾の改行を 1 つ取り除きます。ファイルがない場合、HolyArrs は停止し、ログには変数名とファイル名が出ます。値は出ません。

復旧とトラブルシューティング

復旧とトラブルシューティング へのリンク
変数 内容 既定値 例
HOLYARRS_SAFE_MODE コア部分だけを起動します。サインイン、ライブラリ、設定、バックアップ、稼働状態です。問題を直したら外してください。 オフ 1
HOLYARRS_LOW_MEMORY 1 で低メモリモードを強制的にオン、0 で強制的にオフにします。未設定の場合は、RAM が約 2.5 GiB 以下のときにオンになります。 マシンの規模による 1
GOMEMLIMIT HolyArrs が自分に設定するメモリの目標値を上書きします。 HolyArrs が設定 1GiB
HOLYARRS_SKIP_SPACE_CHECK データベース更新の前の空き容量チェックを省略します。 オフ yes
HOLYARRS_CONFIG_IN_MEMORY /config をメモリ上のフォルダーに置くことを許可します。テスト用のマシン向けです。再起動するとデータは失われます。 オフ yes
HOLYARRS_ALLOW_DESKTOP_FOLDER Mac で /config が Docker Desktop の共有フォルダーにあっても起動します。そこでファイルロックが動くことを確認してから使ってください。HolyArrs は起動のたびに警告します。 オフ 1
HOLYARRS_READONLY_DOWNLOADERS HolyArrs が決して変更してはならないダウンローダーです。id またはアドレスをカンマ区切りで指定します。 なし 3,http://qbit:8080
HOLYARRS_HEALTH_URL コンテナのヘルスチェックが呼び出すアドレスです。 http://127.0.0.1:6262 http://127.0.0.1:6262/holyarrs

オン・オフの変数は、1、true、yes、on のいずれかを受け付けます。

シングルサインオン

シングルサインオン へのリンク

起動前に設定します。HOLYARRS_OIDC_ENABLED が存在すると、値が false であっても、シングルサインオンは環境変数の管理になり、設定では表示だけになります。ここにあるオン・オフの変数は true か false だけを受け付けます。それ以外の値では起動が止まります。

変数 内容 既定値
HOLYARRS_OIDC_ENABLED シングルサインオンをオンにします。 false
HOLYARRS_OIDC_ISSUER プロバイダーの正確な HTTPS の issuer です。 なし
HOLYARRS_OIDC_CLIENT_ID 登録したクライアント id です。 なし
HOLYARRS_OIDC_CLIENT_SECRET_FILE クライアントシークレットを入れたファイルです。最大 4096 バイトです。公開クライアントでは指定しません。 なし
HOLYARRS_OIDC_REDIRECT_URL 正確なコールバックです。お使いのアドレス、URL ベース(ある場合)、/api/v1/auth/oidc/callback の順につなげます。 なし
HOLYARRS_OIDC_ALLOW_JOIN 新しい人は、リクエストだけができるメンバーとして参加します。 false
HOLYARRS_OIDC_ALLOW_LOCAL_NETWORK プライベートネットワーク上のプロバイダーを許可します。 false
HOLYARRS_OIDC_ALLOW_LOOPBACK_HTTP テスト用に、このマシン上での平文の HTTP を許可します。 false
HOLYARRS_FORWARD_AUTH_ENABLED 信頼するプロキシによるサインインをオンにします。 false
HOLYARRS_FORWARD_AUTH_ISSUER プロキシを表す、変わらない HTTPS の名前です。 なし
HOLYARRS_FORWARD_AUTH_TRUSTED_PEERS 本人情報のヘッダーを送ることを許可するプロキシのアドレスまたは範囲です。カンマ区切りで指定します。 なし
HOLYARRS_FORWARD_AUTH_ALLOW_JOIN プロキシから来た新しい名前は、リクエストだけができるメンバーとして参加します。 false

設定に誤りがあると、HolyArrs は起動しません。手順は サインインとパスワード にあります。

上級者向け

上級者向け へのリンク
メタデータ
変数 内容 既定値
HOLYARRS_METADATA_URL メタデータサーバーのアドレスです。 https://api.holyarrs.com
HOLYARRS_TMDB_KEY 自分の TMDB 読み取りアクセストークンです。設定すると、TMDB の読み取りはメタデータサーバーを通さず、TMDB に直接行きます。 なし
HOLYARRS_METADATA_SERVICE_TOKEN_FILE このインストールのメタデータサーバー用の認証情報を入れたファイルです。呼び出しのたびに読み取ります。未設定の場合、認証情報は保管庫に入ります。 なし
初回起動のショートカット

それぞれ、起動時に項目を 1 つ追加します。デモやテストで使うものです。初回セットアップのウィザードでも同じことができます。

変数 追加されるもの
HOLYARRS_MOVIES 映画のライブラリフォルダー。
HOLYARRS_QBITTORRENT_URL qBittorrent のダウンローダー。
HOLYARRS_SOURCE_URL キーなしの Torznab ソース。
開発者向け・テスト用の変数

テストのために、HolyArrs を代わりのサービスに向ける変数です。実際のインストールでは未設定のままにしてください。

変数 内容
HOLYARRS_FLAGS このリリースで既定でオフの機能を切り替えるスイッチです。カンマ区切りで指定します。アップデート を参照してください。
HOLYARRS_DIRECT_SOURCES 1 にすると、このインストールは音楽と TV の情報元に、メタデータサーバーを通さず自分で問い合わせます。
HOLYARRS_METADATA_SERVICE_ALLOW_LOCAL ローカルネットワーク上のメタデータサーバーを許可します。
HOLYARRS_METADATA_COUNT メタデータのリクエストを数えてログに出します。
HOLYARRS_TMDB_TOKEN_FILE, HOLYARRS_TMDB_URL テスト用の TMDB トークンファイルと、代わりのアドレスです。
HOLYARRS_TVMAZE_URL, HOLYARRS_MUSICBRAINZ_URL, HOLYARRS_DEEZER_URL, HOLYARRS_TRAKT_URL, HOLYARRS_PLEX_URL, HOLYARRS_PLEX_APP_URL, HOLYARRS_PLEX_DISCOVER_URL, HOLYARRS_PUSHOVER_URL, HOLYARRS_TELEGRAM_URL, HOLYARRS_YOUTUBE_URL, HOLYARRS_RELEASE_FEED 外部サービスの代わりに使うアドレスです。
HOLYARRS_TRAILER_PASS_FIRST, HOLYARRS_TRAILER_PASS_EVERY 予告編の処理のタイミングです。2s のような時間で指定します。

関連ページ

関連ページ へのリンク

HolyArrs は無料です。時間の節約になったら、GitHub でスターを付ける、スポンサーになる、コーヒーをおごるのいずれかで応援してください。