Переменные окружения

Для опытных

Все переменные, которые читает контейнер 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.

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`	Запускаться, когда `/config` лежит в общей папке Docker Desktop на Mac. Сначала проверьте, что блокировки файлов там работают. 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.

Единый вход (SSO)

Задайте их до запуска. Если 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 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`	Включить вход через доверенный прокси.	`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_MOVIES`	Папку Медиатеки для фильмов.
`HOLYARRS_QBITTORRENT_URL`	Загрузчик qBittorrent.
`HOLYARRS_SOURCE_URL`	Источник Torznab без ключа.

Переменные для разработки и тестов

Они направляют 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`.

См. также

HolyArrs бесплатен. Если он сэкономил вам время, поставьте звезду на GitHub, станьте спонсором или угостите меня кофе.