Uvoz ključeva iz datoteke

Ispuni jednu datoteku sa svojim izvorima, preuzimateljima, medijskim poslužiteljima, stranicama s titlovima i e-poštom, uvezi je i preskoči unošenje svakog ključa u postavkama.

Prije nego počneš

• HolyArrs radi u Dockeru s konfiguracijom u /config.
• Vlasnički API ključ možeš napraviti u Settings > API > API keys (postavke > API > API ključevi).

Uvezi datoteku

1. Kopiraj holyarrs-secrets.template.yaml u holyarrs-secrets.yaml.

2. Ispuni ono što koristiš. Ostalo ostavi prazno; prazno znači preskoči.

3. Neka bude čitljiva samo tebi:

   chmod 600 holyarrs-secrets.yaml

4. Montiraj je samo za čitanje u container:

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

5. Napravi API ključ vlasnika s opsegom admin u Settings > API > API keys. Stavi ga u blok holyarrs u datoteci, s adresom http://127.0.0.1:6262.

6. Probaj probno pokretanje. Ništa ne mijenja:

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

   Vidjet ćeš jedan redak would set po stavci.

7. Pokreni ga stvarno (ista naredba bez -dry-run). Vidjet ćeš retke set i izlazni kod 0.

8. Provjeri nove izvore i preuzimatelje, zatim ih nastavi. Testiraj nove medijske poslužitelje i obavijesti, zatim ih uključi.

9. Izbriši datoteku na hostu (vidi Izbriši datoteku). Izbriši i API ključ ako ti više ne treba.

Caution

Datoteka drži svaku tajnu u običnom tekstu dok je ne izbrišeš. Izbriši je na hostu čim pokretanje uspije.

Što svaki blok postane

U datoteci	Postaje
trakt.client_id	Trakt ključ aplikacije (Settings > Outside lists, postavke > vanjski popisi).
tmdb, tvdb	Prihvaćeni iz starijih datoteka. Metapodaci ne trebaju ključeve.
opensubtitles, subdl	Stranica s titlovima s tvojim računom.
addic7ed	Addic7ed stranica s titlovima, samo za serije.
indexers	Jedan izvor po unosu, paused (pauzirano).
jackett, prowlarr	Njihov ključ popunjava svaki unos u indexers na istoj adresi koji nema ključ.
qbittorrent, sabnzbd	Preuzimatelj, paused.
nzbget, transmission, deluge	Preskočeno. Uvoz ih još ne može postaviti; dodaj ih u Settings > Downloaders.
jellyfin, emby, plex	Medijski poslužitelj, off (isključeno) dok ga ne testiraš.
smtp, discord, webhook	obavijesti „Email“, „Discord“ i „Webhook“, off dok ih ne testiraš.
radarr, sonarr, lidarr, prowlarr, bazarr, seerr	Ključ spremljen za Import from other apps (uvoz iz drugih aplikacija).
holyarrs	Koristi se samo za povezivanje s HolyArrs dok radi. Nikad se ne sprema.

Svaki ključ ide u šifrirani trezor, jednako kao onaj unesen u postavkama.

Izbori

Prekidač lokalne mreže

Svaki blok s adresom može imati allow_local_network: true. Time taj unos može doći do ovog računala ili tvoje kućne mreže (192.168.x.x, 10.x.x.x, ime containera). Bez toga unos dolazi samo do interneta, pa preuzimatelj kod kuće neće odgovoriti. HolyArrs to nikad ne pogađa iz adrese. To je isti prekidač kao May reach the local network (smije dosegnuti lokalnu mrežu) u postavkama.

Dok je HolyArrs zaustavljen

Pokreni jednokratni container na istoj konfiguraciji. Sprema izravno u mapu s konfiguracijom i ne treba blok holyarrs:

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

Koristi iste PUID i PGID kao aplikacija, inače se mapa s konfiguracijom predaje korisniku 1000:1000. Korisnik PUID mora moći čitati datoteku. Ako koristiš HOLYARRS_MASTER_KEY_FILE, jednokratnom containeru daj istu varijablu i mount.

Ponovno pokretanje

Ponovno pokretanje je sigurno. Podudarne stavke kažu unchanged; spremaju se samo promijenjene.

Stavka	Podudara se po
Izvori	nazivu
Preuzimatelji, medijski poslužitelji	vrsti i adresi
Obavijesti	nazivu i vrsti
Stranice s titlovima, dosadašnje aplikacije	vrsti

Izvor ili preuzimatelj kojem se promijenila adresa ili ključ ponovno se pauzira. Kad ga jednom ručno nastaviš, ponovno pokretanje ga ostavlja da radi. Prazan api_key na unosu indexers zadržava spremljeni ključ; dodaj clear_key: true da ga ukloniš.

Izbriši datoteku

