功能模块和安全模式
设置
关掉你不用的功能模块,出问题时以安全模式启动,并从浏览器重启 HolyArrs。
开启或关闭功能模块
开启或关闭功能模块 的链接HolyArrs 有 5 个功能模块:Movies(电影)、TV shows(电视剧集)、Music(音乐)、Subtitles(字幕)和 Requests(请求)。你第一次选择它们是在首次运行的设置向导里。
- 打开 Settings > Parts(设置 > 功能模块)。
- 点击某个功能模块旁边的 Turn on(开启)或 Turn off(关闭)。你应该会看到它的菜单项出现或消失。
不会删除任何东西。重新开启功能模块后,它会从上次停下的地方继续。
以安全模式启动
以安全模式启动 的链接安全模式只启动最基本的部分,用在 HolyArrs 无法启动或无法正常工作的时候。你可以登录、看媒体库、改设置,以及做备份或恢复备份。搜索、添加、刷新、下载和导入要等到下一次正常启动。
- 打开 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 | 请求页面和提交请求 | 已有的请求保留,重新开启后会回来。 |
始终开启:登录和账户、媒体库文件夹、来源、下载器和下载任务、通知、历史记录、备份、健康检查、设置和 API。
- Subtitles 需要 Movies 或 TV shows。Requests 需要 Movies、TV shows 或 Music。会破坏这一点的改动,HolyArrs 会拒绝,并告诉你要先改什么。
- 排队中的后台任务如果属于已关闭的功能模块,会一直等着,功能模块开启后再运行。
- 关闭功能模块不会节省内存。所有东西都在同一个程序里运行。
重启、暂停和关闭
重启、暂停和关闭 的链接Settings > Danger zone(所有者和管理员可用)里有 Restart HolyArrs、Restart in safe mode 和 Shut down(关闭),另外每个后台任务(例如备份或下载同步)都有 Pause(暂停)、Resume(恢复使用)和 Restart(重启)。
- 会让某样东西停下来的控件,会要求你在 60 s 内确认。
- 每次使用控件都会连同你的名字记入历史记录。
- 需要用密码登录。在局域网里的免密码登录会被拒绝。
重启会先干净地停止 HolyArrs,再让 Docker 把它启动起来,所以请设置 restart: unless-stopped。
| 重启策略 | 重启 | 关闭 |
|---|---|---|
unless-stopped 或 always |
会重新启动 | 也会重新启动 |
on-failure |
会重新启动 | 保持停止 |
no |
保持停止 | 保持停止 |
如果不成功
如果不成功 的链接| 现象 | 原因 | 解决办法 |
|---|---|---|
| HolyArrs 关不掉某个功能模块 | 另一个功能模块需要它 | 按提示先关掉那个功能模块。 |
| 重启后 HolyArrs 彻底停了 | 重启策略是 no |
启动容器,并设置 restart: unless-stopped。 |
| 控件被拒绝 | 用的是局域网免密码登录,或者密钥没有 control |
用密码登录。 |
| 某个任务一直是 failed | 需要你来处理 | 在 /health 上看它的原因,解决后点击该任务的 Restart。 |
更多解决办法:故障排查。
进阶
进阶 的链接健康状态
/health、Settings > Parts 和 GET /api/v1/health/states 会列出每个后台任务、功能模块和关联应用,以及各自的状态和原因。
| 状态 | 含义 |
|---|---|
| off | 已关闭、已暂停,或在安全模式下没有启动。 |
| starting | 正在启动,或还没检查过。 |
| running | 正常工作。 |
| retrying | 失败了;HolyArrs 会重试,每次等待的时间更长。 |
| failed | 崩溃、卡住,或需要你来处理。原因里会写明该怎么做。 |
崩溃的任务会先显示 failed,再显示 retrying,然后重新启动。这期间登录、媒体库和备份照常工作。卡住的任务在完整重启后会恢复。
内存和低内存模式
HolyArrs 的目标是保持在 384 MiB 以内,这样能放进 500 MB 的容器内存限制。想自己定目标,就把 GOMEMLIMIT 设成容器内存的 80% 左右。
低内存模式会少占内存,多从数据库读取。有些页面会稍慢一点,音乐曲库副本这类后台工作也会运行得少一些。
| 设置 | 效果 |
|---|---|
| (默认,Linux) | 内存在 2.5 GiB 左右或更少时自动开启。 |
HOLYARRS_LOW_MEMORY=1 |
始终开启。 |
HOLYARRS_LOW_MEMORY=0 |
始终关闭。 |
日志的第一行会写明它是否开启以及原因。
API 密钥的范围
在 Settings > API > API keys(设置 > API > API 密钥)里创建密钥,然后放在 X-Api-Key 请求头里发送。
| 范围 | 能访问 |
|---|---|
read |
媒体库、后台任务、下载任务、历史记录、健康状况、设置。机密会被遮盖。 |
health_read |
只有健康状态。给监控工具用。 |
write |
除管理员路由和控件之外的所有改动。 |
admin |
用户、邀请、请求限额、API 密钥、密码和两步验证、登录设置、备份。 |
control |
本页上的控件。只有所有者和管理员能授予。 |
all |
read、write 和 admin。不含 control。 |
密钥能做的事永远不会超过创建它的人。范围之后不能改;请新建一个密钥。所有路由及其范围:/api/v1/openapi.json。
相关页面
相关页面 的链接HolyArrs 是免费的。如果它帮你省了时间,欢迎在 GitHub 上点个 Star、赞助它或请我喝杯咖啡。