Importera nycklar från en fil

Fyll i en enda fil med dina källor, nedladdare, mediaservrar, undertextsidor och e-post, importera den och slipp skriva in varje nyckel i inställningarna.

Innan du börjar

• HolyArrs körs i Docker med konfigurationen på /config.
• Du kan skapa en ägar-API-nyckel under Settings > API > API keys (inställningar > API > API-nycklar).

Importera filen

1. Kopiera holyarrs-secrets.template.yaml till holyarrs-secrets.yaml.

2. Fyll i det du använder. Lämna resten tomt; tomt betyder hoppa över.

3. Gör den läsbar bara för dig:

   chmod 600 holyarrs-secrets.yaml

4. Montera den skrivskyddat i containern:

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

5. Skapa en ägar-API-nyckel med behörighetsnivån admin under Settings > API > API keys. Lägg den i filens holyarrs-block med adressen http://127.0.0.1:6262.

6. Gör en provkörning. Den ändrar ingenting:

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

   Du ska se en would set-rad per post.

7. Kör det på riktigt (samma kommando utan -dry-run). Du ska se set-rader och slutkod 0.

8. Kontrollera nya källor och nedladdare och återuppta dem sedan. Testa nya mediaservrar och aviseringar och slå sedan på dem.

9. Radera filen på hosten (se Radera filen). Radera också API-nyckeln om du inte behöver den längre.

Caution

Filen innehåller alla hemligheter i klartext tills du raderar den. Radera den på hosten så fort körningen lyckats.

Vad varje block blir

I filen	Blir
trakt.client_id	Traktappens nyckel (Settings > Outside lists, inställningar > externa listor).
tmdb, tvdb	Accepteras från äldre filer. Metadata behöver inga nycklar.
opensubtitles, subdl	En undertextsida med ditt konto.
addic7ed	En Addic7ed-undertextsida, bara serier.
indexers	En källa per post, pausad.
jackett, prowlarr	Deras nyckel fyller i varje indexers-post på samma adress som saknar nyckel.
qbittorrent, sabnzbd	En nedladdare, pausad.
nzbget, transmission, deluge	Hoppas över. Importen kan inte konfigurera dessa än; lägg till dem under Settings > Downloaders (inställningar > nedladdare).
jellyfin, emby, plex	En mediaserver, av tills du testar den.
smtp, discord, webhook	Aviseringarna ”Email”, ”Discord” och ”Webhook”, av tills du testar dem.
radarr, sonarr, lidarr, prowlarr, bazarr, seerr	En nyckel som sparas för Import from other apps (importera från andra appar).
holyarrs	Används bara för att nå HolyArrs medan den körs. Sparas aldrig.

Varje nyckel hamnar i det krypterade valvet, precis som en som skrivs in i inställningarna.

Val

Reglaget för lokalt nätverk

Varje block med en adress kan ta allow_local_network: true. Det låter posten nå den här datorn eller ditt hemmanätverk (192.168.x.x, 10.x.x.x, ett containernamn). Utan det når posten bara internet, så en nedladdare hemma svarar inte. HolyArrs gissar aldrig detta utifrån adressen. Det är samma reglage som May reach the local network (får nå det lokala nätverket) i inställningarna.

Med HolyArrs stoppad

Kör en engångscontainer på samma konfiguration. Den sparar direkt i konfigurationsmappen och behöver inget holyarrs-block:

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

Använd samma PUID och PGID som appen, annars överlämnas konfigurationsmappen till 1000:1000. Användaren PUID måste kunna läsa filen. Om du använder HOLYARRS_MASTER_KEY_FILE, ge engångscontainern samma variabel och montering.

Köra den igen

Det är säkert att köra den igen. Poster som matchar säger unchanged; bara ändrade poster sparas.

Post	Matchas på
Källor	namn
Nedladdare, mediaservrar	typ och adress
Aviseringar	namn och typ
Undertextsidor, tidigare appar	typ

En källa eller nedladdare vars adress eller nyckel ändrats pausas igen. När du själv har återupptagit en lämnar en ny körning den igång. En tom api_key på en indexers-post behåller den sparade nyckeln; lägg till clear_key: true för att ta bort den.

Radera filen

