Raktų importas iš failo

Užpildyk vieną failą su savo šaltiniais, atsisiuntimo programomis, medijos serveriais, subtitrų svetainėmis ir paštu, importuok jį ir nebevesk kiekvieno rakto nustatymuose.

Prieš pradedant

• HolyArrs veikia Docker konteineryje, o jos konfigūracija laikoma /config.
• Savininko API raktą gali susikurti Settings > API > API keys (nustatymai > API > API raktai).

Importuok failą

1. Nukopijuok holyarrs-secrets.template.yaml į holyarrs-secrets.yaml.

2. Užpildyk tai, ką naudoji. Likusį palik tuščią; tuščia reiškia praleisti.

3. Padaryk jį skaitomą tik tau:

   chmod 600 holyarrs-secrets.yaml

4. Prijunk jį prie konteinerio tik skaitymui:

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

5. Sukurk savininko API raktą su admin apimtimi skiltyje Settings > API > API keys. Įrašyk jį failo bloke holyarrs kartu su adresu http://127.0.0.1:6262.

6. Paleisk bandomąjį variantą. Jis nieko nekeičia:

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

   Turėtum pamatyti po vieną eilutę would set kiekvienam įrašui.

7. Paleisk iš tikrųjų (ta pati komanda be -dry-run). Turėtum pamatyti eilutes set ir išėjimo kodą 0.

8. Patikrink naujus šaltinius ir atsisiuntimo programas, tada juos tęsk. Patikrink naujus medijos serverius ir Alerts (pranešimus), tada juos įjunk.

9. Ištrink failą pagrindiniame kompiuteryje (žr. Ištrink failą). Jei API rakto nebereikia, ištrink ir jį.

Caution

Failas laiko kiekvieną paslaptį paprastu tekstu, kol jį ištrinsi. Ištrink jį pagrindiniame kompiuteryje, kai tik paleidimas pavyks.

Kuo tampa kiekvienas blokas

Faile	Tampa
trakt.client_id	Trakt programos raktu (Settings > Outside lists, nustatymai > išoriniai sąrašai).
tmdb, tvdb	Priimami iš senesnių failų. Metaduomenims raktų nereikia.
opensubtitles, subdl	Subtitrų svetaine su tavo paskyra.
addic7ed	Addic7ed subtitrų svetaine, tik serialams.
indexers	Po vieną šaltinį kiekvienam įrašui, pristabdytą.
jackett, prowlarr	Jų raktas užpildo kiekvieną indexers įrašą su tuo pačiu adresu, kuris neturi rakto.
qbittorrent, sabnzbd	Atsisiuntimo programa, pristabdyta.
nzbget, transmission, deluge	Praleidžiami. Importas dar negali jų nustatyti; pridėk juos Settings > Downloaders (atsisiuntimo programos).
jellyfin, emby, plex	Medijos serveris, išjungtas, kol jo netikrinsi.
smtp, discord, webhook	Pranešimai „Email“, „Discord“ ir „Webhook“, išjungti, kol jų netikrinsi.
radarr, sonarr, lidarr, prowlarr, bazarr, seerr	Raktas, išsaugotas skiltiai Import from other apps (importas iš kitų programų).
holyarrs	Naudojamas tik prisijungti prie HolyArrs, kol ji veikia. Niekada neišsaugomas.

Kiekvienas raktas keliauja į užšifruotą saugyklą, lygiai kaip įvestas nustatymuose.

Pasirinkimai

Vietinio tinklo jungiklis

Kiekvienas blokas su adresu gali turėti allow_local_network: true. Jis leidžia tam įrašui pasiekti šį kompiuterį ar tavo namų tinklą (192.168.x.x, 10.x.x.x, konteinerio vardą). Be jo įrašas pasiekia tik internetą, todėl namuose esanti atsisiuntimo programa neatsilieps. HolyArrs niekada to neatspėja iš adreso. Tai tas pats jungiklis kaip May reach the local network (gali pasiekti vietinį tinklą) nustatymuose.

Kai HolyArrs sustabdyta

Paleisk vienkartinį konteinerį su ta pačia konfigūracija. Jis išsaugo tiesiai į konfigūracijos aplanką ir holyarrs bloko nereikalauja:

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

Naudok tuos pačius PUID ir PGID kaip programa, kitaip konfigūracijos aplankas perduodamas 1000:1000. PUID naudotojas turi galėti perskaityti failą. Jei naudoji HOLYARRS_MASTER_KEY_FILE, vienkartiniam konteineriui duok tą patį kintamąjį ir prijungimą.

Paleidimas dar kartą

Paleisti dar kartą saugu. Sutampantys įrašai parašo unchanged; išsaugomi tik pasikeitę.

Įrašas	Sutapatinamas pagal
Šaltiniai	vardą
Atsisiuntimo programos, medijos serveriai	tipą ir adresą
Pranešimai	vardą ir tipą
Subtitrų svetainės, ankstesnės programos	tipą

Šaltinis ar atsisiuntimo programa, kurios adresas ar raktas pasikeitė, pristabdoma iš naujo. Kai pats ją tęsi, pakartotinis paleidimas jos neliečia. Tuščias api_key indexers įraše palieka išsaugotą raktą; pridėk clear_key: true, kad jį pašalintum.

