Kulcsok importálása fájlból

Töltsd ki egyetlen fájlban a Forrásaidat, Letöltőidet, médiaszervereidet, feliratoldalaidat és az e-mailt, importáld, és nem kell minden kulcsot egyesével beírnod a Beállításokban.

Mielőtt elkezdenéd

• A HolyArrs Dockerben fut, a konfigurációja a /config mappában van.
• Tulajdonosi API-kulcsot a Settings > API > API keys (Beállítások > API > API-kulcsok) oldalon tudsz készíteni.

A fájl importálása

1. Másold a holyarrs-secrets.template.yaml fájlt holyarrs-secrets.yaml néven.

2. Töltsd ki azt, amit használsz. A többit hagyd üresen; az üres azt jelenti, hogy kihagyja.

3. Állítsd be, hogy csak te olvashasd:

   chmod 600 holyarrs-secrets.yaml

4. Csatold csak olvashatóként a containerbe:

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

5. Készíts egy tulajdonosi API-kulcsot admin hatókörrel a Settings > API > API keys oldalon. Írd be a fájl holyarrs blokkjába, a http://127.0.0.1:6262 címmel.

6. Próbáld ki egy szárazfutással. Semmit sem változtat:

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

   Elemenként egy would set sort kell látnod.

7. Futtasd élesben (ugyanaz a parancs -dry-run nélkül). set sorokat és 0 kilépési kódot kell látnod.

8. Nézd át az új Forrásokat és Letöltőket, aztán folytasd őket. Teszteld az új médiaszervereket és Értesítéseket, aztán kapcsold be őket.

9. Töröld a fájlt a hoston (lásd: A fájl törlése). Az API-kulcsot is töröld, ha már nincs rá szükséged.

Figyelem

A fájl minden titkot egyszerű szövegként tartalmaz, amíg nem törlöd. Töröld a hoston, amint a futtatás sikerült.

Melyik blokkból mi lesz

A fájlban	Ebből lesz
trakt.client_id	A Trakt app kulcsa (Settings > Outside lists (Beállítások > Külső listák)).
tmdb, tvdb	Régebbi fájlokból elfogadja. A metaadatokhoz nem kellenek kulcsok.
opensubtitles, subdl	Egy feliratoldal a fiókoddal.
addic7ed	Egy Addic7ed feliratoldal, csak sorozatokhoz.
indexers	Bejegyzésenként egy Forrás, szüneteltetve.
jackett, prowlarr	A kulcsuk kitölti minden olyan indexers bejegyzést, amelynek ugyanaz a címe, és nincs kulcsa.
qbittorrent, sabnzbd	Egy Letöltő, szüneteltetve.
nzbget, transmission, deluge	Kihagyja. Az import ezeket még nem tudja beállítani; add hozzá őket a Settings > Downloaders oldalon.
jellyfin, emby, plex	Egy médiaszerver, kikapcsolva, amíg ki nem próbálod.
smtp, discord, webhook	Az Értesítések „Email”, „Discord” és „Webhook” tételei, kikapcsolva, amíg ki nem próbálod őket.
radarr, sonarr, lidarr, prowlarr, bazarr, seerr	Egy mentett kulcs az Import from other apps (Importálás más appokból) funkcióhoz.
holyarrs	Csak a HolyArrs eléréséhez kell, amíg fut. Soha nem mentődik el.

Minden kulcs a titkosított tárolóba kerül, ugyanúgy, mintha a Beállításokban írtad volna be.

Lehetőségek

A helyi hálózat kapcsolója

Minden címmel rendelkező blokk kaphat allow_local_network: true értéket. Ezzel az adott tétel elérheti ezt a gépet vagy az otthoni hálózatodat (192.168.x.x, 10.x.x.x, egy containernév). Nélküle a tétel csak az internetet éri el, így egy otthoni Letöltő nem fog válaszolni. A HolyArrs soha nem találgat ezt a címből. Ugyanaz a kapcsoló, mint a May reach the local network (elérheti a helyi hálózatot) a Beállításokban.

Leállított HolyArrs mellett

Futtass egy egyszeri containert ugyanazzal a konfigurációval. Közvetlenül a konfigurációs mappába ment, és nem kell hozzá holyarrs blokk:

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

Ugyanazt a PUID és PGID értéket használd, mint az app, különben a konfigurációs mappa tulajdonosa 1000:1000 lesz. A PUID felhasználónak olvasnia kell tudnia a fájlt. Ha a HOLYARRS_MASTER_KEY_FILE változót használod, add meg ugyanezt a változót és csatolást az egyszeri containernek is.

Újrafuttatás

Az újrafuttatás biztonságos. Az egyező tételeknél unchanged áll; csak a módosult tételek mentődnek.

Tétel	Ez alapján egyezik
Források	név
Letöltők, médiaszerverek	fajta és cím
Értesítések	név és fajta
Feliratoldalak, korábbi appok	fajta

Az a Forrás vagy Letöltő, amelynek a címe vagy a kulcsa megváltozott, újra szüneteltetve lesz. Ha egyet te magad folytattál, az újrafuttatás futva hagyja. Egy indexers bejegyzés üres api_key értéke megtartja a tárolt kulcsot; a törléséhez add hozzá a clear_key: true értéket.

