環境變數

進階

HolyArrs container 會讀取的所有變數。大多數安裝只需要設定 PUID、PGID 和 TZ。

常用

變數	作用	預設	範例
`PUID`, `PGID`	HolyArrs 執行時使用的使用者與群組。必須擁有 `/config` 和你的媒體資料夾。	`1000`, `1000`	`PUID=1000`
`TZ`	排程和 log 使用的時區。	`Etc/UTC`	`TZ=Europe/Amsterdam`
`UMASK`	新檔案要去掉的權限位元。只影響新檔案。	`022`	`UMASK=002`
`HOLYARRS_SAVE_PATH`	下載器的儲存資料夾，以下載器看到的路徑為準。每次下載都會一併送出。	無	`/data/downloads`
`HOLYARRS_URL_BASE`	在 reverse proxy 後面，把 HolyArrs 放在某個路徑下。設為 `/` 會忽略在「設定」中儲存的路徑。	無	`/holyarrs`
`HOLYARRS_ALLOWED_HOSTS`	其他人用來連到 HolyArrs 的額外主機名稱，以逗號分隔。	IP 和 `localhost`	`holyarrs.example.com`
`HOLYARRS_TRUSTED_PROXIES`	你的 reverse proxy 的位址或網段，以逗號分隔。要取得真實的用戶端位址就需要它。	無	`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 會去掉檔案結尾的一個換行。如果找不到檔案，HolyArrs 會停止，log 會寫出變數和檔案的名稱，但絕不會寫出值。

變數	作用	預設	範例
`HOLYARRS_SAFE_MODE`	只啟動核心：登入、媒體庫、設定、backup 和健康狀態。修好問題後請移除它。	關閉	`1`
`HOLYARRS_LOW_MEMORY`	`1` 強制開啟低記憶體模式，`0` 強制關閉。未設定時，記憶體約 2.5 GiB 或更少就會自動開啟。	依電腦大小	`1`
`HOLYARRS_FOLLOW_LINKS`	`1` 讓媒體庫掃描和匯入可以使用屬於 symlink 的影片和音樂檔案（用連結指向已掛載磁碟所建立的媒體庫）。已連結的下載會以連結的形式放進媒體庫。	關閉	`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`	container 健康檢查所呼叫的位址。	`http://127.0.0.1:6262`	`http://127.0.0.1:6262/holyarrs`

開關型變數接受 1、true、yes 或 on。

請在啟動前設定這些變數。只要出現 HOLYARRS_OIDC_ENABLED，即使值是 false，Single Sign-on 就由環境變數管理，「設定」只會顯示它。這裡的開關型變數只接受 true 或 false；其他值會讓 HolyArrs 無法啟動。

變數	作用	預設
`HOLYARRS_OIDC_ENABLED`	開啟 Single Sign-on。	`false`
`HOLYARRS_OIDC_ISSUER`	提供者確切的 HTTPS issuer。	無
`HOLYARRS_OIDC_CLIENT_ID`	已註冊的 client id。	無
`HOLYARRS_OIDC_CLIENT_SECRET_FILE`	存放 client secret 的檔案，最多 4096 位元組。公開用戶端請省略。	無
`HOLYARRS_OIDC_REDIRECT_URL`	確切的 callback：你的位址、URL base（如果有），然後是 `/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`	開啟受信任的 proxy 登入。	`false`
`HOLYARRS_FORWARD_AUTH_ISSUER`	proxy 的固定 HTTPS 名稱。	無
`HOLYARRS_FORWARD_AUTH_TRUSTED_PEERS`	允許傳送身分標頭的 proxy 位址或範圍，以逗號分隔。	無
`HOLYARRS_FORWARD_AUTH_ALLOW_JOIN`	新的 proxy 名稱會成為只能提出請求的成員。	`false`

設定有誤會讓 HolyArrs 無法啟動。步驟請見登入與密碼。

Metadata

變數	作用	預設
`HOLYARRS_METADATA_URL`	metadata 伺服器的位址。	`https://api.holyarrs.com`
`HOLYARRS_TMDB_KEY`	你自己的 TMDB 讀取存取 token。設定後，TMDB 的讀取會直接連到 TMDB，而不經過 metadata 伺服器。	無
`HOLYARRS_METADATA_SERVICE_TOKEN_FILE`	存放這個安裝的 metadata 伺服器憑證的檔案，每次呼叫都會讀取。未設定時，憑證存放在保管庫中。	無

使用你自己的 TMDB 金鑰時，哪些資料仍然會經過 metadata 伺服器，以及其他所有外部位址，都寫在外部位址。

首次啟動捷徑

每個變數會在啟動時新增一個項目。用於展示和測試；首次執行精靈做的是同樣的事。

開發與測試變數

這些變數會讓 HolyArrs 連到測試用的替身。正式安裝請不要設定。

變數	作用
`HOLYARRS_FLAGS`	以逗號分隔的開關，用來開啟這個版本中預設關閉的功能。請見更新。
`HOLYARRS_DIRECT_SOURCES`	`1` 讓這個安裝自己查詢音樂和電視來源，而不是透過 metadata 伺服器。
`HOLYARRS_METADATA_SERVICE_ALLOW_LOCAL`	允許位於區域網路的 metadata 伺服器。
`HOLYARRS_METADATA_COUNT`	計算並記錄 metadata 請求。
`HOLYARRS_TMDB_TOKEN_FILE`, `HOLYARRS_TMDB_URL`	測試用的 TMDB token 檔案和替身位址。
`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`。