Impordi võtmed failist

Täida üks fail oma allikate, allalaadijate, meediaserverite, subtiitrite saitide ja e-postiga, impordi see ning jäta iga võtme käsitsi seadetesse sisestamine vahele.

Enne alustamist

• HolyArrs töötab Dockeris ja tema seadete kaust on /config.
• Sa saad teha omaniku API-võtme jaotises Settings > API > API keys (seaded > API > API-võtmed).

Impordi fail

1. Kopeeri holyarrs-secrets.template.yaml nimega holyarrs-secrets.yaml.

2. Täida see, mida kasutad. Ülejäänu jäta tühjaks; tühi tähendab vahelejätmist.

3. Tee see loetavaks ainult sulle:

   chmod 600 holyarrs-secrets.yaml

4. Haaka see konteinerisse kirjutuskaitstult:

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

5. Tee omaniku API-võti admin skoobiga jaotises Settings > API > API keys. Pane see faili holyarrs plokki koos aadressiga http://127.0.0.1:6262.

6. Proovi kuivkäivitust. See ei muuda midagi:

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

   Näed ühe would set rea iga kirje kohta.

7. Käivita see päriselt (sama käsk ilma -dry-run). Näed set ridu ja väljumiskoodi 0.

8. Kontrolli uusi allikaid ja allalaadijaid ning lase neil tööd jätkata. Testi uusi meediaservereid ja teavitusi, siis lülita need sisse.

9. Kustuta fail hostis (vaata Kustuta fail). Kustuta ka API-võti, kui sa seda enam ei vaja.

Caution

Fail hoiab kõiki saladusi lihttekstina, kuni sa selle kustutad. Kustuta see hostis kohe, kui käivitus on õnnestunud.

Mis igast plokist saab

Failis	Muutub
trakt.client_id	Trakti rakenduse võtmeks (Settings > Outside lists (seaded > välised loendid)).
tmdb, tvdb	Võetakse vastu vanematest failidest. Metaandmed ei vaja võtmeid.
opensubtitles, subdl	Subtiitrite sait sinu kontoga.
addic7ed	Addic7edi subtiitrite sait, ainult sarjad.
indexers	Üks allikas kirje kohta, paused (peatatud).
jackett, prowlarr	Nende võti täidab iga indexers kirje samal aadressil, millel võtit pole.
qbittorrent, sabnzbd	Allalaadija, paused.
nzbget, transmission, deluge	Jäetakse vahele. Import ei oska neid veel seadistada; lisa need jaotises Settings > Downloaders (seaded > allalaadijad).
jellyfin, emby, plex	Meediaserver, off (väljas), kuni sa seda testid.
smtp, discord, webhook	Teavitused „Email“, „Discord“ ja „Webhook“, off, kuni sa neid testid.
radarr, sonarr, lidarr, prowlarr, bazarr, seerr	Võti, mis salvestatakse funktsiooni Import from other apps (import teistest rakendustest) jaoks.
holyarrs	Kasutatakse ainult HolyArrsini jõudmiseks, kui see töötab. Ei salvestata kunagi.

Iga võti läheb krüpteeritud hoidlasse, täpselt nagu seadetesse sisestatu.

Valikud

Kohtvõrgu lüliti

Iga aadressiga plokk võib võtta allow_local_network: true. See lubab sellel kirjel ulatuda sellesse arvutisse või sinu koduvõrku (192.168.x.x, 10.x.x.x, konteineri nimi). Ilma selleta ulatub kirje ainult internetti, nii et kodune allalaadija ei vasta. HolyArrs ei oleta seda kunagi aadressi järgi. See on sama lüliti nagu May reach the local network (võib ulatuda kohtvõrku) seadetes.

Kui HolyArrs on peatatud

Käivita ühekordne konteiner samal seadete kaustal. See salvestab otse seadete kausta ega vaja holyarrs plokki:

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

Kasuta samu PUID ja PGID mis rakendus, muidu antakse seadete kaust üle kasutajale 1000:1000. PUID kasutaja peab suutma faili lugeda. Kui kasutad HOLYARRS_MASTER_KEY_FILE, anna ühekordsele konteinerile sama muutuja ja haakepunkt.

Uuesti käivitamine

Uuesti käivitamine on ohutu. Sobivad kirjed ütlevad unchanged; salvestatakse ainult muutunud kirjed.

Kirje	Sobitatakse
Allikad	nime järgi
Allalaadijad, meediaserverid	liigi ja aadressi järgi
Teavitused	nime ja liigi järgi
Subtiitrite saidid, vanemad rakendused	liigi järgi

Allikas või allalaadija, mille aadress või võti muutus, peatatakse uuesti. Kui oled ühe ise jätkanud, jätab uuesti käivitamine selle tööle. Tühi api_key indexers kirjel hoiab salvestatud võtme alles; lisa clear_key: true, et see eemaldada.

Kustuta fail

