Variables d'entorn

Totes les variables que llegeix el contenidor d’HolyArrs. A la majoria d’instal·lacions només cal definir PUID, PGID i TZ.

Habituals

Variable	Què fa	Per defecte	Exemple
PUID, PGID	Usuari i grup amb què s’executa HolyArrs. Ha de ser el propietari de /config i de les teves carpetes multimèdia.	1000, 1000	PUID=1000
TZ	Fus horari per a les programacions i els registres.	Etc/UTC	TZ=Europe/Amsterdam
UMASK	Bits de permís que els fitxers nous no reben. Afecta només els fitxers nous.	022	UMASK=002
HOLYARRS_SAVE_PATH	La carpeta on desa el gestor de baixades, tal com la veu el gestor. S’envia amb cada baixada.	cap	/data/downloads
HOLYARRS_URL_BASE	Serveix HolyArrs sota una ruta darrere d’un reverse proxy. / ignora la ruta desada als Paràmetres.	cap	/holyarrs
HOLYARRS_ALLOWED_HOSTS	Noms de host addicionals que la gent fa servir per arribar a HolyArrs, separats per comes.	IPs i localhost	holyarrs.example.com
HOLYARRS_TRUSTED_PROXIES	L’adreça o la xarxa del teu reverse proxy, separades per comes. Cal per veure les adreces reals dels clients.	cap	172.18.0.0/16
HOLYARRS_MASTER_KEY_FILE	Llegeix la clau mestra de la caixa forta des del seu propi fitxer. L’usuari de PUID l’ha de poder llegir.	/config/holyarrs.key	/keys/holyarrs.key

Valors des de fitxers

Posa FILE__ davant de qualsevol variable per llegir-ne el valor d’un fitxer, com un secret de Docker.

environment:
  - FILE__HOLYARRS_ALLOWED_HOSTS=/run/secrets/holyarrs_hosts

HolyArrs treu un salt de línia del final del fitxer. Si el fitxer no hi és, HolyArrs s’atura i el registre (log) en diu la variable i el fitxer, però mai el valor.

Recuperació i resolució de problemes

Variable	Què fa	Per defecte	Exemple
HOLYARRS_SAFE_MODE	Inicia només el nucli: inici de sessió, Biblioteca, paràmetres, còpies de seguretat i salut. Treu-la quan ho hagis arreglat.	desactivat	1
HOLYARRS_LOW_MEMORY	1 força el mode de poca memòria, 0 el desactiva. Sense definir, s’activa amb uns 2.5 GiB de RAM o menys.	segons l’equip	1
HOLYARRS_FOLLOW_LINKS	1 deixa que l’exploració de la Biblioteca i les importacions facin servir fitxers de vídeo i música que siguin enllaços simbòlics (biblioteques fetes amb enllaços cap a un disc muntat). Una baixada enllaçada es posa a la Biblioteca com a enllaç.	desactivat	1
GOMEMLIMIT	Substitueix l’objectiu de memòria que HolyArrs es fixa ell mateix.	el fixa HolyArrs	1GiB
HOLYARRS_SKIP_SPACE_CHECK	Omet la comprovació d’espai lliure abans d’actualitzar la base de dades.	desactivat	yes
HOLYARRS_CONFIG_IN_MEMORY	Permet /config en una carpeta a la memòria. Per a equips de prova; les dades es perden en reiniciar.	desactivat	yes
HOLYARRS_ALLOW_DESKTOP_FOLDER	Inicia amb /config en una carpeta compartida de Docker Desktop en un Mac, després de comprovar que els bloquejos de fitxers hi funcionen. HolyArrs t’avisa a cada inici.	desactivat	1
HOLYARRS_READONLY_DOWNLOADERS	Gestors de baixades que HolyArrs no ha de canviar mai, per id o adreça, separats per comes.	cap	3,http://qbit:8080
HOLYARRS_HEALTH_URL	Adreça a la qual truca la comprovació de salut del contenidor.	http://127.0.0.1:6262	http://127.0.0.1:6262/holyarrs

Les variables d’activar i desactivar accepten 1, true, yes o on.

Inici de sessió únic

Defineix-les abans d’iniciar. Si HOLYARRS_OIDC_ENABLED hi és, encara que sigui amb false, l’entorn mana sobre l’inici de sessió únic (SSO) i els Paràmetres només el mostren. Aquí, les d’activar i desactivar accepten només true o false; qualsevol altra cosa atura l’inici.

