Importa le chiavi da un file

Compila un solo file con le tue Fonti, i downloader, i server multimediali, i siti di sottotitoli e le email, importalo, senza dover scrivere ogni chiave nelle Impostazioni.

Prima di iniziare

• HolyArrs gira in Docker con la sua configurazione in /config.
• Puoi creare una chiave API del proprietario in Settings > API > API keys (Impostazioni > API > chiavi API).

Importa il file

1. Copia holyarrs-secrets.template.yaml in holyarrs-secrets.yaml.

2. Compila quello che usi. Lascia vuoto il resto; vuoto significa salta.

3. Rendilo leggibile solo da te:

   chmod 600 holyarrs-secrets.yaml

4. Montalo in sola lettura nel container:

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

5. Crea una chiave API del proprietario con l’ambito admin in Settings > API > API keys. Mettila nel blocco holyarrs del file, con l’indirizzo http://127.0.0.1:6262.

6. Prova con una simulazione. Non cambia nulla:

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

   Dovresti vedere una riga would set per ogni voce.

7. Eseguilo davvero (lo stesso comando senza -dry-run). Dovresti vedere righe set e il codice di uscita 0.

8. Controlla le nuove Fonti e i nuovi downloader, poi riprendili. Prova i nuovi server multimediali e gli avvisi, poi attivali.

9. Elimina il file sull’host (vedi Elimina il file). Elimina anche la chiave API se non ti serve più.

Attenzione

Il file contiene ogni segreto in chiaro finché non lo elimini. Eliminalo sull’host appena l’esecuzione riesce.

In che cosa si trasforma ogni blocco

Nel file	Diventa
trakt.client_id	La chiave dell’app Trakt (Settings > Outside lists, cioè Impostazioni > Liste esterne).
tmdb, tvdb	Accettati dai file più vecchi. I metadati non richiedono chiavi.
opensubtitles, subdl	Un sito di sottotitoli con il tuo account.
addic7ed	Un sito di sottotitoli Addic7ed, solo per le serie.
indexers	Una Fonte per ogni voce, in pausa.
jackett, prowlarr	La loro chiave riempie ogni voce di indexers con lo stesso indirizzo che non ha una chiave.
qbittorrent, sabnzbd	Un downloader, in pausa.
nzbget, transmission, deluge	Saltati. L’importazione non può ancora configurarli; aggiungili in Settings > Downloaders.
jellyfin, emby, plex	Un server multimediale, disattivato finché non lo provi.
smtp, discord, webhook	Gli avvisi “Email”, “Discord” e “Webhook”, disattivati finché non li provi.
radarr, sonarr, lidarr, prowlarr, bazarr, seerr	Una chiave salvata per Move from other apps (passa da altre app).
holyarrs	Serve solo per raggiungere HolyArrs mentre gira. Non viene mai salvato.

Ogni chiave va nel archivio cifrato, come se l’avessi scritta nelle Impostazioni.

Scelte

L’interruttore della rete locale

Ogni blocco con un indirizzo può avere allow_local_network: true. Permette a quella voce di raggiungere questo computer o la tua rete di casa (192.168.x.x, 10.x.x.x, il nome di un container). Senza, la voce raggiunge solo internet, quindi un downloader di casa non risponde. HolyArrs non lo deduce mai dall’indirizzo. È lo stesso interruttore di May reach the local network (può raggiungere la rete locale) nelle Impostazioni.

Con HolyArrs fermo

Esegui un container usa e getta sulla stessa configurazione. Salva direttamente nella cartella di configurazione e non ha bisogno del blocco holyarrs:

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

Usa gli stessi PUID e PGID dell’app, altrimenti la cartella di configurazione passa a 1000:1000. L’utente PUID deve poter leggere il file. Se usi HOLYARRS_MASTER_KEY_FILE, dai al container usa e getta la stessa variabile e lo stesso mount.

Eseguirlo di nuovo

Si può rieseguire senza problemi. Le voci uguali dicono unchanged; vengono salvate solo quelle cambiate.

Voce	Riconosciuta da
Fonti	nome
Downloader, server multimediali	tipo e indirizzo
Avvisi	nome e tipo
Siti di sottotitoli, app precedenti	tipo

Una Fonte o un downloader il cui indirizzo o la cui chiave è cambiato viene messo di nuovo in pausa. Se ne riprendi uno tu, una nuova esecuzione lo lascia attivo. Un api_key vuoto in una voce di indexers tiene la chiave salvata; aggiungi clear_key: true per rimuoverla.

