Import kľúčov zo súboru

Vyplň jeden súbor so svojimi zdrojmi, sťahovačmi, mediálnymi servermi, stránkami s titulkami a poštou, importuj ho a nemusíš zadávať každý kľúč v nastaveniach.

Skôr než začneš

• HolyArrs beží v Dockeri s konfiguráciou v /config.
• Kľúč API vlastníka môžeš vytvoriť v Settings > API > API keys (nastavenia > API > kľúče API).

Importuj súbor

1. Skopíruj holyarrs-secrets.template.yaml do holyarrs-secrets.yaml.

2. Vyplň to, čo používaš. Zvyšok nechaj prázdny; prázdne znamená preskočiť.

3. Nastav, aby ho mohol čítať iba ty:

   chmod 600 holyarrs-secrets.yaml

4. Pripoj ho do kontajnera iba na čítanie:

   volumes:
     - /srv/holyarrs/config:/config
     - /srv/holyarrs/holyarrs-secrets.yaml:/run/secrets/holyarrs.yaml:ro

5. Vytvor v Settings > API > API keys kľúč API vlastníka s rozsahom admin. Vlož ho do bloku holyarrs v súbore s adresou http://127.0.0.1:6262.

6. Najprv spusti skúšobný beh. Nič nemení:

   docker exec holyarrs /holyarrs import-secrets -file /run/secrets/holyarrs.yaml -dry-run

   Mal by si vidieť jeden riadok would set na každú položku.

7. Spusti to naozaj (ten istý príkaz bez -dry-run). Mal by si vidieť riadky set a kód ukončenia 0.

8. Skontroluj nové zdroje a sťahovače a potom ich obnov (Resume, pokračovať). Otestuj nové mediálne servery a upozornenia a potom ich zapni.

9. Vymaž súbor na hostiteľovi (pozri Vymaž súbor). Ak kľúč API už nepotrebuješ, vymaž aj ten.

Upozornenie

Súbor drží všetky tajomstvá v čistom texte, kým ho nevymažeš. Vymaž ho na hostiteľovi hneď po úspešnom behu.

Čím sa stane každý blok

V súbore	Stane sa
trakt.client_id	Kľúč aplikácie Trakt (Settings > Outside lists, nastavenia > externé zoznamy).
tmdb, tvdb	Prijíma sa zo starších súborov. Metadáta kľúče nepotrebujú.
opensubtitles, subdl	Stránka s titulkami s tvojím účtom.
addic7ed	Stránka s titulkami Addic7ed, iba seriály.
indexers	Jeden zdroj na každú položku, paused (pozastavený).
jackett, prowlarr	Ich kľúč doplní každú položku indexers na rovnakej adrese, ktorá kľúč nemá.
qbittorrent, sabnzbd	Sťahovač, paused.
nzbget, transmission, deluge	Preskočené. Import ich zatiaľ nevie nastaviť; pridaj ich v Settings > Downloaders (nastavenia > sťahovače).
jellyfin, emby, plex	Mediálny server, off (vypnutý), kým ho neotestuješ.
smtp, discord, webhook	Upozornenia „Email“, „Discord“ a „Webhook“, off, kým ich neotestuješ.
radarr, sonarr, lidarr, prowlarr, bazarr, seerr	Kľúč uložený pre Import from other apps (import z iných aplikácií).
holyarrs	Používa sa iba na spojenie s HolyArrs, kým beží. Nikdy sa neukladá.

Každý kľúč ide do šifrovaného trezoru, rovnako ako ten, ktorý napíšeš v nastaveniach.

Možnosti

Prepínač lokálnej siete

Každý blok s adresou môže mať allow_local_network: true. Umožní tej položke dosiahnuť tento počítač alebo tvoju domácu sieť (192.168.x.x, 10.x.x.x, názov kontajnera). Bez neho položka dosiahne iba internet, takže sťahovač doma neodpovie. HolyArrs to nikdy neodhaduje z adresy. Je to ten istý prepínač ako May reach the local network (môže dosiahnuť lokálnu sieť) v nastaveniach.

Keď je HolyArrs zastavený

Spusti jednorazový kontajner nad rovnakou konfiguráciou. Ukladá priamo do konfiguračného priečinka a blok holyarrs nepotrebuje:

docker stop holyarrs
docker run --rm -e PUID=1000 -e PGID=1000 \
  -v /srv/holyarrs/config:/config \
  -v /srv/holyarrs/holyarrs-secrets.yaml:/run/secrets/holyarrs.yaml:ro \
  holyarrs/holyarrs:latest import-secrets -file /run/secrets/holyarrs.yaml
docker start holyarrs

Použi rovnaké PUID a PGID ako aplikácia, inak sa konfiguračný priečinok odovzdá 1000:1000. Používateľ PUID musí vedieť súbor čítať. Ak používaš HOLYARRS_MASTER_KEY_FILE, daj jednorazovému kontajneru rovnakú premennú a pripojenie.

Opakované spustenie

Opakované spustenie je bezpečné. Zhodné položky hlásia unchanged; ukladajú sa iba zmenené.

Položka	Zhoda podľa
Zdroje	názvu
Sťahovače, mediálne servery	druhu a adresy
Upozornenia	názvu a druhu
Stránky s titulkami, staršie aplikácie	druhu