Variable	Què fa	Per defecte
HOLYARRS_OIDC_ENABLED	Activa l’inici de sessió únic.	false
HOLYARRS_OIDC_ISSUER	L’emissor HTTPS exacte del proveïdor.	cap
HOLYARRS_OIDC_CLIENT_ID	L’id del client registrat.	cap
HOLYARRS_OIDC_CLIENT_SECRET_FILE	Fitxer amb el secret del client, de 4096 bytes com a màxim. Deixa-ho en blanc per a un client públic.	cap
HOLYARRS_OIDC_REDIRECT_URL	La crida de retorn exacta: la teva adreça, la URL base si n’hi ha, i després /api/v1/auth/oidc/callback.	cap
HOLYARRS_OIDC_ALLOW_JOIN	Les persones noves s’hi uneixen com a membres que només poden demanar.	false
HOLYARRS_OIDC_ALLOW_LOCAL_NETWORK	Permet un proveïdor a la teva xarxa privada.	false
HOLYARRS_OIDC_ALLOW_LOOPBACK_HTTP	Permet HTTP sense xifrar en aquest equip, per fer proves.	false
HOLYARRS_FORWARD_AUTH_ENABLED	Activa l’inici de sessió de confiança pel proxy.	false
HOLYARRS_FORWARD_AUTH_ISSUER	Nom HTTPS estable per al proxy.	cap
HOLYARRS_FORWARD_AUTH_TRUSTED_PEERS	Adreces o intervals del proxy que poden enviar capçaleres d’identitat, separats per comes.	cap
HOLYARRS_FORWARD_AUTH_ALLOW_JOIN	Els noms nous del proxy s’hi uneixen com a membres que només poden demanar.	false

Una configuració incorrecta impedeix que HolyArrs s’iniciï. Els passos són a Inici de sessió i contrasenyes.

Per a experts

Metadades

Variable	Què fa	Per defecte
HOLYARRS_METADATA_URL	L’adreça del servidor de metadades.	https://api.holyarrs.com
HOLYARRS_TMDB_KEY	El teu propi token d’accés de lectura de TMDB. Si el defineixes, les lectures de TMDB van directes a TMDB en lloc del servidor de metadades.	cap
HOLYARRS_METADATA_SERVICE_TOKEN_FILE	Fitxer amb la credencial d’aquesta instal·lació per al servidor de metadades, que es llegeix a cada crida. Si no el defineixes, la credencial és a la caixa forta.	cap

Què continua passant pel servidor de metadades amb la teva pròpia clau de TMDB, i totes les altres adreces externes, és a Adreces externes.

Dreceres del primer inici

Cadascuna afegeix un element a l’inici. Serveixen per a demostracions i proves; l’assistent del primer inici fa el mateix.

Variable	Afegeix
HOLYARRS_MOVIES	Una carpeta de la Biblioteca per a pel·lícules.
HOLYARRS_QBITTORRENT_URL	Un gestor de baixades qBittorrent.
HOLYARRS_SOURCE_URL	Una Font Torznab sense clau.

Variables per a desenvolupament i proves

Fan que HolyArrs apunti a substituts per fer proves. Deixa-les sense definir en una instal·lació real.

Variable	Què fa
HOLYARRS_FLAGS	Interruptors separats per comes per a funcions desactivades per defecte en aquesta versió. Mira Actualitzacions.
HOLYARRS_DIRECT_SOURCES	1 deixa que aquesta instal·lació consulti ella mateixa les fonts de música i de sèries en lloc del servidor de metadades.
HOLYARRS_METADATA_SERVICE_ALLOW_LOCAL	Permet un servidor de metadades a la xarxa local.
HOLYARRS_METADATA_COUNT	Compta i registra les peticions de metadades.
HOLYARRS_TMDB_TOKEN_FILE, HOLYARRS_TMDB_URL	Fitxer de token de TMDB de prova i adreça substituta.
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	Adreces substitutes per a serveis externs.
HOLYARRS_TRAILER_PASS_FIRST, HOLYARRS_TRAILER_PASS_EVERY	Temps de la passada de tràilers en durades, com 2s.

Relacionat

• Instal·lar
• Executar sota una ruta
• Inici de sessió i contrasenyes