Parts and safe mode

設定

關閉你用不到的功能區塊，出問題時以安全模式啟動，也可以從瀏覽器重新啟動 HolyArrs。

開啟或關閉功能區塊

HolyArrs 有 5 個功能區塊：Movies（電影）、TV shows（影集）、Music（音樂）、Subtitles（字幕）和 Requests（請求）。你在首次執行的精靈中第一次選擇它們。

開啟 Settings > Parts（設定 > 功能區塊）。
按下功能區塊旁邊的 Turn on（開啟）或 Turn off（關閉）。你應該會看到它的選單項目出現或消失。

什麼都不會被刪除。再開啟一次，它就會從原來的地方繼續。

以安全模式啟動

安全模式只會啟動基本功能，適合有東西讓 HolyArrs 無法啟動或無法正常運作的時候。你可以登入、查看媒體庫、變更設定，以及建立或還原 backup。搜尋、新增、重新整理、下載和匯入要等到下次正常啟動才會進行。

開啟 Settings > Danger zone（設定 > 危險區域）。
按下 Restart in safe mode（以安全模式重新啟動）。你應該會在每一頁看到一個橫幅。
修好問題，然後按下 Restart HolyArrs（重新啟動 HolyArrs）。下一次啟動就是正常的。

如果你進不了那個頁面，可以在 Compose 裡設定 HOLYARRS_SAFE_MODE=1，或用 -safe-mode 啟動。修好之後要移除：這兩種方式都會讓每次啟動都停在安全模式。

選項

功能區塊關閉時會停止什麼

功能區塊	停止	繼續運作
Movies	電影頁面和選單項目、新增、搜尋、重新整理	已經在你下載器裡的下載項目仍會被追蹤。檔案會保留。
TV shows	影集頁面、新增、搜尋、整季搜尋、重新整理	和 Movies 相同。
Music	藝人和專輯頁面、音樂設定、藝人重新整理、專輯搜尋	和 Movies 相同。
Subtitles	字幕設定、缺少字幕的頁面、搜尋和檢查	影片旁邊的字幕檔會保留。
Requests	請求頁面和請求作品	現有的請求會保留，重新開啟後就會回來。

一律開啟：登入與帳號、媒體庫資料夾、來源、下載器與下載項目、通知、歷史記錄、backup、健康檢查、設定和 API。

Subtitles 需要 Movies 或 TV shows。Requests 需要 Movies、TV shows 或 Music。如果某個變更會破壞這個條件，HolyArrs 會拒絕，並告訴你要先變更什麼。
已關閉的功能區塊如果有排隊中的工作，會等著，等該功能區塊開啟後再執行。
關閉功能區塊不會省記憶體。所有東西都在同一個程式裡執行。

重新啟動、暫停與關機

Settings > Danger zone（擁有者和管理員可用）有 Restart HolyArrs、Restart in safe mode 和 Shut down（關機），還有每個背景工作（例如 backup 或下載同步）各自的 Pause（暫停）、Resume（繼續）和 Restart。

會停止東西的控制項，會要求你在 60 秒內確認。
每一次使用的控制項，都會連同你的名字寫入歷史記錄。
你需要用密碼登入。在區域網路上不用密碼的登入會被拒絕。

重新啟動會讓 HolyArrs 乾淨地停止，再由 Docker 把它啟動起來，所以請設定 restart: unless-stopped。

重新啟動原則	重新啟動	關機
`unless-stopped` 或 `always`	會回來	也會回來
`on-failure`	會回來	維持關閉
`no`	維持關閉	維持關閉

如果沒有成功

症狀	原因	解決方式
HolyArrs 無法關閉某個功能區塊	另一個功能區塊需要它	照訊息說的，先關閉那個功能區塊。
重新啟動後 HolyArrs 就一直關著	重新啟動原則是 `no`	啟動 container，並設定 `restart: unless-stopped`。
控制項被拒絕	在區域網路上不用密碼登入，或金鑰沒有 `control`	用你的密碼登入。
某個工作一直是失敗	它需要你處理	在 `/health` 讀它的原因，修好後，按下該工作的 Restart。

更多解決方式：疑難排解。

給進階使用者

健康狀態

/health、Settings > Parts 和 GET /api/v1/health/states 會列出每個背景工作、功能區塊和已連結的 App，附上狀態和原因。

狀態	意思
off	已關閉、已暫停，或在安全模式下沒有啟動。
starting	啟動中，或還沒檢查。
running	正常運作。
retrying	失敗了；HolyArrs 會再試，每次等得更久。
failed	當機、卡住或需要你處理。原因會說明要做什麼。

當機的工作會先顯示 failed，接著是 retrying，然後重新啟動。這段期間登入、媒體庫和 backup 都會持續運作。卡住的工作要完整重新啟動才會清除。

記憶體與低記憶體模式

HolyArrs 的目標是維持在 384 MiB 以下，這樣可以放進 500 MB 的 container 上限。要設定你自己的目標，把 GOMEMLIMIT 設為 container 記憶體的約 80%。

低記憶體模式會在記憶體中保留較少的資料，更多從資料庫讀取。有些頁面會慢一點點，音樂目錄複製這類背景工作也會比較不頻繁地執行。

設定	效果
（預設，Linux）	記憶體約 2.5 GiB 以下時自動開啟。
`HOLYARRS_LOW_MEMORY=1`	一律開啟。
`HOLYARRS_LOW_MEMORY=0`	一律關閉。

第一行 log 會說明它是否開啟，以及原因。

API 金鑰的範圍

在 Settings > API > API keys 建立金鑰，並用 X-Api-Key 標頭送出。

範圍	可存取
`read`	媒體庫、工作、下載項目、歷史記錄、健康狀態、設定。機密會被遮蔽。
`health_read`	只有健康狀態。給監控工具用。
`write`	除了管理員路由和控制項之外的所有變更。
`admin`	人員、邀請、請求額度、API 金鑰、密碼與兩步驟驗證、登入設定、backup。
`control`	本頁的控制項。只有擁有者和管理員可以授予。
`all`	`read`、`write` 和 `admin`。不含 `control`。

金鑰的權限永遠不會超過建立它的人。範圍之後無法變更，請建立新的金鑰。每個路由和它的範圍：/api/v1/openapi.json。