Import klíčů ze souboru

Nastavení

Vyplň jeden soubor se zdroji, stahovači, mediálními servery, weby s titulky a poštou, naimportuj ho a nemusíš zadávat každý klíč v Nastavení zvlášť.

Než začneš

HolyArrs běží v Dockeru a jeho konfigurace je v /config.
Můžeš vytvořit API klíč vlastníka v Settings > API > API keys (nastavení > API > API klíče).

Naimportuj soubor

Zkopíruj holyarrs-secrets.template.yaml do holyarrs-secrets.yaml.
Vyplň, co používáš. Zbytek nech prázdný; prázdné znamená přeskočit.
Nastav ho tak, aby ho četl jen ty:
Terminal window
```
chmod 600 holyarrs-secrets.yaml
```

Připoj ho do kontejneru jen pro čtení:

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

Vytvoř API klíč vlastníka s oprávněním admin v Settings > API > API keys. Vlož ho do bloku holyarrs v souboru s adresou http://127.0.0.1:6262.
Zkus nanečisto. Nic se nezmění:
Terminal window
```
docker exec holyarrs /holyarrs import-secrets -file /run/secrets/holyarrs.yaml -dry-run
```
Měl bys vidět jeden řádek would set na každou položku.
Spusť to doopravdy (stejný příkaz bez -dry-run). Měl bys vidět řádky set a návratový kód 0.
Zkontroluj nové zdroje a stahovače a pak je spusť znovu (Resume, pokračovat). Otestuj nové mediální servery a upozornění a pak je zapni.
Smaž soubor na hostiteli (viz Smaž soubor). Smaž i API klíč, pokud ho už nepotřebuješ.

Čím se každý blok stane

V souboru	Stane se
`trakt.client_id`	Klíč aplikace Trakt (Settings > Outside lists, nastavení > externí seznamy).
`tmdb`, `tvdb`	Přijímají se ze starších souborů. Metadata žádné klíče nepotřebují.
`opensubtitles`, `subdl`	Web s titulky s tvým účtem.
`addic7ed`	Web s titulky Addic7ed, jen seriály.
`indexers`	Jeden zdroj na každou položku, pozastavený.
`jackett`, `prowlarr`	Jejich klíč doplní každou položku `indexers` na stejné adrese, která nemá klíč.
`qbittorrent`, `sabnzbd`	Stahovač, pozastavený.
`nzbget`, `transmission`, `deluge`	Přeskočeno. Import je zatím neumí nastavit; přidej je v Settings > Downloaders.
`jellyfin`, `emby`, `plex`	Mediální server, vypnutý, dokud ho neotestuješ.
`smtp`, `discord`, `webhook`	Upozornění „Email“, „Discord“ a „Webhook“, vypnutá, dokud je neotestuješ.
`radarr`, `sonarr`, `lidarr`, `prowlarr`, `bazarr`, `seerr`	Klíč uložený pro Import from other apps (import z jiných aplikací).
`holyarrs`	Používá se jen k připojení k HolyArrs, když běží. Nikdy se neukládá.

Každý klíč jde do šifrovaného trezoru, stejně jako ten zadaný v Nastavení.

Možnosti

Přepínač místní sítě

Každý blok s adresou může mít allow_local_network: true. Dovolí té položce dosáhnout na tento počítač nebo tvoji domácí síť (192.168.x.x, 10.x.x.x, název kontejneru). Bez něj dosáhne jen na internet, takže stahovač doma neodpoví. HolyArrs to nikdy neodhaduje z adresy. Je to stejný přepínač jako May reach the local network (smí dosáhnout na místní síť) v Nastavení.

Při zastaveném HolyArrs

Spusť jednorázový kontejner nad stejnou konfigurací. Uloží přímo do konfigurační složky a blok holyarrs nepotřebuje:

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žij stejné PUID a PGID jako aplikace, jinak se konfigurační složka předá uživateli 1000:1000. Uživatel PUID musí umět soubor přečíst. Pokud používáš HOLYARRS_MASTER_KEY_FILE, dej jednorázovému kontejneru stejnou proměnnou a stejné připojení.

Opakované spuštění

Opakované spuštění je bezpečné. Shodné položky hlásí unchanged; ukládají se jen změněné.

Položka	Páruje se podle
Zdroje	názvu
Stahovače, mediální servery	druhu a adresy
Upozornění	názvu a druhu
Weby s titulky, dřívější aplikace	druhu

Zdroj nebo stahovač, kterému se změnila adresa nebo klíč, se znovu pozastaví. Jakmile jeden sám znovu spustíš, opakované spuštění ho nechá běžet. Prázdné api_key u položky indexers ponechá uložený klíč; přidej clear_key: true, chceš-li ho odebrat.

Smaž soubor