Zdroj alebo sťahovač, ktorému sa zmenila adresa alebo kľúč, sa pozastaví znova. Keď ho raz sám obnovíš, opakovaný beh ho nechá bežať. Prázdny api_key pri položke indexers ponechá uložený kľúč; na jeho odstránenie pridaj clear_key: true.

Vymaž súbor

S -delete príkaz prepíše súbor nulami a odstráni ho, a to iba po behu, v ktorom nič nezlyhalo. Pripojenie iba na čítanie sa z vnútra kontajnera vymazať nedá, takže ho vymaž na hostiteľovi:

Systém	Príkaz
Linux	shred -u holyarrs-secrets.yaml
macOS	rm -P holyarrs-secrets.yaml
Windows	Remove-Item holyarrs-secrets.yaml, potom vyprázdni Kôš.

Na SSD a súborových systémoch typu copy-on-write môžu staré bloky na disku zostať. Samotné kľúče teraz žijú v šifrovanom trezore.

Ak to nefunguje

Príznak	Príčina	Riešenie
Súbor môžu čítať iní používatelia	Oprávnenia sú príliš otvorené.	Spusti chmod 600. Na Windows ho maj v priečinku, ktorý môžeš otvoriť iba ty.
Neznámy kľúč zastavil import	Preklep alebo tabulátor na uvedenom riadku.	Oprav ten riadok. Nič sa neuložilo.
Čisté http odmietnuté	Adresa holyarrs nie je na tomto počítači.	Spusti vnútri kontajnera s http://127.0.0.1:6262 alebo použi https.
Sťahovač doma neodpovedá	Chýba oprávnenie na lokálnu sieť.	Nastav allow_local_network: true na tom bloku.
Jednorazový kontajner zmenil vlastníkov priečinkov	Iné PUID/PGID.	Použi PUID a PGID aplikácie.
-delete nič neurobil	Niečo zlyhalo, alebo je pripojenie iba na čítanie.	Vymaž ho na hostiteľovi.

Pre expertov

Prepínače a kódy ukončenia

Prepínač	Čo robí	Predvolene
-file <path>	Súbor s tajomstvami.	žiadny
-dry-run	Iba povie, čo by sa nastavilo.	vypnuté
-config <folder>	Konfiguračný priečinok.	/config
-delete	Po behu bez zlyhaní prepíše súbor nulami a vymaže ho.	vypnuté
-forget-move-credentials	Vymaže každý uložený kľúč starej aplikácie a skončí.	vypnuté
-allow-http-lan	Povolí čisté http:// na adresu domácej siete. Vypíše varovanie.	vypnuté
-allow-readable-file	Prijme súbor, ktorý môžu čítať aj iní používatelia. Docker Desktop na Windows ukazuje každý súbor ako čitateľný.	vypnuté

Adresa holyarrs musí byť https://, alebo čisté http:// iba na tento počítač (127.0.0.1, ::1, localhost). Cez čisté http cestuje tvoj kľúč vlastníka a celý súbor nešifrovane.

Kód ukončenia	Význam
0	Každá položka prebehla dobre.
1	Položka zlyhala. Oprav súbor a spusti znova.
2	Zlý príkazový riadok alebo súbor.

Výstup

Jeden riadok na položku: set (alebo would set pri skúšobnom behu, niekedy s poznámkou), unchanged, skipped (empty), skipped (why) alebo failed: why. Nikdy nevypíše kľúč, heslo, token ani adresu. História dostane jednu udalosť iba s počtami. Chyba, ktorá by ukázala hodnotu z tvojho súboru, ukáže namiesto nej [hidden].

Formát súboru

Malá, prísna časť YAML:

• bloky podľa odsadenia medzerami, nikdy tabulátormi; zoznamy s - ,
• hodnoty obyčajné, v "double quotes" (dvojité úvodzovky) alebo 'single quotes' (jednoduché úvodzovky) (' v jednoduchých úvodzovkách napíš dvakrát),
• # začína komentár na začiatku riadka alebo za medzerou mimo úvodzoviek, takže heslo s # daj do úvodzoviek,
• hodnotu, ktorá začína na &, *, !, |, >, [, {, %, @ alebo spätný apostrof, alebo ktorá obsahuje : , daj do úvodzoviek.

Neznámy kľúč alebo súbor väčší ako 256 KB zastaví celý import skôr, než sa čokoľvek uloží; hlásenie uvedie kľúč a riadok. Odkaz na súbor sa odmietne.

Špeciálne polia

Pole	Pravidlo
SABnzbd	Potrebuje úplný api_key. nzb_key, používateľské meno alebo heslo sa preskočí a nikdy neuloží.
tvdb.api_key, tvdb.unique_user_key, trakt.redirect_urls	Prijaté a preskočené.
smtp.host	Iba názov servera, bez schémy a portu.
smtp.port	1 až 65535. Predvolene 587.
smtp.from	Jedna obyčajná e-mailová adresa.
Bloky starých aplikácií	Používajú sa v Import from other apps s Use the saved key (použiť uložený kľúč). Nikdy sa neukazujú, iba pre vlastníka, vymažú sa po jednom úspešnom prečítaní.

Súvisiace stránky

• Čítanie tvojich starých aplikácií
• Premenné prostredia