A fájl törlése

A -delete kapcsolóval a parancs nullákkal felülírja a fájlt, és eltávolítja, de csak olyan futtatás után, amelyben semmi sem hibázott. A csak olvasható csatolást nem lehet a containerből törölni, ezért töröld a hoston:

Rendszer	Parancs
Linux	shred -u holyarrs-secrets.yaml
macOS	rm -P holyarrs-secrets.yaml
Windows	Remove-Item holyarrs-secrets.yaml, aztán ürítsd ki a Lomtárat.

SSD-ken és copy-on-write fájlrendszereken a régi blokkok a lemezen maradhatnak. Maguk a kulcsok most már a titkosított tárolóban vannak.

Ha nem működik

Tünet	Ok	Megoldás
A fájlt más felhasználók is olvashatják	Túl tág jogosultságok.	Futtasd a chmod 600 parancsot. Windowson tartsd olyan mappában, amelyet csak te nyithatsz meg.
Egy ismeretlen kulcs megállította az importot	Elírás, vagy tabulátor a megnevezett sorban.	Javítsd ki azt a sort. Semmi sem mentődött el.
A sima http-t elutasította	A holyarrs cím nem erre a gépre mutat.	Futtasd a containerben a http://127.0.0.1:6262 címmel, vagy használj https-t.
Egy otthoni Letöltő nem válaszol	Nincs helyi hálózati jogosultság.	Állítsd be az allow_local_network: true értéket azon a blokkon.
Az egyszeri container megváltoztatta a mappák tulajdonosát	Más PUID/PGID.	Használd az app PUID és PGID értékét.
A -delete nem csinált semmit	Valami hibázott, vagy a csatolás csak olvasható.	Töröld a hoston.

Haladóknak

Kapcsolók és kilépési kódok

Kapcsoló	Mit csinál	Alapértelmezett
-file <path>	A titkok fájlja.	nincs
-dry-run	Csak megmondja, mit állítana be.	ki
-config <folder>	A konfigurációs mappa.	/config
-delete	Hibátlan futtatás után nullákkal felülírja a fájlt, és törli.	ki
-forget-move-credentials	Törli az összes mentett korábbi app kulcsot, aztán leáll.	ki
-allow-http-lan	Engedélyezi a sima http:// kapcsolatot egy otthoni hálózati címre. Figyelmeztetést ír ki.	ki
-allow-readable-file	Elfogad egy olyan fájlt, amelyet más felhasználók is olvashatnak. A Docker Desktop Windowson minden fájlt olvashatóként mutat.	ki

A holyarrs címnek https:// címnek kell lennie, vagy sima http:// címnek csak erre a gépre (127.0.0.1, ::1, localhost). Sima http-n a tulajdonosi kulcsod és az egész fájl titkosítatlanul utazik.

Kilépési kód	Jelentés
0	Minden tétel rendben ment.
1	Egy tétel hibázott. Javítsd a fájlt, és futtasd újra.
2	Hibás parancssor vagy fájl.

Kimenet

Tételenként egy sor: set (szárazfutásban would set, néha megjegyzéssel), unchanged, skipped (empty), skipped (why) vagy failed: why. Soha nem ír ki kulcsot, jelszót, tokent vagy címet. Az Előzmények egyetlen Eseményt kapnak, csak darabszámokkal. Egy olyan hiba, amely a fájlod egy értékét mutatná, helyette [hidden] szöveget mutat.

Fájlformátum

A YAML egy kicsi, szigorú része:

• blokkok szóközös behúzással, soha nem tabulátorral; listák - jellel,
• az értékek egyszerűek, "double quotes" vagy 'single quotes' (szimpla idézőjelen belül a ' jelet kétszer írd),
• a # megjegyzést kezd a sor elején vagy egy szóköz után az idézőjelen kívül, ezért idézőjelezd azt a jelszót, amelyben # van,
• idézőjelezd azt az értéket, amely &, *, !, |, >, [, {, %, @ vagy fordított aposztróf jellel kezdődik, vagy amelyben : van.

Egy ismeretlen kulcs vagy egy 256 KB feletti fájl az egész importot leállítja, mielőtt bármi elmentődne; az üzenet megnevezi a kulcsot és a sort. A fájlra mutató hivatkozást (link) elutasítja.

Különleges mezők

Mező	Szabály
SABnzbd	A teljes api_key kell hozzá. Az nzb_key, a felhasználónév és a jelszó kimarad, és soha nem tárolódik.
tvdb.api_key, tvdb.unique_user_key, trakt.redirect_urls	Elfogadja és kihagyja.
smtp.host	Csak a szervernév, séma és port nélkül.
smtp.port	1–65535. Alapértelmezett: 587.
smtp.from	Egyetlen egyszerű e-mail-cím.
Korábbi app blokkok	Az Import from other apps funkcióban használja a Use the saved key (mentett kulcs használata) opcióval. Soha nem jelenik meg, csak a tulajdonos látja, egyetlen sikeres olvasás után törlődik.

Kapcsolódó oldalak

• A korábbi appjaid beolvasása
• Környezeti változók