Lumaktaw sa nilalaman

Mga environment variable

Eksperto

Lahat ng variable na binabasa ng HolyArrs container. Sa karamihan ng install, PUID, PGID at TZ lang ang kailangang i-set.

Variable Ano ang ginagawa Default Halimbawa
PUID, PGID Ang user at group na gamit ng HolyArrs sa pagtakbo. Dapat sila ang owner ng /config at ng mga media folder mo. 1000, 1000 PUID=1000
TZ Time zone para sa mga iskedyul at log. Etc/UTC TZ=Europe/Amsterdam
UMASK Mga permission bit na hindi ibibigay sa mga bagong file. Mga bagong file lang ang apektado. 022 UMASK=002
HOLYARRS_SAVE_PATH Ang save folder ng downloader, ayon sa nakikita ng downloader. Ipinapadala kasama ng bawat download. wala /data/downloads
HOLYARRS_URL_BASE Ihain ang HolyArrs sa ilalim ng isang path sa likod ng reverse proxy. Binabalewala ng / ang path na naka-save sa Settings. wala /holyarrs
HOLYARRS_ALLOWED_HOSTS Mga dagdag na host name na ginagamit ng mga tao para maabot ang HolyArrs, pinaghihiwalay ng kuwit. mga IP at localhost holyarrs.example.com
HOLYARRS_TRUSTED_PROXIES Ang address o network ng reverse proxy mo, pinaghihiwalay ng kuwit. Kailangan ito para makuha ang tunay na address ng client. wala 172.18.0.0/16
HOLYARRS_MASTER_KEY_FILE Basahin ang master key ng vault mula sa sarili nitong file. Dapat mabasa ito ng PUID user. /config/holyarrs.key /keys/holyarrs.key

Ilagay ang FILE__ sa harap ng alinmang variable para basahin ang value nito mula sa isang file, tulad ng Docker secret.

environment:
- FILE__HOLYARRS_ALLOWED_HOSTS=/run/secrets/holyarrs_hosts

Tinatanggal ng HolyArrs ang isang newline sa dulo ng file. Kung wala ang file, titigil ang HolyArrs at ang log ang magsasabi ng pangalan ng variable at file, hindi kailanman ng value.

Variable Ano ang ginagawa Default Halimbawa
HOLYARRS_SAFE_MODE Simulan ang core lang: sign-in, Aklatan, settings, backup at kalusugan. Alisin ito kapag naayos na ang problema. off 1
HOLYARRS_LOW_MEMORY Pinipilit ng 1 na i-on ang mode na mababa ang memory, at ng 0 na i-off ito. Kapag hindi naka-set, nag-o-on ito sa mga 2.5 GiB ng RAM o mas mababa. ayon sa laki ng machine 1
HOLYARRS_FOLLOW_LINKS Pinapahintulutan ng 1 ang pag-scan ng Aklatan at mga import na gumamit ng video at music file na symlink (mga aklatang gawa sa mga link papunta sa naka-mount na drive). Ang naka-link na download ay inilalagay sa Aklatan bilang link. off 1
GOMEMLIMIT I-override ang memory target na itinatakda ng HolyArrs para sa sarili. itinakda ng HolyArrs 1GiB
HOLYARRS_SKIP_SPACE_CHECK Laktawan ang pagsusuri ng libreng espasyo bago ang update ng database. off yes
HOLYARRS_CONFIG_IN_MEMORY Payagan ang /config sa folder na nasa memory. Para sa mga test box; mawawala ang data sa restart. off yes
HOLYARRS_ALLOW_DESKTOP_FOLDER Simulan nang nasa shared folder ng Docker Desktop sa Mac ang /config, pagkatapos mong tiyaking gumagana roon ang file lock. Nagbababala ang HolyArrs sa bawat simula. off 1
HOLYARRS_READONLY_DOWNLOADERS Mga downloader na hindi dapat baguhin ng HolyArrs kailanman, ayon sa id o address, pinaghihiwalay ng kuwit. wala 3,http://qbit:8080
HOLYARRS_HEALTH_URL Address na tinatawagan ng health check ng container. http://127.0.0.1:6262 http://127.0.0.1:6262/holyarrs

Ang mga on/off variable ay tumatanggap ng 1, true, yes o on.

I-set ang mga ito bago magsimula. Kung may HOLYARRS_OIDC_ENABLED sa kahit anong anyo, kahit na false, ang environment na ang may hawak ng single sign-on at ipinapakita lang ito ng Settings. Ang mga on/off dito ay true o false lang ang tinatanggap; ang anumang iba ay hihinto sa pagsisimula.

