Importér nøgler fra en fil

Udfyld én fil med dine kilder, downloadere, medieservere, undertekstsider og mail, importér den, og slip for at skrive hver nøgle ind i Indstillinger.

Før du begynder

• HolyArrs kører i Docker med sin konfiguration i /config.
• Du kan lave en API-nøgle som ejer under Settings > API > API keys (indstillinger > API > API-nøgler).

Importér filen

1. Kopiér holyarrs-secrets.template.yaml til holyarrs-secrets.yaml.

2. Udfyld det, du bruger. Lad resten stå tomt; tomt betyder spring over.

3. Gør den kun læsbar for dig:

   chmod 600 holyarrs-secrets.yaml

4. Montér den skrivebeskyttet i containeren:

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

5. Lav en API-nøgle som ejer med scopet admin under Settings > API > API keys. Skriv den i filens holyarrs-blok sammen med adressen http://127.0.0.1:6262.

6. Prøv en tørkørsel. Den ændrer ingenting:

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

   Du bør kunne se én would set-linje pr. punkt.

7. Kør den for alvor (samme kommando uden -dry-run). Du bør kunne se set-linjer og exitkode 0.

8. Tjek nye kilder og downloadere, og genoptag dem derefter. Test nye medieservere og beskeder, og slå dem derefter til.

9. Slet filen på hosten (se Slet filen). Slet også API-nøglen, hvis du ikke har brug for den længere.

Bemærk

Filen indeholder alle hemmeligheder som almindelig tekst, indtil du sletter den. Slet den på hosten, så snart kørslen er lykkedes.

Hvad hver blok bliver til

I filen	Bliver til
trakt.client_id	Trakt-appens nøgle (Settings > Outside lists (indstillinger > eksterne lister)).
tmdb, tvdb	Accepteres fra ældre filer. Metadata kræver ingen nøgler.
opensubtitles, subdl	En undertekstside med din konto.
addic7ed	En Addic7ed-undertekstside, kun serier.
indexers	Én kilde pr. post, på pause.
jackett, prowlarr	Deres nøgle udfylder enhver indexers-post på samme adresse, der ikke har en nøgle.
qbittorrent, sabnzbd	En downloader, på pause.
nzbget, transmission, deluge	Springes over. Importen kan ikke sætte dem op endnu; tilføj dem under Settings > Downloaders.
jellyfin, emby, plex	En medieserver, slået fra, indtil du tester den.
smtp, discord, webhook	Beskederne “Email”, “Discord” og “Webhook”, slået fra, indtil du tester dem.
radarr, sonarr, lidarr, prowlarr, bazarr, seerr	En nøgle gemt til Import from other apps (import fra andre apps).
holyarrs	Bruges kun til at nå HolyArrs, mens den kører. Bliver aldrig gemt.

Hver nøgle lægges i det krypterede pengeskab, på samme måde som en nøgle, du skriver i Indstillinger.

Valg

Kontakten til det lokale netværk

Hver blok med en adresse kan tage allow_local_network: true. Den lader punktet nå denne computer eller dit hjemmenetværk (192.168.x.x, 10.x.x.x, et containernavn). Uden den når punktet kun internettet, så en downloader derhjemme ikke svarer. HolyArrs gætter aldrig dette ud fra adressen. Det er den samme kontakt som May reach the local network (må nå det lokale netværk) i Indstillinger.

Mens HolyArrs er stoppet

Kør en engangscontainer på den samme konfiguration. Den gemmer direkte i konfigurationsmappen og har ikke brug for en holyarrs-blok:

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

Brug samme PUID og PGID som appen, ellers bliver konfigurationsmappen givet til 1000:1000. Brugeren med det PUID skal kunne læse filen. Hvis du bruger HOLYARRS_MASTER_KEY_FILE, skal du give engangscontaineren den samme variabel og mount.

Kør den igen

Det er sikkert at køre den igen. Punkter, der matcher, siger unchanged; kun ændrede punkter bliver gemt.

Punkt	Matches på
Kilder	navn
Downloadere, medieservere	type og adresse
Beskeder	navn og type
Undertekstsider, tidligere apps	type

En kilde eller downloader, hvis adresse eller nøgle er ændret, bliver sat på pause igen. Når du selv har genoptaget en, lader en ny kørsel den køre. En tom api_key på en indexers-post beholder den gemte nøgle; tilføj clear_key: true for at fjerne den.

