Umgebungsvariablen

Fortgeschritten

Jede Variable, die der HolyArrs-Container liest. Die meisten Installationen setzen nur PUID, PGID und TZ.

Häufig gebraucht

Variable	Was sie tut	Standard	Beispiel
`PUID`, `PGID`	Benutzer und Gruppe, unter denen HolyArrs läuft. Ihnen müssen `/config` und deine Medienordner gehören.	`1000`, `1000`	`PUID=1000`
`TZ`	Zeitzone für Zeitpläne und Logs.	`Etc/UTC`	`TZ=Europe/Amsterdam`
`UMASK`	Berechtigungsbits, die neue Dateien nicht bekommen. Wirkt nur auf neue Dateien.	`022`	`UMASK=002`
`HOLYARRS_SAVE_PATH`	Der Speicherordner des Downloaders, so wie der Downloader ihn sieht. Wird mit jedem Download mitgeschickt.	keiner	`/data/downloads`
`HOLYARRS_URL_BASE`	Stellt HolyArrs hinter einem Reverse Proxy unter einem Pfad bereit. `/` ignoriert einen Pfad, der in den Einstellungen gespeichert ist.	keiner	`/holyarrs`
`HOLYARRS_ALLOWED_HOSTS`	Weitere Hostnamen, über die HolyArrs erreicht wird, durch Kommas getrennt.	IPs und `localhost`	`holyarrs.example.com`
`HOLYARRS_TRUSTED_PROXIES`	Adresse oder Netzwerk deines Reverse Proxy, durch Kommas getrennt. Nötig für die echten Adressen der Clients.	keiner	`172.18.0.0/16`
`HOLYARRS_MASTER_KEY_FILE`	Liest den Hauptschlüssel des Tresors aus einer eigenen Datei. Der `PUID`-Benutzer muss sie lesen können.	`/config/holyarrs.key`	`/keys/holyarrs.key`

Werte aus Dateien

Setze FILE__ vor eine beliebige Variable, um ihren Wert aus einer Datei zu lesen, etwa aus einem Docker-Secret.

environment:
  - FILE__HOLYARRS_ALLOWED_HOSTS=/run/secrets/holyarrs_hosts

HolyArrs entfernt einen Zeilenumbruch am Ende der Datei. Fehlt die Datei, stoppt HolyArrs, und das Log nennt die Variable und die Datei, nie den Wert.

Wiederherstellung und Fehlerbehebung

Variable	Was sie tut	Standard	Beispiel
`HOLYARRS_SAFE_MODE`	Startet nur den Kern: Anmeldung, Bibliothek, Einstellungen, Backups und Zustand. Entferne sie, sobald das Problem behoben ist.	aus	`1`
`HOLYARRS_LOW_MEMORY`	`1` erzwingt den Modus für wenig Arbeitsspeicher, `0` schaltet ihn fest aus. Ohne Wert schaltet er sich bei etwa 2.5 GiB RAM oder weniger ein.	je nach Größe des Rechners	`1`
`GOMEMLIMIT`	Überschreibt das Arbeitsspeicherziel, das HolyArrs sich selbst setzt.	von HolyArrs gesetzt	`1GiB`
`HOLYARRS_SKIP_SPACE_CHECK`	Überspringt die Prüfung des freien Speicherplatzes vor einem Datenbank-Update.	aus	`yes`
`HOLYARRS_CONFIG_IN_MEMORY`	Erlaubt `/config` in einem Ordner, der im Arbeitsspeicher liegt. Für Testrechner; beim Neustart gehen die Daten verloren.	aus	`yes`
`HOLYARRS_ALLOW_DESKTOP_FOLDER`	Startet mit `/config` in einem freigegebenen Ordner von Docker Desktop auf einem Mac, nachdem du geprüft hast, dass Dateisperren dort funktionieren. HolyArrs warnt bei jedem Start.	aus	`1`
`HOLYARRS_READONLY_DOWNLOADERS`	Downloader, die HolyArrs nie ändern darf, nach ID oder Adresse, durch Kommas getrennt.	keiner	`3,http://qbit:8080`
`HOLYARRS_HEALTH_URL`	Adresse, die die Zustandsprüfung des Containers aufruft.	`http://127.0.0.1:6262`	`http://127.0.0.1:6262/holyarrs`

Ein/Aus-Variablen akzeptieren 1, true, yes oder on.

Single Sign-on

Setze diese vor dem Start. Sobald HOLYARRS_OIDC_ENABLED überhaupt vorhanden ist, auch als false, bestimmt die Umgebung über Single Sign-on, und die Einstellungen zeigen es nur an. Die Ein/Aus-Variablen hier nehmen nur true oder false; alles andere bricht den Start ab.