Lipuga -delete kirjutab käsk faili nullidega üle ja eemaldab selle, ainult pärast käivitust, kus midagi ei ebaõnnestunud. Kirjutuskaitstud haakepunkti ei saa konteineri seest kustutada, seega kustuta see hostis:

Süsteem	Käsk
Linux	shred -u holyarrs-secrets.yaml
macOS	rm -P holyarrs-secrets.yaml
Windows	Remove-Item holyarrs-secrets.yaml, siis tühjenda prügikast.

SSD-del ja copy-on-write failisüsteemides võivad vanad plokid kettale jääda. Võtmed ise on nüüd krüpteeritud hoidlas.

Kui see ei tööta

Sümptom	Põhjus	Lahendus
Fail on teistele kasutajatele loetav	Õigused on liiga lahtised.	Käivita chmod 600. Windowsis hoia see kaustas, mida saad avada ainult sina.
Tundmatu võti peatas impordi	Kirjaviga või tabulaator nimetatud real.	Paranda see rida. Midagi ei salvestatud.
Lihtne http lükati tagasi	holyarrs aadress ei ole sellel arvutil.	Käivita konteineri sees aadressiga http://127.0.0.1:6262 või kasuta https-i.
Kodune allalaadija ei vasta	Kohtvõrgu luba puudub.	Sea sellel plokil allow_local_network: true.
Ühekordne konteiner muutis kaustade omanikke	Erinevad PUID/PGID.	Kasuta rakenduse PUID ja PGID.
-delete ei teinud midagi	Midagi ebaõnnestus või haakepunkt on kirjutuskaitstud.	Kustuta see hostis.

Asjatundjale

Lipud ja väljumiskoodid

Lipp	Mida teeb	Vaikeväärtus
-file <path>	Saladuste fail.	pole
-dry-run	Ütleb ainult, mis seataks.	väljas
-config <folder>	Seadete kaust.	/config
-delete	Pärast käivitust ilma tõrgeteta kirjutab faili nullidega üle ja kustutab selle.	väljas
-forget-move-credentials	Kustutab iga salvestatud vana rakenduse võtme, siis peatub.	väljas
-allow-http-lan	Lubab lihtsa http:// koduvõrgu aadressile. Prindib hoiatuse.	väljas
-allow-readable-file	Võtab vastu faili, mida teised kasutajad võivad lugeda. Docker Desktop Windowsis näitab iga faili loetavana.	väljas

holyarrs aadress peab olema https:// või lihtne http:// ainult sellesse arvutisse (127.0.0.1, ::1, localhost). Lihtsa http kaudu liiguvad sinu omaniku võti ja kogu fail krüpteerimata.

Väljumiskood	Tähendus
0	Iga kirje läks hästi.
1	Kirje ebaõnnestus. Paranda fail ja käivita uuesti.
2	Halb käsurida või fail.

Väljund

Üks rida kirje kohta: set (või would set kuivkäivituses, mõnikord märkusega), unchanged, skipped (empty), skipped (why) või failed: why. See ei prindi kunagi võtit, parooli, tokenit ega aadressi. Ajalugu saab ühe sündmuse ainult arvudega. Viga, mis näitaks väärtust sinu failist, näitab selle asemel [hidden].

Faili vorming

Väike range osa YAML-ist:

• plokid taande järgi tühikutega, mitte kunagi tabulaatoritega; loendid - abil,
• väärtused lihtsalt, "double quotes" või 'single quotes' (kirjuta ' ühekordsete jutumärkide sees kaks korda),
• # alustab kommentaari rea alguses või pärast tühikut väljaspool jutumärke, seega pane jutumärkidesse parool, mis sisaldab #,
• pane jutumärkidesse väärtus, mis algab sümboliga &, *, !, |, >, [, {, %, @ või tagurpidi ülakomaga, või mis sisaldab : .

Tundmatu võti või üle 256 KB fail peatab kogu impordi enne, kui midagi salvestatakse; teade nimetab võtme ja rea. Faili asemel antud link lükatakse tagasi.

Erilised väljad

Väli	Reegel
SABnzbd	Vajab täielikku api_key. nzb_key, kasutajanimi või parool jäetakse vahele ja neid ei salvestata kunagi.
tvdb.api_key, tvdb.unique_user_key, trakt.redirect_urls	Võetakse vastu ja jäetakse vahele.
smtp.host	Ainult serveri nimi, ilma skeemi ja pordita.
smtp.port	1 kuni 65535. Vaikimisi 587.
smtp.from	Üks lihtne e-posti aadress.
Vanade rakenduste plokid	Kasutatakse funktsioonis Import from other apps koos Use the saved key (kasuta salvestatud võtit). Neid ei näidata kunagi, ainult omanikule, kustutatakse pärast ühte edukat lugemist.

Seotud lehed

• Loe oma vanu rakendusi
• Keskkonnamuutujad