Elimina il file

Con -delete, il comando sovrascrive il file con zeri e lo rimuove, solo dopo un’esecuzione senza errori. Da dentro il container non si può eliminare un file montato in sola lettura, quindi eliminalo sull’host:

Sistema	Comando
Linux	shred -u holyarrs-secrets.yaml
macOS	rm -P holyarrs-secrets.yaml
Windows	Remove-Item holyarrs-secrets.yaml, poi svuota il Cestino.

Sugli SSD e sui filesystem copy-on-write, i vecchi blocchi possono restare sul disco. Le chiavi ormai vivono nel archivio cifrato.

Se non funziona

Sintomo	Causa	Soluzione
Il file è leggibile da altri utenti	Permessi troppo aperti.	Esegui chmod 600. Su Windows, tienilo in una cartella che apri solo tu.
Una chiave sconosciuta ha fermato l’importazione	Un errore di battitura o una tabulazione nella riga indicata.	Correggi quella riga. Non è stato salvato nulla.
http semplice rifiutato	L’indirizzo holyarrs non è su questo computer.	Eseguilo dentro il container con http://127.0.0.1:6262, oppure usa https.
Un downloader di casa non risponde	Manca il permesso per la rete locale.	Imposta allow_local_network: true su quel blocco.
Il container usa e getta ha cambiato i proprietari delle cartelle	PUID/PGID diversi.	Usa i PUID e PGID dell’app.
-delete non ha fatto nulla	Qualcosa è fallito, oppure il mount è in sola lettura.	Eliminalo sull’host.

Per esperti

Opzioni e codici di uscita

Opzione	Cosa fa	Predefinito
-file <path>	Il file dei segreti.	nessuno
-dry-run	Dice solo cosa verrebbe impostato.	disattivo
-config <folder>	La cartella di configurazione.	/config
-delete	Dopo un’esecuzione senza errori, sovrascrive il file con zeri e lo elimina.	disattivo
-forget-move-credentials	Elimina ogni chiave salvata delle app precedenti, poi si ferma.	disattivo
-allow-http-lan	Permette http:// semplice verso un indirizzo della rete di casa. Stampa un’avvertenza.	disattivo
-allow-readable-file	Accetta un file che altri utenti possono leggere. Docker Desktop su Windows mostra ogni file come leggibile.	disattivo

L’indirizzo holyarrs deve essere https://, oppure http:// semplice solo verso questo computer (127.0.0.1, ::1, localhost). Con http semplice la tua chiave del proprietario e l’intero file viaggiano non cifrati.

Codice di uscita	Significato
0	Ogni voce è andata bene.
1	Una voce è fallita. Correggi il file ed esegui di nuovo.
2	Riga di comando o file non validi.

Output

Una riga per voce: set (o would set in una simulazione, a volte con una nota), unchanged, skipped (empty), skipped (why) o failed: why. Non stampa mai una chiave, una password, un token o un indirizzo. La Cronologia riceve un solo evento, con i soli conteggi. Un errore che mostrerebbe un valore del tuo file mostra invece [hidden].

Formato del file

Una parte piccola e rigorosa di YAML:

• blocchi per indentazione con spazi, mai tabulazioni; elenchi con - ,
• valori semplici, tra "double quotes" o 'single quotes' (scrivi un ' dentro le virgolette singole due volte),
• # inizia un commento a inizio riga o dopo uno spazio fuori dalle virgolette, quindi metti tra virgolette una password che contiene #,
• metti tra virgolette un valore che inizia con &, *, !, |, >, [, {, %, @ o un apice inverso, o che contiene : .

Una chiave sconosciuta o un file sopra i 256 KB ferma l’intera importazione prima che venga salvato qualcosa; il messaggio indica la chiave e la riga. Un link simbolico al file viene rifiutato.

Campi speciali

Campo	Regola
SABnzbd	Richiede l’api_key completa. Una nzb_key, un nome utente o una password vengono saltati e non vengono mai salvati.
tvdb.api_key, tvdb.unique_user_key, trakt.redirect_urls	Accettati e saltati.
smtp.host	Solo il nome del server, senza schema né porta.
smtp.port	Da 1 a 65535. Predefinito 587.
smtp.from	Un solo indirizzo email semplice.
Blocchi delle app precedenti	Usati in Move from other apps con Use the saved key (usa la chiave salvata). Mai mostrati, solo per il proprietario, eliminati dopo una lettura riuscita.

Correlati

• Lettura delle app precedenti
• Variabili d’ambiente