Sari la conținut

Importă chei dintr-un fișier

Configurare

Completează un singur fișier cu Sursele, programele de descărcare, serverele media, site-urile de subtitrări și emailul tău, importă-l și nu mai scrie fiecare cheie în Setări.

  • HolyArrs rulează în Docker, cu configurarea în /config.
  • Poți face o cheie API de proprietar în Settings > API > API keys (Setări > API > chei API).
  1. Copiază holyarrs-secrets.template.yaml în holyarrs-secrets.yaml.

  2. Completează ce folosești. Lasă restul gol; gol înseamnă că se sare peste.

  3. Fă-l lizibil doar pentru tine:

    Terminal window
    chmod 600 holyarrs-secrets.yaml
  4. Montează-l doar pentru citire în container:

    volumes:
    - /srv/holyarrs/config:/config
    - /srv/holyarrs/holyarrs-secrets.yaml:/run/secrets/holyarrs.yaml:ro
  5. Fă o cheie API de proprietar cu scopul admin în Settings > API > API keys. Pune-o în blocul holyarrs al fișierului, cu adresa http://127.0.0.1:6262.

  6. Încearcă o rulare de probă. Nu schimbă nimic:

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

    Ar trebui să vezi câte o linie would set pentru fiecare element.

  7. Rulează-l pe bune (aceeași comandă, fără -dry-run). Ar trebui să vezi linii set și codul de ieșire 0.

  8. Verifică Sursele și programele de descărcare noi, apoi reia-le. Testează serverele media și Alertele noi, apoi pornește-le.

  9. Șterge fișierul de pe gazdă (vezi Șterge fișierul). Șterge și cheia API dacă nu mai ai nevoie de ea.

În ce se transformă fiecare bloc

Link către În ce se transformă fiecare bloc
În fișier Devine
trakt.client_id Cheia aplicației Trakt (Settings > Outside lists, adică Setări > Liste externe).
tmdb, tvdb Acceptate din fișiere mai vechi. Metadatele nu cer chei.
opensubtitles, subdl Un site de subtitrări cu contul tău.
addic7ed Un site de subtitrări Addic7ed, doar pentru seriale.
indexers Câte o Sursă pentru fiecare intrare, pusă pe pauză.
jackett, prowlarr Cheia lor completează orice intrare indexers de la aceeași adresă care nu are cheie.
qbittorrent, sabnzbd Un program de descărcare, pus pe pauză.
nzbget, transmission, deluge Sărite. Importul nu le poate configura încă; adaugă-le în Settings > Downloaders.
jellyfin, emby, plex Un server media, oprit până îl testezi.
smtp, discord, webhook Alertele „Email”, „Discord” și „Webhook”, oprite până le testezi.
radarr, sonarr, lidarr, prowlarr, bazarr, seerr O cheie salvată pentru Import from other apps (importă din alte aplicații).
holyarrs Folosit doar ca să ajungă la HolyArrs cât timp rulează. Nu se salvează niciodată.

Fiecare cheie intră în seiful criptat, la fel ca una scrisă în Setări.

Comutatorul pentru rețeaua locală

Link către Comutatorul pentru rețeaua locală

Fiecare bloc cu adresă poate primi allow_local_network: true. Îi lasă elementului acces la acest aparat sau la rețeaua ta de acasă (192.168.x.x, 10.x.x.x, un nume de container). Fără el, elementul ajunge doar pe internet, așa că un program de descărcare de acasă nu va răspunde. HolyArrs nu ghicește niciodată asta din adresă. E același comutator ca May reach the local network din Setări.

Rulează un container de o singură dată pe aceeași configurare. Salvează direct în dosarul de configurare și nu are nevoie de blocul holyarrs:

Terminal window
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

Folosește aceleași PUID și PGID ca aplicația, altfel dosarul de configurare trece la 1000:1000. Utilizatorul PUID trebuie să poată citi fișierul. Dacă folosești HOLYARRS_MASTER_KEY_FILE, dă containerului de o singură dată aceeași variabilă și același montaj.

E sigur să-l rulezi din nou. Elementele care se potrivesc spun unchanged; se salvează doar cele schimbate.

Element Potrivit după
Surse nume
Programe de descărcare, servere media fel și adresă
Alerte nume și fel
Site-uri de subtitrări, aplicații mai vechi fel

O Sursă sau un program de descărcare a cărui adresă sau cheie s-a schimbat e pus din nou pe pauză. După ce îl reiei tu, o rulare nouă îl lasă pornit. Un api_key gol la o intrare indexers păstrează cheia salvată; adaugă clear_key: true ca să o ștergi.

