环境变量

进阶

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 放在某个路径下提供访问。设为 `/` 会忽略 Settings 里保存的路径。	无	`/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 会去掉文件末尾的一个换行符。如果文件不存在，HolyArrs 会停止，日志里会写出变量名和文件名，但不会写出值。

变量	作用	默认	示例
`HOLYARRS_SAFE_MODE`	只启动核心部分：登录、媒体库、设置、备份和健康状况。修好之后把它删掉。	关	`1`
`HOLYARRS_LOW_MEMORY`	`1` 强制打开低内存模式，`0` 强制关闭。不设置时，内存在 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，单点登录就由环境变量接管，Settings 里只能看不能改。这里的开关类变量只接受 true 或 false，其他值都会让启动中止。

变量	作用	默认
`HOLYARRS_OIDC_ENABLED`	打开单点登录。	`false`
`HOLYARRS_OIDC_ISSUER`	提供方的 HTTPS issuer，必须完全一致。	无
`HOLYARRS_OIDC_CLIENT_ID`	注册好的 client id。	无
`HOLYARRS_OIDC_CLIENT_SECRET_FILE`	存放 client secret 的文件，最多 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`	存放这个安装的元数据服务器凭据的文件，每次调用时读取。不设置时，凭据存在保险库里。	无

首次启动的快捷方式

每个变量在启动时添加一项。用于演示和测试；首次运行的设置向导做的是同样的事。

开发和测试变量

这些变量让 HolyArrs 连到测试用的替身服务。正式安装不要设置。

变量	作用
`HOLYARRS_FLAGS`	用逗号分隔的开关，对应这个版本里默认关闭的功能。见更新。
`HOLYARRS_DIRECT_SOURCES`	设为 `1` 时，这个安装自己去问音乐和电视数据的来源，不经过元数据服务器。
`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`。