Importer nøkler fra en fil

Fyll ut én fil med kildene, nedlasterne, medieserverne, undertekstsidene og e-posten din, importer den, og slipp å skrive inn hver nøkkel i Settings (innstillinger).

Før du begynner

• HolyArrs kjører i Docker med konfigurasjonen i /config.
• Du kan lage en eier-API-nøkkel i Settings > API > API keys (innstillinger > API > API-nøkler).

Importer filen

1. Kopier holyarrs-secrets.template.yaml til holyarrs-secrets.yaml.

2. Fyll inn det du bruker. La resten stå tomt. Tomt betyr hopp over.

3. Gjør den lesbar bare for deg:

   chmod 600 holyarrs-secrets.yaml

4. Monter den skrivebeskyttet i containeren:

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

5. Lag en eier-API-nøkkel med tillatelsen admin i Settings > API > API keys. Legg den i blokken holyarrs i filen, sammen med adressen http://127.0.0.1:6262.

6. Prøv en tørrkjøring. Den endrer ingenting:

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

   Du skal se én would set-linje per element.

7. Kjør den på ordentlig (samme kommando uten -dry-run). Du skal se set-linjer og avslutningskode 0.

8. Sjekk de nye kildene og nedlasterne, og sett dem i gang igjen. Test de nye medieserverne og varslene, og slå dem på.

9. Slett filen på hosten (se Slett filen). Slett også API-nøkkelen hvis du ikke trenger den lenger.

Advarsel

Filen inneholder alle hemmelighetene i ren tekst helt til du sletter den. Slett den på hosten så snart kjøringen har lyktes.

Hva hver blokk blir til

I filen	Blir til
trakt.client_id	Trakt-appnøkkelen (Settings > Outside lists, innstillinger > eksterne lister).
tmdb, tvdb	Godtas fra eldre filer. Metadata trenger ingen nøkler.
opensubtitles, subdl	En undertekstside med kontoen din.
addic7ed	En Addic7ed-undertekstside, bare for serier.
indexers	Én kilde per oppføring, satt på pause.
jackett, prowlarr	Nøkkelen deres fyller ut hver indexers-oppføring på samme adresse som mangler nøkkel.
qbittorrent, sabnzbd	En nedlaster, satt på pause.
nzbget, transmission, deluge	Hoppes over. Importen kan ikke sette opp disse ennå. Legg dem til i Settings > Downloaders.
jellyfin, emby, plex	En medieserver, av til du tester den.
smtp, discord, webhook	Varslene «Email», «Discord» og «Webhook», av til du tester dem.
radarr, sonarr, lidarr, prowlarr, bazarr, seerr	En nøkkel lagret for Import from other apps (importer fra andre apper).
holyarrs	Brukes bare for å nå HolyArrs mens den kjører. Lagres aldri.

Hver nøkkel havner i det krypterte hvelvet, akkurat som en som er skrevet inn i Settings.

Valg

Bryteren for lokalt nettverk

Hver blokk med en adresse kan ta allow_local_network: true. Den lar elementet nå denne maskinen eller hjemmenettverket ditt (192.168.x.x, 10.x.x.x, et containernavn). Uten den når elementet bare internett, så en nedlaster hjemme svarer ikke. HolyArrs gjetter aldri dette ut fra adressen. Det er den samme bryteren som May reach the local network (kan nå det lokale nettverket) i Settings.

Med HolyArrs stoppet

Kjør en engangscontainer på den samme konfigurasjonen. Den lagrer rett i konfigurasjonsmappen og trenger ingen 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

Bruk de samme PUID og PGID som appen, ellers overtas konfigurasjonsmappen av 1000:1000. Brukeren som PUID peker på, må kunne lese filen. Hvis du bruker HOLYARRS_MASTER_KEY_FILE, gir du engangscontaineren den samme variabelen og monteringen.

Kjøre den på nytt

Det er trygt å kjøre den på nytt. Elementer som stemmer, sier unchanged. Bare endrede elementer lagres.

Element	Matches på
Kilder	navn
Nedlastere, medieservere	type og adresse
Varsler	navn og type
Undertekstsider, tidligere apper	type

En kilde eller nedlaster der adressen eller nøkkelen er endret, settes på pause igjen. Når du selv har satt en i gang igjen, lar en ny kjøring den gå. En tom api_key på en indexers-oppføring beholder den lagrede nøkkelen. Legg til clear_key: true for å fjerne den.