Variable	Was sie tut	Standard
`HOLYARRS_OIDC_ENABLED`	Schaltet Single Sign-on ein.	`false`
`HOLYARRS_OIDC_ISSUER`	Der genaue HTTPS-Issuer des Anbieters.	keiner
`HOLYARRS_OIDC_CLIENT_ID`	Registrierte Client-ID.	keiner
`HOLYARRS_OIDC_CLIENT_SECRET_FILE`	Datei mit dem Client-Secret, höchstens 4096 Bytes. Bei einem öffentlichen Client weglassen.	keiner
`HOLYARRS_OIDC_REDIRECT_URL`	Genauer Callback: deine Adresse, die URL base, falls vorhanden, dann `/api/v1/auth/oidc/callback`.	keiner
`HOLYARRS_OIDC_ALLOW_JOIN`	Neue Personen kommen als Mitglieder dazu, die nur anfragen können.	`false`
`HOLYARRS_OIDC_ALLOW_LOCAL_NETWORK`	Erlaubt einen Anbieter in deinem privaten Netzwerk.	`false`
`HOLYARRS_OIDC_ALLOW_LOOPBACK_HTTP`	Erlaubt unverschlüsseltes HTTP auf diesem Rechner, zum Testen.	`false`
`HOLYARRS_FORWARD_AUTH_ENABLED`	Schaltet die Anmeldung über einen vertrauenswürdigen Proxy ein.	`false`
`HOLYARRS_FORWARD_AUTH_ISSUER`	Fester HTTPS-Name für den Proxy.	keiner
`HOLYARRS_FORWARD_AUTH_TRUSTED_PEERS`	Proxy-Adressen oder -Bereiche, die Identitäts-Header senden dürfen, durch Kommas getrennt.	keiner
`HOLYARRS_FORWARD_AUTH_ALLOW_JOIN`	Neue Namen vom Proxy kommen als Mitglieder dazu, die nur anfragen können.	`false`

Bei einer fehlerhaften Einrichtung startet HolyArrs nicht. Die Schritte stehen unter Anmeldung und Passwörter.

Für Fortgeschrittene

Metadaten

Variable	Was sie tut	Standard
`HOLYARRS_METADATA_URL`	Die Adresse des Metadaten-Servers.	`https://api.holyarrs.com`
`HOLYARRS_TMDB_KEY`	Dein eigenes TMDB-Token für Lesezugriff. Ist es gesetzt, gehen TMDB-Abfragen direkt an TMDB statt an den Metadaten-Server.	keiner
`HOLYARRS_METADATA_SERVICE_TOKEN_FILE`	Datei mit den Zugangsdaten dieser Installation für den Metadaten-Server, bei jedem Aufruf neu gelesen. Ohne Wert liegen die Zugangsdaten im Tresor.	keiner

Abkürzungen für den ersten Start

Jede fügt beim Start einen Eintrag hinzu. Gedacht für Demos und Tests; der Assistent beim ersten Start macht dasselbe.

Variable	Fügt hinzu
`HOLYARRS_MOVIES`	Einen Bibliotheksordner für Filme.
`HOLYARRS_QBITTORRENT_URL`	Einen qBittorrent-Downloader.
`HOLYARRS_SOURCE_URL`	Eine Torznab-Quelle ohne Schlüssel.

Variablen für Entwickler und Tests

Sie lenken HolyArrs für Tests auf Ersatzserver um. Lass sie bei einer echten Installation ungesetzt.

Variable	Was sie tut
`HOLYARRS_FLAGS`	Durch Kommas getrennte Schalter für Funktionen, die in dieser Version standardmäßig aus sind. Siehe Updates.
`HOLYARRS_DIRECT_SOURCES`	Mit `1` fragt diese Installation die Musik- und Serien-Datenquellen selbst ab statt über den Metadaten-Server.
`HOLYARRS_METADATA_SERVICE_ALLOW_LOCAL`	Erlaubt einen Metadaten-Server im lokalen Netzwerk.
`HOLYARRS_METADATA_COUNT`	Zählt Metadaten-Anfragen und schreibt sie ins Log.
`HOLYARRS_TMDB_TOKEN_FILE`, `HOLYARRS_TMDB_URL`	Datei mit einem TMDB-Token für Tests und Ersatzadresse.
`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`	Ersatzadressen für externe Dienste.
`HOLYARRS_TRAILER_PASS_FIRST`, `HOLYARRS_TRAILER_PASS_EVERY`	Zeitabstände des Trailer-Durchlaufs als Dauer, etwa `2s`.