Ištrink failą

Su -delete komanda perrašo failą nuliais ir jį pašalina, tik po paleidimo, kuriame viskas pavyko. Tik skaitymui prijungto failo iš konteinerio vidaus ištrinti negalima, todėl ištrink jį pagrindiniame kompiuteryje:

Sistema	Komanda
Linux	shred -u holyarrs-secrets.yaml
macOS	rm -P holyarrs-secrets.yaml
Windows	Remove-Item holyarrs-secrets.yaml, tada ištuštink šiukšlinę.

SSD diskuose ir copy-on-write failų sistemose seni blokai gali likti diske. Patys raktai dabar yra užšifruotoje saugykloje.

Jei neveikia

Požymis	Priežastis	Sprendimas
Failą gali skaityti kiti naudotojai	Per laisvos teisės.	Vykdyk chmod 600. Windows aplinkoje laikyk jį aplanke, kurį gali atidaryti tik tu.
Nežinomas raktas sustabdė importą	Rašybos klaida arba tabuliavimo ženklas nurodytoje eilutėje.	Pataisyk tą eilutę. Nieko neišsaugota.
Paprastas http atmestas	holyarrs adresas nėra šiame kompiuteryje.	Vykdyk konteinerio viduje su http://127.0.0.1:6262 arba naudok https.
Namuose esanti Atsisiuntimo programa neatsako	Nėra vietinio tinklo teisės.	Tame bloke nustatyk allow_local_network: true.
Vienkartinis konteineris pakeitė aplankų savininkus	Kitokie PUID/PGID.	Naudok programos PUID ir PGID.
-delete nieko nepadarė	Kažkas nepavyko arba prijungimas tik skaitymui.	Ištrink jį pagrindiniame kompiuteryje.

Pažengusiems

Vėliavėlės ir išėjimo kodai

Vėliavėlė	Ką daro	Numatytoji
-file <path>	Paslapčių failas.	nėra
-dry-run	Tik pasako, kas būtų nustatyta.	išjungta
-config <folder>	Konfigūracijos aplankas.	/config
-delete	Po paleidimo be nesėkmių perrašo failą nuliais ir jį ištrina.	išjungta
-forget-move-credentials	Ištrina kiekvieną išsaugotą ankstesnės programos raktą ir sustoja.	išjungta
-allow-http-lan	Leidžia paprastą http:// į namų tinklo adresą. Parašo įspėjimą.	išjungta
-allow-readable-file	Priima failą, kurį gali skaityti kiti naudotojai. Docker Desktop Windows sistemoje kiekvienas failas atrodo skaitomas.	išjungta

holyarrs adresas turi būti https:// arba paprastas http:// tik į šį kompiuterį (127.0.0.1, ::1, localhost). Per paprastą http tavo savininko raktas ir visas failas keliauja neužšifruoti.

Išėjimo kodas	Reikšmė
0	Kiekvienas įrašas pavyko.
1	Įrašas nepavyko. Pataisyk failą ir paleisk dar kartą.
2	Bloga komandų eilutė arba failas.

Išvestis

Viena eilutė kiekvienam įrašui: set (arba would set bandomajame paleidime, kartais su pastaba), unchanged, skipped (empty), skipped (why) arba failed: why. Ji niekada neišspausdina rakto, slaptažodžio, token ar adreso. Istorija gauna vieną įvykį tik su skaičiais. Klaida, kuri parodytų reikšmę iš tavo failo, vietoj jos rodo [hidden].

Failo formatas

Maža, griežta YAML dalis:

• blokai pagal įtraukas tarpais, niekada tabuliavimo ženklais; sąrašai su - ,
• reikšmės paprastos, "double quotes" arba 'single quotes' (' viengubose kabutėse rašyk du kartus),
• # pradeda komentarą eilutės pradžioje arba po tarpo už kabučių ribų, todėl slaptažodį, kuriame yra #, įrašyk kabutėse,
• reikšmę, prasidedančią &, *, !, |, >, [, {, %, @ ar atvirkštiniu apostrofu arba turinčią : , įrašyk kabutėse.

Nežinomas raktas arba didesnis nei 256 KB failas sustabdo visą importą, kol nieko neišsaugota; pranešime nurodomas raktas ir eilutė. Nuoroda į failą atmetama.

Ypatingi laukai

Laukas	Taisyklė
SABnzbd	Reikia viso api_key. nzb_key, naudotojo vardas ar slaptažodis praleidžiami ir niekada nesaugomi.
tvdb.api_key, tvdb.unique_user_key, trakt.redirect_urls	Priimami ir praleidžiami.
smtp.host	Tik serverio vardas, be schemos ir porto.
smtp.port	Nuo 1 iki 65535. Numatytasis 587.
smtp.from	Vienas paprastas el. pašto adresas.
Ankstesnių programų blokai	Naudojami Import from other apps su Use the saved key (naudoti išsaugotą raktą). Niekada nerodomi, tik savininkui, ištrinami po vieno sėkmingo perskaitymo.

Susiję puslapiai

• Ankstesnių programų skaitymas
• Aplinkos kintamieji