S -delete naredba prepisuje datoteku nulama i uklanja je, samo nakon pokretanja u kojem ništa nije palo. Mount samo za čitanje ne može se brisati iz containera, pa je izbriši na hostu:

Sustav	Naredba
Linux	shred -u holyarrs-secrets.yaml
macOS	rm -P holyarrs-secrets.yaml
Windows	Remove-Item holyarrs-secrets.yaml, zatim isprazni Koš.

Na SSD-ovima i datotečnim sustavima s copy-on-write stari blokovi mogu ostati na disku. Sami ključevi sada žive u šifriranom trezoru.

Ako ne radi

Simptom	Uzrok	Rješenje
Datoteku mogu čitati drugi korisnici	Dozvole su preotvorene.	Izvrši chmod 600. Na Windowsu je drži u mapi koju možeš otvoriti samo ti.
Nepoznat ključ zaustavio je uvoz	Tipfeler ili tab u navedenom retku.	Ispravi taj redak. Ništa nije spremljeno.
Obični http je odbijen	Adresa holyarrs nije na ovom računalu.	Pokreni unutar containera s http://127.0.0.1:6262 ili koristi https.
Preuzimatelj kod kuće ne odgovara	Nema dozvole za lokalnu mrežu.	Postavi allow_local_network: true na tom bloku.
Jednokratni container promijenio je vlasnike mapa	Drugačiji PUID/PGID.	Koristi PUID i PGID aplikacije.
-delete nije ništa napravio	Nešto je palo ili je mount samo za čitanje.	Izbriši datoteku na hostu.

Za napredne

Zastavice i izlazni kodovi

Zastavica	Što radi	Zadano
-file <path>	Datoteka s tajnama.	nema
-dry-run	Samo kaže što bi se postavilo.	isključeno
-config <folder>	Mapa s konfiguracijom.	/config
-delete	Nakon pokretanja bez pogrešaka prepisuje datoteku nulama i briše je.	isključeno
-forget-move-credentials	Briše svaki spremljeni ključ dosadašnjih aplikacija, zatim staje.	isključeno
-allow-http-lan	Dopušta obični http:// prema adresi u kućnoj mreži. Ispisuje upozorenje.	isključeno
-allow-readable-file	Prihvaća datoteku koju mogu čitati drugi korisnici. Docker Desktop na Windowsu prikazuje svaku datoteku kao čitljivu.	isključeno

Adresa holyarrs mora biti https:// ili obični http:// samo prema ovom računalu (127.0.0.1, ::1, localhost). Preko običnog httpa tvoj vlasnički ključ i cijela datoteka putuju nešifrirani.

Izlazni kod	Značenje
0	Sve je prošlo dobro.
1	Stavka nije uspjela. Ispravi datoteku i pokreni ponovno.
2	Pogrešna naredba ili datoteka.

Ispis

Jedan redak po stavci: set (ili would set u probnom pokretanju, ponekad s napomenom), unchanged, skipped (empty), skipped (why) ili failed: why. Nikad ne ispisuje ključ, lozinku, token ni adresu. Povijest dobiva jedan događaj samo s brojevima. Pogreška koja bi prikazala vrijednost iz tvoje datoteke umjesto toga prikazuje [hidden].

Format datoteke

Mali, strogi dio YAML-a:

• blokovi se prave uvlakom razmacima, nikad tabovima; popisi s - ,
• vrijednosti su obične, u "double quotes" ili 'single quotes' (' unutar jednostrukih navodnika piši dvaput),
• # počinje komentar na početku retka ili iza razmaka izvan navodnika, pa lozinku koja sadrži # stavi u navodnike,
• u navodnike stavi vrijednost koja počinje s &, *, !, |, >, [, {, %, @ ili obrnutim apostrofom, ili koja sadrži : .

Nepoznat ključ ili datoteka veća od 256 KB zaustavlja cijeli uvoz prije nego se išta spremi; poruka navodi ključ i redak. Simbolička veza na datoteku se odbija.

Posebna polja

Polje	Pravilo
SABnzbd	Treba puni api_key. nzb_key, korisničko ime ili lozinka preskaču se i nikad se ne spremaju.
tvdb.api_key, tvdb.unique_user_key, trakt.redirect_urls	Prihvaćeno i preskočeno.
smtp.host	Samo ime servera, bez sheme i porta.
smtp.port	1 do 65535. Zadano 587.
smtp.from	Jedna obična e-mail adresa.
Blokovi dosadašnjih aplikacija	Koriste se u Import from other apps s Use the saved key (koristi spremljeni ključ). Nikad se ne prikazuju, samo za vlasnika, brišu se nakon jednog uspješnog čitanja.

Povezane stranice

• Čitanje dosadašnjih aplikacija
• Varijable okoline