Cu -delete, comanda suprascrie fișierul cu zerouri și îl șterge, doar după o rulare în care nimic nu a eșuat. Un montaj doar pentru citire nu se poate șterge din interiorul containerului, așa că șterge-l de pe gazdă:

Sistem Comandă
Linux shred -u holyarrs-secrets.yaml
macOS rm -P holyarrs-secrets.yaml
Windows Remove-Item holyarrs-secrets.yaml, apoi golește Coșul de reciclare.

Pe SSD-uri și pe sisteme de fișiere copy-on-write, blocurile vechi pot rămâne pe disc. Cheile în sine trăiesc acum în seiful criptat.

Simptom Cauză Soluție
Fișierul poate fi citit de alți utilizatori Permisiuni prea largi. Rulează chmod 600. Pe Windows, ține-l într-un dosar pe care îl poți deschide doar tu.
O cheie necunoscută a oprit importul Greșeală de scriere sau un tab pe linia numită. Corectează linia. Nu s-a salvat nimic.
Http simplu refuzat Adresa holyarrs nu e pe acest aparat. Rulează în container cu http://127.0.0.1:6262 sau folosește https.
Un program de descărcare de acasă nu răspunde Fără permisiune pentru rețeaua locală. Setează allow_local_network: true pe blocul acela.
Containerul de o singură dată a schimbat proprietarii dosarelor PUID/PGID diferite. Folosește PUID și PGID ale aplicației.
-delete n-a făcut nimic Ceva a eșuat sau montajul e doar pentru citire. Șterge-l de pe gazdă.
Opțiuni și coduri de ieșire
Opțiune Ce face Implicit
-file <path> Fișierul cu secrete. niciunul
-dry-run Spune doar ce s-ar seta. oprit
-config <folder> Dosarul de configurare. /config
-delete După o rulare fără eșecuri, suprascrie fișierul cu zerouri și îl șterge. oprit
-forget-move-credentials Șterge fiecare cheie salvată a aplicațiilor mai vechi, apoi se oprește. oprit
-allow-http-lan Permite http:// simplu către o adresă din rețeaua de acasă. Afișează un avertisment. oprit
-allow-readable-file Acceptă un fișier pe care îl pot citi și alți utilizatori. Docker Desktop pe Windows arată fiecare fișier ca fiind lizibil. oprit

Adresa holyarrs trebuie să fie https:// sau http:// simplu doar către acest aparat (127.0.0.1, ::1, localhost). Prin http simplu, cheia ta de proprietar și tot fișierul călătoresc necriptate.

Cod de ieșire Ce înseamnă
0 Fiecare element a mers bine.
1 Un element a eșuat. Corectează fișierul și rulează din nou.
2 Linie de comandă sau fișier greșit.
Rezultat

O linie pentru fiecare element: set (sau would set la o rulare de probă, uneori cu o notă), unchanged, skipped (empty), skipped (why) sau failed: why. Nu afișează niciodată o cheie, o parolă, un token sau o adresă. Istoricul primește un singur eveniment, doar cu numere. O eroare care ar arăta o valoare din fișierul tău arată în schimb [hidden].

Formatul fișierului

O parte mică și strictă din YAML:

  • blocuri prin indentare cu spații, niciodată taburi; liste cu - ,
  • valori simple, în "double quotes" sau 'single quotes' (scrie un ' în interiorul ghilimelelor simple de două ori),
  • # începe un comentariu la început de linie sau după un spațiu, în afara ghilimelelor, așa că pune între ghilimele o parolă care conține #,
  • pune între ghilimele o valoare care începe cu &, *, !, |, >, [, {, %, @ sau un apostrof invers ori care conține : .

O cheie necunoscută sau un fișier de peste 256 KB oprește tot importul înainte să se salveze ceva; mesajul numește cheia și linia. O legătură către fișier e refuzată.

Câmpuri speciale
Câmp Regulă
SABnzbd Cere api_key complet. Un nzb_key, un nume de utilizator sau o parolă sunt sărite și nu se stochează niciodată.
tvdb.api_key, tvdb.unique_user_key, trakt.redirect_urls Acceptate și sărite.
smtp.host Doar numele serverului, fără schemă sau port.
smtp.port 1 până la 65535. Implicit 587.
smtp.from O singură adresă de email simplă.
Blocuri pentru aplicații mai vechi Folosite în Import from other apps cu Use the saved key (folosește cheia salvată). Nu se arată niciodată, doar pentru proprietar, șterse după o singură citire reușită.

HolyArrs este gratuit. Dacă ți-a economisit timp, dă-i o stea pe GitHub, sponsorizează-l sau cumpără-mi o cafea.