Sleutels uit een bestand importeren

Vul één bestand in met je bronnen, downloaders, mediaservers, ondertitelsites en e-mail, importeer het en bespaar jezelf het typen van elke sleutel in de instellingen.

Voor je begint

• HolyArrs draait in Docker met de configuratie in /config.
• Je kunt een API-sleutel voor de eigenaar maken in Settings > API > API keys (instellingen > API > API-sleutels).

Het bestand importeren

1. Kopieer holyarrs-secrets.template.yaml naar holyarrs-secrets.yaml.

2. Vul in wat je gebruikt. Laat de rest leeg; leeg betekent overslaan.

3. Maak het alleen voor jezelf leesbaar:

   chmod 600 holyarrs-secrets.yaml

4. Koppel het alleen-lezen in de container:

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

5. Maak in Settings > API > API keys een API-sleutel voor de eigenaar met de scope admin. Zet die in het blok holyarrs van het bestand met het adres http://127.0.0.1:6262.

6. Probeer een proefrun. Die wijzigt niets:

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

   Je ziet nu één regel would set per item.

7. Voer het echt uit (hetzelfde commando zonder -dry-run). Je ziet regels met set en exitcode 0.

8. Controleer nieuwe bronnen en downloaders en hervat ze daarna. Test nieuwe mediaservers en meldingen en zet ze daarna aan.

9. Verwijder het bestand op de host (zie Het bestand verwijderen). Verwijder ook de API-sleutel als je hem niet meer nodig hebt.

Opgepast

Het bestand bevat elk geheim als platte tekst totdat je het verwijdert. Verwijder het op de host zodra de run is geslaagd.

Waar elk blok van wordt

In het bestand	Wordt
trakt.client_id	De app-sleutel van Trakt (Settings > Outside lists, externe lijsten).
tmdb, tvdb	Geaccepteerd uit oudere bestanden. Metadata heeft geen sleutels nodig.
opensubtitles, subdl	Een ondertitelsite met jouw account.
addic7ed	Een ondertitelsite voor Addic7ed, alleen series.
indexers	Eén bron per vermelding, gepauzeerd.
jackett, prowlarr	Hun sleutel vult elke vermelding in indexers op hetzelfde adres die geen sleutel heeft.
qbittorrent, sabnzbd	Een downloader, gepauzeerd.
nzbget, transmission, deluge	Overgeslagen. De import kan deze nog niet instellen; voeg ze toe in Settings > Downloaders.
jellyfin, emby, plex	Een mediaserver, uit totdat je hem test.
smtp, discord, webhook	De meldingen “Email”, “Discord” en “Webhook”, uit totdat je ze test.
radarr, sonarr, lidarr, prowlarr, bazarr, seerr	Een sleutel die wordt bewaard voor Move from other apps (overstappen van andere apps).
holyarrs	Wordt alleen gebruikt om HolyArrs te bereiken terwijl het draait. Wordt nooit opgeslagen.

Elke sleutel gaat in de versleutelde kluis, net als een sleutel die je in de instellingen typt.

Keuzes

De schakelaar voor het lokale netwerk

Elk blok met een adres kan allow_local_network: true bevatten. Daarmee mag dat item deze computer of je thuisnetwerk bereiken (192.168.x.x, 10.x.x.x, een containernaam). Zonder de schakelaar bereikt het item alleen internet, dus een downloader thuis antwoordt niet. HolyArrs leidt dit nooit af uit het adres. Het is dezelfde schakelaar als May reach the local network (mag het lokale netwerk bereiken) in de instellingen.

Met HolyArrs gestopt

Voer een eenmalige container uit op dezelfde configuratie. Die slaat rechtstreeks op in de configuratiemap en heeft geen blok holyarrs nodig:

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

Gebruik dezelfde PUID en PGID als de app, anders krijgt 1000:1000 de configuratiemap. De gebruiker van PUID moet het bestand kunnen lezen. Gebruik je HOLYARRS_MASTER_KEY_FILE, geef de eenmalige container dan dezelfde variabele en mount.

Opnieuw uitvoeren

Opnieuw uitvoeren is veilig. Overeenkomende items melden unchanged; alleen gewijzigde items worden opgeslagen.

Item	Gekoppeld op
Bronnen	naam
Downloaders, mediaservers	soort en adres
Meldingen	naam en soort
Ondertitelsites, eerdere apps	soort

Een bron of downloader waarvan het adres of de sleutel is gewijzigd, wordt opnieuw gepauzeerd. Heb je er zelf een hervat, dan laat een nieuwe run hem draaien. Een lege api_key bij een vermelding in indexers behoudt de opgeslagen sleutel; voeg clear_key: true toe om hem te verwijderen.

Het bestand verwijderen

