Змінні середовища

Усі змінні, які читає контейнер 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.

Single Sign-On (SSO)

Задай їх до запуску. Якщо HOLYARRS_OIDC_ENABLED присутня взагалі, навіть зі значенням false, то Single Sign-On керується змінними середовища, а в налаштуваннях його лише видно. Перемикачі тут приймають тільки true або false; будь-що інше зупиняє запуск.

Змінна	Що робить	Типово
HOLYARRS_OIDC_ENABLED	Увімкнути Single Sign-On.	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.

Пов’язане

• Встановлення
• Запуск під шляхом
• Вхід і паролі