Slett filen

Med -delete overskriver kommandoen filen med nuller og fjerner den, men bare etter en kjøring der ingenting feilet. En skrivebeskyttet montering kan ikke slettes fra inni containeren, så slett den på hosten:

System	Kommando
Linux	shred -u holyarrs-secrets.yaml
macOS	rm -P holyarrs-secrets.yaml
Windows	Remove-Item holyarrs-secrets.yaml, og tøm deretter papirkurven.

På SSD-er og filsystemer med copy-on-write kan gamle blokker bli liggende på disken. Selve nøklene ligger nå i det krypterte hvelvet.

Hvis det ikke fungerer

Symptom	Årsak	Løsning
Filen kan leses av andre brukere	Tillatelsene er for åpne.	Kjør chmod 600. På Windows legger du den i en mappe bare du kan åpne.
En ukjent nøkkel stoppet importen	Skrivefeil eller en tabulator på linjen som er nevnt.	Rett opp den linjen. Ingenting ble lagret.
Vanlig http ble avvist	Adressen holyarrs er ikke på denne maskinen.	Kjør inni containeren med http://127.0.0.1:6262, eller bruk https.
En nedlaster hjemme svarer ikke	Ingen tillatelse for lokalt nettverk.	Sett allow_local_network: true på den blokken.
Engangscontaineren endret eier av mappene	Annen PUID/PGID.	Bruk PUID og PGID til appen.
-delete gjorde ingenting	Noe feilet, eller monteringen er skrivebeskyttet.	Slett den på hosten.

For viderekomne

Flagg og avslutningskoder

Flagg	Hva det gjør	Standard
-file <path>	Hemmelighetsfilen.	ingen
-dry-run	Si bare hva som ville blitt satt.	av
-config <folder>	Konfigurasjonsmappen.	/config
-delete	Etter en kjøring uten feil overskrives filen med nuller og slettes.	av
-forget-move-credentials	Slett hver lagrede nøkkel fra tidligere apper, og stopp deretter.	av
-allow-http-lan	Tillat vanlig http:// til en adresse på hjemmenettverket. Skriver ut en advarsel.	av
-allow-readable-file	Godta en fil som andre brukere kan lese. Docker Desktop på Windows viser hver fil som lesbar.	av

Adressen holyarrs må være https://, eller vanlig http:// bare til denne maskinen (127.0.0.1, ::1, localhost). Over vanlig http sendes eiernøkkelen din og hele filen ukryptert.

Avslutningskode	Betydning
0	Hvert element gikk bra.
1	Et element feilet. Rett opp filen og kjør på nytt.
2	Ugyldig kommandolinje eller fil.

Utskrift

Én linje per element: set (eller would set i en tørrkjøring, noen ganger med en merknad), unchanged, skipped (empty), skipped (why) eller failed: why. Den skriver aldri ut en nøkkel, et passord, et token eller en adresse. Historikken får én hendelse med bare tall. En feil som ville vist en verdi fra filen din, viser [hidden] i stedet.

Filformat

En liten, streng del av YAML:

• blokker ved innrykk med mellomrom, aldri tabulatorer; lister med - ,
• verdier skrevet rett fram, i "double quotes" eller 'single quotes' (skriv en ' inni enkle anførselstegn to ganger),
• # starter en kommentar i starten av en linje eller etter et mellomrom utenfor anførselstegn, så sett et passord som inneholder # i anførselstegn,
• sett en verdi i anførselstegn hvis den begynner med &, *, !, |, >, [, {, %, @ eller en bakoverrettet apostrof, eller hvis den inneholder : .

En ukjent nøkkel eller en fil over 256 KB stopper hele importen før noe er lagret. Meldingen nevner nøkkelen og linjen. En lenke til filen avvises.

Spesialfelt

Felt	Regel
SABnzbd	Trenger hele api_key. En nzb_key, et brukernavn eller et passord hoppes over og lagres aldri.
tvdb.api_key, tvdb.unique_user_key, trakt.redirect_urls	Godtas og hoppes over.
smtp.host	Bare servernavnet, uten skjema eller port.
smtp.port	1 til 65535. Standard 587.
smtp.from	Én vanlig e-postadresse.
Blokker for tidligere apper	Brukes i Import from other apps med Use the saved key (bruk den lagrede nøkkelen). Vises aldri, bare for eieren, slettes etter én vellykket lesing.

Relatert

• Les de tidligere appene dine
• Miljøvariabler