Met -delete overschrijft het commando het bestand met nullen en verwijdert het, alleen na een run waarin niets is mislukt. Een alleen-lezen mount kan niet vanuit de container worden verwijderd, dus verwijder het op de host:

Systeem	Commando
Linux	shred -u holyarrs-secrets.yaml
macOS	rm -P holyarrs-secrets.yaml
Windows	Remove-Item holyarrs-secrets.yaml, daarna de prullenbak legen.

Op SSD’s en bestandssystemen met copy-on-write kunnen oude blokken op de schijf blijven staan. De sleutels zelf staan nu in de versleutelde kluis.

Als het niet werkt

Symptoom	Oorzaak	Oplossing
Het bestand is leesbaar voor andere gebruikers	Rechten te ruim.	Voer chmod 600 uit. Bewaar het op Windows in een map die alleen jij kunt openen.
Een onbekende sleutel stopte de import	Typfout of een tab op de genoemde regel.	Herstel die regel. Er is niets opgeslagen.
Gewone http geweigerd	Het adres van holyarrs staat niet op deze computer.	Voer het uit in de container met http://127.0.0.1:6262, of gebruik https.
Een downloader thuis antwoordt niet	Geen toestemming voor het lokale netwerk.	Zet allow_local_network: true in dat blok.
De eenmalige container wijzigde de eigenaars van mappen	Andere PUID/PGID.	Gebruik de PUID en PGID van de app.
-delete deed niets	Er is iets mislukt, of de mount is alleen-lezen.	Verwijder het op de host.

Voor gevorderden

Opties en exitcodes

Optie	Wat ze doet	Standaard
-file <path>	Het bestand met geheimen.	geen
-dry-run	Meldt alleen wat er zou worden ingesteld.	uit
-config <folder>	De configuratiemap.	/config
-delete	Overschrijft het bestand na een run zonder fouten met nullen en verwijdert het.	uit
-forget-move-credentials	Verwijdert elke opgeslagen sleutel van eerdere apps en stopt dan.	uit
-allow-http-lan	Staat gewone http:// naar een adres in het thuisnetwerk toe. Toont een waarschuwing.	uit
-allow-readable-file	Accepteert een bestand dat andere gebruikers mogen lezen. Docker Desktop op Windows toont elk bestand als leesbaar.	uit

Het adres van holyarrs moet https:// zijn, of gewone http:// naar alleen deze computer (127.0.0.1, ::1, localhost). Via gewone http reizen je eigenaarssleutel en het hele bestand onversleuteld.

Exitcode	Betekenis
0	Elk item is goed gegaan.
1	Een item is mislukt. Herstel het bestand en voer opnieuw uit.
2	Verkeerde opdrachtregel of verkeerd bestand.

Uitvoer

Eén regel per item: set (of would set bij een proefrun, soms met een opmerking), unchanged, skipped (empty), skipped (why) of failed: why. Er wordt nooit een sleutel, wachtwoord, token of adres getoond. De geschiedenis krijgt één gebeurtenis met alleen aantallen. Een fout die een waarde uit je bestand zou tonen, toont in plaats daarvan [hidden].

Bestandsindeling

Een klein, strikt deel van YAML:

• blokken door inspringing met spaties, nooit tabs; lijsten met - ,
• waarden gewoon, in "double quotes" of 'single quotes' (schrijf een ' binnen enkele aanhalingstekens twee keer),
• # begint een opmerking aan het begin van een regel of na een spatie buiten aanhalingstekens, dus zet een wachtwoord dat # bevat tussen aanhalingstekens,
• zet een waarde tussen aanhalingstekens als ze begint met &, *, !, |, >, [, {, %, @ of een backquote, of als ze : bevat.

Een onbekende sleutel of een bestand van meer dan 256 KB stopt de hele import voordat er iets is opgeslagen; de melding noemt de sleutel en de regel. Een link naar het bestand wordt geweigerd.

Bijzondere velden

Veld	Regel
SABnzbd	Heeft de volledige api_key nodig. Een nzb_key, gebruikersnaam of wachtwoord wordt overgeslagen en nooit opgeslagen.
tvdb.api_key, tvdb.unique_user_key, trakt.redirect_urls	Geaccepteerd en overgeslagen.
smtp.host	Alleen de servernaam, zonder schema of poort.
smtp.port	1 tot 65535. Standaard 587.
smtp.from	Eén gewoon e-mailadres.
Blokken van eerdere apps	Gebruikt in Move from other apps met Use the saved key (de opgeslagen sleutel gebruiken). Nooit getoond, alleen voor de eigenaar, verwijderd na één geslaagde leesactie.

Gerelateerde pagina’s

• Je eerdere apps lezen
• Omgevingsvariabelen