Variable Ano ang ginagawa Default
HOLYARRS_OIDC_ENABLED I-on ang single sign-on. false
HOLYARRS_OIDC_ISSUER Ang eksaktong HTTPS issuer ng provider. wala
HOLYARRS_OIDC_CLIENT_ID Nakarehistrong client id. wala
HOLYARRS_OIDC_CLIENT_SECRET_FILE File na may client secret, hanggang 4096 byte. Huwag lagyan para sa public client. wala
HOLYARRS_OIDC_REDIRECT_URL Eksaktong callback: ang address mo, URL base kung mayroon, tapos /api/v1/auth/oidc/callback. wala
HOLYARRS_OIDC_ALLOW_JOIN Sumasali ang mga bagong tao bilang mga miyembrong makakahiling lang. false
HOLYARRS_OIDC_ALLOW_LOCAL_NETWORK Payagan ang provider sa pribadong network mo. false
HOLYARRS_OIDC_ALLOW_LOOPBACK_HTTP Payagan ang plain HTTP sa machine na ito, para sa pagsubok. false
HOLYARRS_FORWARD_AUTH_ENABLED I-on ang sign-in sa pamamagitan ng pinagkakatiwalaang proxy. false
HOLYARRS_FORWARD_AUTH_ISSUER Matatag na HTTPS na pangalan para sa proxy. wala
HOLYARRS_FORWARD_AUTH_TRUSTED_PEERS Mga address o range ng proxy na pinapayagang magpadala ng identity header, pinaghihiwalay ng kuwit. wala
HOLYARRS_FORWARD_AUTH_ALLOW_JOIN Sumasali ang mga bagong pangalan mula sa proxy bilang mga miyembrong makakahiling lang. false

Kapag mali ang setup, hindi magsisimula ang HolyArrs. Nasa Sign-in at mga password ang mga hakbang.

Metadata
Variable Ano ang ginagawa Default
HOLYARRS_METADATA_URL Ang address ng metadata server. https://api.holyarrs.com
HOLYARRS_TMDB_KEY Ang sarili mong TMDB read access token. Kapag naka-set, diretso sa TMDB ang mga pagbasa ng TMDB sa halip na sa metadata server. wala
HOLYARRS_METADATA_SERVICE_TOKEN_FILE File na may credential ng install na ito para sa metadata server, binabasa sa bawat tawag. Kapag hindi naka-set, nasa vault ang credential. wala

Nasa Mga panlabas na address kung ano pa ang dumadaan sa metadata server kahit may sarili kang TMDB key, at ang bawat iba pang panlabas na address.

Mga shortcut sa unang simula

Bawat isa ay nagdaragdag ng isang item sa simula. Ginagamit para sa mga demo at test; ganito rin ang ginagawa ng wizard sa unang takbo.

Variable Idinaragdag
HOLYARRS_MOVIES Isang folder ng Aklatan para sa pelikula.
HOLYARRS_QBITTORRENT_URL Isang qBittorrent downloader.
HOLYARRS_SOURCE_URL Isang Pinagkukunang Torznab na walang key.
Mga variable para sa developer at test

Itinuturo ng mga ito ang HolyArrs sa mga panghalili para sa mga test. Huwag i-set sa tunay na install.

Variable Ano ang ginagawa
HOLYARRS_FLAGS Mga switch na pinaghihiwalay ng kuwit para sa mga tampok na hindi pa bukas sa bersyong ito. Tingnan ang Mga update.
HOLYARRS_DIRECT_SOURCES Pinapahintulutan ng 1 ang install na ito na direktang magtanong sa mga Pinagkukunan ng musika at TV sa halip na sa metadata server.
HOLYARRS_METADATA_SERVICE_ALLOW_LOCAL Payagan ang metadata server sa lokal na network.
HOLYARRS_METADATA_COUNT Bilangin at i-log ang mga request sa metadata.
HOLYARRS_TMDB_TOKEN_FILE, HOLYARRS_TMDB_URL Test na file ng TMDB token at address na panghalili.
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 Mga address na panghalili para sa mga serbisyo sa labas.
HOLYARRS_TRAILER_PASS_FIRST, HOLYARRS_TRAILER_PASS_EVERY Oras ng trailer pass bilang mga duration, gaya ng 2s.

Libre ang HolyArrs. Kung nakatipid ito ng oras mo, bigyan ito ng star sa GitHub, i-sponsor ito o ibili ako ng kape.