Slet filen

Med -delete overskriver kommandoen filen med nuller og fjerner den, kun efter en kørsel, hvor intet fejlede. En skrivebeskyttet mount kan ikke slettes inde fra containeren, så slet 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 derefter papirkurven.

På SSD’er og copy-on-write-filsystemer kan gamle blokke blive liggende på disken. Selve nøglerne ligger nu i det krypterede pengeskab.

Hvis det ikke virker

Symptom	Årsag	Løsning
Filen kan læses af andre brugere	Rettighederne er for åbne.	Kør chmod 600. På Windows skal du lægge den i en mappe, kun du kan åbne.
En ukendt nøgle stoppede importen	Tastefejl eller en tabulator på den nævnte linje.	Ret den linje. Intet blev gemt.
Almindelig http afvist	Adressen i holyarrs er ikke på denne computer.	Kør inde i containeren med http://127.0.0.1:6262, eller brug https.
En downloader derhjemme svarer ikke	Ingen tilladelse til det lokale netværk.	Sæt allow_local_network: true på den blok.
Engangscontaineren ændrede mappeejere	Anden PUID/PGID.	Brug appens PUID og PGID.
-delete gjorde ingenting	Noget fejlede, eller mounten er skrivebeskyttet.	Slet den på hosten.

For erfarne

Flag og exitkoder

Flag	Hvad det gør	Standard
-file <path>	Hemmelighedsfilen.	ingen
-dry-run	Siger kun, hvad der ville blive sat.	fra
-config <folder>	Konfigurationsmappen.	/config
-delete	Efter en kørsel uden fejl overskrives filen med nuller og slettes.	fra
-forget-move-credentials	Sletter hver gemt nøgle fra tidligere apps og stopper derefter.	fra
-allow-http-lan	Tillader almindelig http:// til en adresse på hjemmenetværket. Skriver en advarsel.	fra
-allow-readable-file	Accepterer en fil, andre brugere kan læse. Docker Desktop på Windows viser hver fil som læsbar.	fra

Adressen i holyarrs skal være https://, eller almindelig http:// kun til denne computer (127.0.0.1, ::1, localhost). Over almindelig http sendes din ejernøgle og hele filen ukrypteret.

Exitkode	Betydning
0	Hvert punkt gik godt.
1	Et punkt fejlede. Ret filen og kør igen.
2	Forkert kommandolinje eller fil.

Output

Én linje pr. punkt: set (eller would set ved en tørkørsel, nogle gange med en bemærkning), unchanged, skipped (empty), skipped (why) eller failed: why. Den skriver aldrig en nøgle, adgangskode, et token eller en adresse. Historik får én hændelse med kun tal. En fejl, der ville vise en værdi fra din fil, viser [hidden] i stedet.

Filformat

En lille, streng del af YAML:

• blokke ved indrykning med mellemrum, aldrig tabulatorer; lister med - ,
• værdier almindelige, i "double quotes" eller 'single quotes' (skriv et ' inde i enkelte anførselstegn to gange),
• # starter en kommentar i begyndelsen af en linje eller efter et mellemrum uden for anførselstegn, så sæt anførselstegn om en adgangskode, der indeholder #,
• sæt anførselstegn om en værdi, der starter med &, *, !, |, >, [, {, %, @ eller et backtick, eller som indeholder : .

En ukendt nøgle eller en fil over 256 KB stopper hele importen, før noget bliver gemt; beskeden nævner nøglen og linjen. Et link til filen bliver afvist.

Særlige felter

Felt	Regel
SABnzbd	Kræver den fulde api_key. En nzb_key, et brugernavn eller en adgangskode springes over og bliver aldrig gemt.
tvdb.api_key, tvdb.unique_user_key, trakt.redirect_urls	Accepteres og springes over.
smtp.host	Kun servernavn, uden skema eller port.
smtp.port	1 til 65535. Standard 587.
smtp.from	Én almindelig e-mailadresse.
Blokke fra tidligere apps	Bruges i Import from other apps med Use the saved key (brug den gemte nøgle). Vises aldrig, kun for ejeren, slettes efter én vellykket læsning.

Se også

• Læs dine tidligere apps
• Miljøvariabler