S -delete příkaz soubor přepíše nulami a odstraní, a to jen po běhu, kde nic neselhalo. Připojení jen pro čtení nejde zevnitř kontejneru smazat, takže soubor smaž na hostiteli:

Systém	Příkaz
Linux	`shred -u holyarrs-secrets.yaml`
macOS	`rm -P holyarrs-secrets.yaml`
Windows	`Remove-Item holyarrs-secrets.yaml`, pak vysypat koš.

Na SSD a souborových systémech typu copy-on-write mohou staré bloky na disku zůstat. Samotné klíče teď žijí v šifrovaném trezoru.

Když to nefunguje

Příznak	Příčina	Řešení
Soubor mohou číst i jiní uživatelé	Příliš otevřená oprávnění.	Spusť `chmod 600`. Ve Windows ho měj ve složce, kterou otevřeš jen ty.
Neznámý klíč zastavil import	Překlep nebo tabulátor na uvedeném řádku.	Oprav ten řádek. Nic se neuložilo.
Prosté http odmítnuto	Adresa `holyarrs` není na tomto počítači.	Spusť uvnitř kontejneru s `http://127.0.0.1:6262`, nebo použij https.
Stahovač doma neodpovídá	Chybí oprávnění k místní síti.	Nastav `allow_local_network: true` u toho bloku.
Jednorázový kontejner změnil vlastníky složek	Jiné `PUID`/`PGID`.	Použij `PUID` a `PGID` aplikace.
`-delete` neudělal nic	Něco selhalo, nebo je připojení jen pro čtení.	Smaž soubor na hostiteli.

Pro pokročilé

Přepínače a návratové kódy

Přepínač	Co dělá	Výchozí
`-file <path>`	Soubor s tajnými údaji.	žádný
`-dry-run`	Jen řekne, co by se nastavilo.	vypnuto
`-config <folder>`	Konfigurační složka.	`/config`
`-delete`	Po běhu bez selhání přepíše soubor nulami a smaže ho.	vypnuto
`-forget-move-credentials`	Smaže každý uložený klíč dřívějších aplikací a skončí.	vypnuto
`-allow-http-lan`	Povolí prosté `http://` na adresu v domácí síti. Vypíše varování.	vypnuto
`-allow-readable-file`	Přijme soubor, který mohou číst i jiní uživatelé. Docker Desktop ve Windows ukazuje každý soubor jako čitelný.	vypnuto

Adresa holyarrs musí být https://, nebo prosté http:// jen na tento počítač (127.0.0.1, ::1, localhost). Přes prosté http putuje tvůj klíč vlastníka i celý soubor nešifrovaně.

Návratový kód	Význam
`0`	Každá položka proběhla dobře.
`1`	Položka selhala. Oprav soubor a spusť znovu.
`2`	Špatný příkazový řádek nebo soubor.

Výstup

Jeden řádek na položku: set (nebo would set při nanečisto, někdy s poznámkou), unchanged, skipped (empty), skipped (why) nebo failed: why. Nikdy nevypíše klíč, heslo, token ani adresu. Historie dostane jednu událost jen s počty. Chyba, která by ukázala hodnotu z tvého souboru, ukáže místo ní [hidden].

Formát souboru

Malá, přísná část YAML:

bloky odsazením mezerami, nikdy tabulátory; seznamy s - ,
hodnoty holé, v "double quotes" (dvojité uvozovky) nebo 'single quotes' (jednoduché uvozovky); ' uvnitř jednoduchých uvozovek napiš dvakrát,
# začíná komentář na začátku řádku nebo po mezeře mimo uvozovky, takže heslo s # dej do uvozovek,
do uvozovek dej hodnotu, která začíná na &, *, !, |, >, [, {, %, @ nebo zpětný apostrof, nebo která obsahuje : .

Neznámý klíč nebo soubor nad 256 KB zastaví celý import, než se cokoli uloží; zpráva uvede klíč a řádek. Odkaz na soubor se odmítne.

Zvláštní pole

Pole	Pravidlo
SABnzbd	Potřebuje celý `api_key`. `nzb_key`, uživatelské jméno nebo heslo se přeskočí a nikdy neuloží.
`tvdb.api_key`, `tvdb.unique_user_key`, `trakt.redirect_urls`	Přijmou se a přeskočí.
`smtp.host`	Jen název serveru, bez schématu a portu.
`smtp.port`	1 až 65535. Výchozí `587`.
`smtp.from`	Jedna prostá e-mailová adresa.
Bloky dřívějších aplikací	Používají se v Import from other apps s Use the saved key (použít uložený klíč). Nikdy se neukazují, jen pro vlastníka, po jednom úspěšném přečtení se smažou.

Související

HolyArrs je zdarma. Pokud ti ušetřil čas, dej mu hvězdičku na GitHubu, podpoř ho sponzorstvím nebo kup mi kávu.