Med -delete skriver kommandot över filen med nollor och tar bort den, men bara efter en körning där inget misslyckades. En skrivskyddad montering kan inte raderas inifrån containern, så radera den på hosten:

System	Kommando
Linux	shred -u holyarrs-secrets.yaml
macOS	rm -P holyarrs-secrets.yaml
Windows	Remove-Item holyarrs-secrets.yaml, töm sedan papperskorgen.

På SSD-diskar och filsystem med copy-on-write kan gamla block ligga kvar på disken. Själva nycklarna finns nu i det krypterade valvet.

Om det inte fungerar

Symptom	Orsak	Lösning
Filen är läsbar för andra användare	Behörigheterna är för öppna.	Kör chmod 600. På Windows, ha den i en mapp som bara du kan öppna.
En okänd nyckel stoppade importen	Stavfel eller en tabb på den angivna raden.	Rätta den raden. Ingenting sparades.
Vanlig http nekades	Adressen i holyarrs finns inte på den här datorn.	Kör inuti containern med http://127.0.0.1:6262, eller använd https.
En nedladdare hemma svarar inte	Ingen behörighet till det lokala nätverket.	Sätt allow_local_network: true på det blocket.
Engångscontainern ändrade mapparnas ägare	Annan PUID/PGID.	Använd appens PUID och PGID.
-delete gjorde ingenting	Något misslyckades, eller så är monteringen skrivskyddad.	Radera den på hosten.

För experter

Flaggor och slutkoder

Flagga	Vad den gör	Standard
-file <path>	Hemlighetsfilen.	ingen
-dry-run	Säg bara vad som skulle sättas.	av
-config <folder>	Konfigurationsmappen.	/config
-delete	Efter en körning utan fel, skriv över filen med nollor och radera den.	av
-forget-move-credentials	Radera varje sparad nyckel från tidigare appar och avsluta sedan.	av
-allow-http-lan	Tillåt vanlig http:// till en adress i hemmanätverket. Skriver ut en varning.	av
-allow-readable-file	Acceptera en fil som andra användare kan läsa. Docker Desktop på Windows visar varje fil som läsbar.	av

Adressen i holyarrs måste vara https://, eller vanlig http:// bara till den här datorn (127.0.0.1, ::1, localhost). Över vanlig http färdas din ägarnyckel och hela filen okrypterade.

Slutkod	Betydelse
0	Varje post gick bra.
1	En post misslyckades. Rätta filen och kör igen.
2	Felaktig kommandorad eller fil.

Utskrift

En rad per post: set (eller would set vid provkörning, ibland med en anmärkning), unchanged, skipped (empty), skipped (why) eller failed: why. Den skriver aldrig ut en nyckel, ett lösenord, en token eller en adress. Historiken får en enda händelse med bara antal. Ett fel som skulle visa ett värde från din fil visar [hidden] i stället.

Filformat

En liten, strikt del av YAML:

• block med indrag av blanksteg, aldrig tabbar; listor med - ,
• värden utan citattecken, inom "double quotes" eller 'single quotes' (skriv ett ' inuti enkla citattecken två gånger),
• # inleder en kommentar i början av en rad eller efter ett blanksteg utanför citattecken, så sätt citattecken runt ett lösenord som innehåller #,
• sätt citattecken runt ett värde som börjar med &, *, !, |, >, [, {, %, @ eller ett bakåtlutande citattecken, eller som innehåller : .

En okänd nyckel eller en fil över 256 KB stoppar hela importen innan något sparas; meddelandet nämner nyckeln och raden. En länk till filen nekas.

Specialfält

Fält	Regel
SABnzbd	Behöver hela api_key. En nzb_key, ett användarnamn eller ett lösenord hoppas över och sparas aldrig.
tvdb.api_key, tvdb.unique_user_key, trakt.redirect_urls	Accepteras och hoppas över.
smtp.host	Bara servernamn, inget schema eller port.
smtp.port	1 till 65535. Standard 587.
smtp.from	En vanlig e-postadress.
Block från tidigare appar	Används i Import from other apps med Use the saved key (använd den sparade nyckeln). Visas aldrig, bara för ägaren, raderas efter en lyckad läsning.

Relaterat

• Läs dina tidigare appar
• Miljövariabler