Aller au contenu

Variables d'environnement

Expert

Toutes les variables que le conteneur HolyArrs lit. La plupart des installations ne définissent que PUID, PGID et TZ.

Variable Ce que ça fait Valeur par défaut Exemple
PUID, PGID Utilisateur et groupe sous lesquels HolyArrs tourne. Ils doivent être propriétaires de /config et de vos dossiers multimédias. 1000, 1000 PUID=1000
TZ Fuseau horaire des planifications et des journaux. Etc/UTC TZ=Europe/Amsterdam
UMASK Bits de permission retirés aux nouveaux fichiers. Ne touche que les nouveaux fichiers. 022 UMASK=002
HOLYARRS_SAVE_PATH Le dossier d’enregistrement du client de téléchargement, tel que le client le voit. Envoyé avec chaque téléchargement. aucune /data/downloads
HOLYARRS_URL_BASE Sert HolyArrs sous un chemin, derrière un reverse proxy. / ignore un chemin enregistré dans Settings (Paramètres). aucune /holyarrs
HOLYARRS_ALLOWED_HOSTS Noms d’hôte supplémentaires utilisés pour joindre HolyArrs, séparés par des virgules. les IP et localhost holyarrs.example.com
HOLYARRS_TRUSTED_PROXIES L’adresse ou le réseau de votre reverse proxy, séparés par des virgules. Nécessaire pour obtenir les vraies adresses des clients. aucune 172.18.0.0/16
HOLYARRS_MASTER_KEY_FILE Lit la clé maîtresse du coffre dans son propre fichier. L’utilisateur PUID doit pouvoir le lire. /config/holyarrs.key /keys/holyarrs.key

Valeurs lues dans des fichiers

Lien vers Valeurs lues dans des fichiers

Ajoutez FILE__ devant n’importe quelle variable pour lire sa valeur dans un fichier, par exemple un secret Docker.

environment:
- FILE__HOLYARRS_ALLOWED_HOSTS=/run/secrets/holyarrs_hosts

HolyArrs retire un seul saut de ligne à la fin du fichier. Si le fichier est absent, HolyArrs s’arrête et le journal nomme la variable et le fichier, jamais la valeur.

Récupération et dépannage

Lien vers Récupération et dépannage
Variable Ce que ça fait Valeur par défaut Exemple
HOLYARRS_SAFE_MODE Ne démarre que le cœur : connexion, Bibliothèque, paramètres, sauvegardes et état de santé. Supprimez-la une fois le problème réglé. désactivé 1
HOLYARRS_LOW_MEMORY 1 force le mode mémoire réduite, 0 l’interdit. Sans valeur, il s’active à environ 2,5 Gio de RAM ou moins. selon la taille de la machine 1
GOMEMLIMIT Remplace la cible de mémoire que HolyArrs se fixe lui-même. fixée par HolyArrs 1GiB
HOLYARRS_SKIP_SPACE_CHECK Saute le contrôle d’espace libre avant une mise à jour de la base de données. désactivé yes
HOLYARRS_CONFIG_IN_MEMORY Autorise /config sur un dossier stocké en mémoire. Pour les machines de test ; les données sont perdues au redémarrage. désactivé yes
HOLYARRS_ALLOW_DESKTOP_FOLDER Démarre avec /config dans un dossier partagé de Docker Desktop sur un Mac, une fois que vous avez vérifié que les verrous de fichiers y fonctionnent. HolyArrs avertit à chaque démarrage. désactivé 1
HOLYARRS_READONLY_DOWNLOADERS Clients de téléchargement que HolyArrs ne doit jamais modifier, par id ou par adresse, séparés par des virgules. aucune 3,http://qbit:8080
HOLYARRS_HEALTH_URL Adresse appelée par le contrôle de santé du conteneur. http://127.0.0.1:6262 http://127.0.0.1:6262/holyarrs

Les variables activé/désactivé acceptent 1, true, yes ou on.

Authentification unique (SSO)

Lien vers Authentification unique (SSO)

Définissez-les avant le démarrage. Dès que HOLYARRS_OIDC_ENABLED est présente, même à false, c’est l’environnement qui gère l’authentification unique et Settings se contente de l’afficher. Ici, les variables activé/désactivé n’acceptent que true ou false ; toute autre valeur bloque le démarrage.

Variable Ce que ça fait Valeur par défaut
HOLYARRS_OIDC_ENABLED Active l’authentification unique. false
HOLYARRS_OIDC_ISSUER L’émetteur HTTPS exact du fournisseur. aucune
HOLYARRS_OIDC_CLIENT_ID L’id client enregistré. aucune
HOLYARRS_OIDC_CLIENT_SECRET_FILE Fichier qui contient le secret client, 4096 octets au plus. À omettre pour un client public. aucune
HOLYARRS_OIDC_REDIRECT_URL L’adresse de retour exacte : votre adresse, l’URL de base s’il y en a une, puis /api/v1/auth/oidc/callback. aucune
HOLYARRS_OIDC_ALLOW_JOIN Les nouvelles personnes arrivent comme membres qui peuvent seulement demander. false
HOLYARRS_OIDC_ALLOW_LOCAL_NETWORK Autorise un fournisseur sur votre réseau privé. false
HOLYARRS_OIDC_ALLOW_LOOPBACK_HTTP Autorise le HTTP simple sur cette machine, pour les tests. false
HOLYARRS_FORWARD_AUTH_ENABLED Active la connexion par proxy de confiance. false
HOLYARRS_FORWARD_AUTH_ISSUER Nom HTTPS stable du proxy. aucune
HOLYARRS_FORWARD_AUTH_TRUSTED_PEERS Adresses ou plages de proxy autorisées à envoyer des en-têtes d’identité, séparées par des virgules. aucune
HOLYARRS_FORWARD_AUTH_ALLOW_JOIN Les nouveaux noms venus du proxy arrivent comme membres qui peuvent seulement demander. false

Une mauvaise configuration empêche HolyArrs de démarrer. Les étapes sont dans Connexion et mots de passe.

Métadonnées
Variable Ce que ça fait Valeur par défaut
HOLYARRS_METADATA_URL L’adresse du serveur de métadonnées. https://api.holyarrs.com
HOLYARRS_TMDB_KEY Votre propre jeton d’accès en lecture TMDB. Si elle est définie, les lectures TMDB vont directement chez TMDB au lieu de passer par le serveur de métadonnées. aucune
HOLYARRS_METADATA_SERVICE_TOKEN_FILE Fichier qui contient l’identifiant de cette installation pour le serveur de métadonnées, lu à chaque appel. Sans elle, l’identifiant reste dans le coffre. aucune
Raccourcis de premier démarrage

Chacune ajoute un élément au démarrage. Elles servent aux démos et aux tests ; l’assistant de premier lancement fait la même chose.

Variable Ajoute
HOLYARRS_MOVIES Un dossier de bibliothèque pour les films.
HOLYARRS_QBITTORRENT_URL Un client de téléchargement qBittorrent.
HOLYARRS_SOURCE_URL Une source Torznab sans clé.
Variables de développement et de test

Elles dirigent HolyArrs vers des substituts pour les tests. Ne les définissez pas sur une vraie installation.

Variable Ce que ça fait
HOLYARRS_FLAGS Interrupteurs, séparés par des virgules, pour les fonctionnalités désactivées par défaut dans cette version. Voir Mises à jour.
HOLYARRS_DIRECT_SOURCES 1 laisse cette installation interroger elle-même les sources de musique et de séries, sans passer par le serveur de métadonnées.
HOLYARRS_METADATA_SERVICE_ALLOW_LOCAL Autorise un serveur de métadonnées sur le réseau local.
HOLYARRS_METADATA_COUNT Compte les demandes de métadonnées et les écrit dans le journal.
HOLYARRS_TMDB_TOKEN_FILE, HOLYARRS_TMDB_URL Fichier de jeton TMDB de test et adresse de substitution.
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 Adresses de substitution pour les services externes.
HOLYARRS_TRAILER_PASS_FIRST, HOLYARRS_TRAILER_PASS_EVERY Cadence du passage des bandes-annonces, sous forme de durées, par exemple 2s.

HolyArrs est gratuit. S'il vous a fait gagner du temps, mettez-lui une étoile sur GitHub, sponsorisez-le ou offrez-moi un café.