Importa claus des d'un fitxer

Omple un sol fitxer amb les teves Fonts, gestors de baixades, servidors multimèdia, llocs de subtítols i correu, importa’l i estalvia’t escriure cada clau a Paràmetres.

Abans de començar

• HolyArrs s’executa a Docker amb la configuració a /config.
• Pots crear una clau d’API de propietari a Settings > API > API keys (Paràmetres > API > Claus d’API).

Importa el fitxer

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

2. Omple el que fas servir. Deixa la resta buit; buit vol dir que s’omet.

3. Fes que només el puguis llegir tu:

   chmod 600 holyarrs-secrets.yaml

4. Munta’l com a només lectura dins del contenidor:

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

5. Crea una clau d’API de propietari amb l’àmbit admin a Settings > API > API keys. Posa-la al bloc holyarrs del fitxer amb l’adreça http://127.0.0.1:6262.

6. Fes una execució de prova. No canvia res:

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

   Hauries de veure una línia would set per element.

7. Executa-ho de debò (la mateixa ordre sense -dry-run). Hauries de veure línies set i el codi de sortida 0.

8. Revisa les Fonts i els gestors de baixades nous, i després reprèn-los. Prova els servidors multimèdia i els Avisos nous, i després activa’ls.

9. Esborra el fitxer a l’host (mira Esborra el fitxer). Esborra també la clau d’API si ja no la necessites.

Precaució

El fitxer conté tots els secrets en text pla fins que l’esborres. Esborra’l a l’host tan bon punt l’execució hagi funcionat.

En què es converteix cada bloc

Al fitxer	Es converteix en
trakt.client_id	La clau de l’app de Trakt (Settings > Outside lists, és a dir, Paràmetres > Llistes externes).
tmdb, tvdb	S’accepten de fitxers antics. Les metadades no necessiten claus.
opensubtitles, subdl	Un lloc de subtítols amb el teu compte.
addic7ed	Un lloc de subtítols d’Addic7ed, només sèries.
indexers	Una Font per entrada, en pausa.
jackett, prowlarr	La seva clau omple qualsevol entrada d’indexers amb la mateixa adreça que no tingui clau.
qbittorrent, sabnzbd	Un gestor de baixades, en pausa.
nzbget, transmission, deluge	S’ometen. La importació encara no els pot configurar; afegeix-los a Settings > Downloaders (Paràmetres > Gestors de baixades).
jellyfin, emby, plex	Un servidor multimèdia, desactivat fins que el proves.
smtp, discord, webhook	Els Avisos “Email”, “Discord” i “Webhook”, desactivats fins que els proves.
radarr, sonarr, lidarr, prowlarr, bazarr, seerr	Una clau desada per a Import from other apps (importa des d’altres apps).
holyarrs	Només s’usa per arribar a HolyArrs mentre s’executa. No es desa mai.

Cada clau va a la caixa forta xifrada, igual que una que s’escriu a Paràmetres.

Opcions

L’interruptor de la xarxa local

Cada bloc amb una adreça pot tenir allow_local_network: true. Deixa que aquell element arribi a aquest equip o a la teva xarxa de casa (192.168.x.x, 10.x.x.x, el nom d’un contenidor). Sense això, l’element només arriba a internet, així que un gestor de baixades de casa no respondrà. HolyArrs no ho endevina mai a partir de l’adreça. És el mateix interruptor que May reach the local network (pot arribar a la xarxa local) a Paràmetres.

Amb HolyArrs aturat

Executa un contenidor d’un sol ús amb la mateixa configuració. Desa directament a la carpeta de configuració i no necessita el bloc 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

Fes servir els mateixos PUID i PGID que l’app, o la carpeta de configuració passa a 1000:1000. L’usuari del PUID ha de poder llegir el fitxer. Si uses HOLYARRS_MASTER_KEY_FILE, dona al contenidor d’un sol ús la mateixa variable i el mateix muntatge.

Executar-ho de nou

Executar-ho de nou no té risc. Els elements que coincideixen diuen unchanged; només es desen els que han canviat.

Element	Es reconeix per
Fonts	nom
Gestors de baixades, servidors multimèdia	tipus i adreça
Avisos	nom i tipus
Llocs de subtítols, apps anteriors	tipus

Una Font o un gestor de baixades que ha canviat d’adreça o de clau es posa en pausa de nou. Un cop en reprens un tu mateix, una nova execució el deixa funcionant. Una api_key buida en una entrada d’indexers conserva la clau desada; afegeix clear_key: true per eliminar-la.

Esborra el fitxer

Amb -delete, l’ordre sobreescriu el fitxer amb zeros i l’elimina, només després d’una execució en què no ha fallat res. Un muntatge de només lectura no es pot esborrar des de dins del contenidor, així que esborra’l a l’host:

Sistema	Ordre
Linux	shred -u holyarrs-secrets.yaml
macOS	rm -P holyarrs-secrets.yaml
Windows	Remove-Item holyarrs-secrets.yaml, i després buida la paperera de reciclatge.

En SSD i en sistemes de fitxers de còpia en escriure, els blocs antics poden quedar al disc. Les claus mateixes ara viuen a la caixa forta xifrada.

Si no funciona

Símptoma	Causa	Solució
El fitxer el poden llegir altres usuaris	Els permisos són massa oberts.	Executa chmod 600. A Windows, desa’l en una carpeta que només puguis obrir tu.
Una clau desconeguda ha aturat la importació	Una errada de tecleig o un tabulador a la línia indicada.	Corregeix aquesta línia. No s’ha desat res.
S’ha rebutjat http simple	L’adreça de holyarrs no és d’aquest equip.	Executa-ho dins del contenidor amb http://127.0.0.1:6262, o fes servir https.
Un gestor de baixades de casa no respon	Falta el permís de xarxa local.	Defineix allow_local_network: true en aquell bloc.
El contenidor d’un sol ús ha canviat els propietaris de la carpeta	PUID/PGID diferents.	Fes servir els PUID i PGID de l’app.
-delete no ha fet res	Ha fallat alguna cosa, o el muntatge és de només lectura.	Esborra’l a l’host.

Per a experts

Indicadors i codis de sortida

Indicador	Què fa	Per defecte
-file <path>	El fitxer de secrets.	cap
-dry-run	Només diu què es definiria.	desactivat
-config <folder>	La carpeta de configuració.	/config
-delete	Després d’una execució sense errors, sobreescriu el fitxer amb zeros i l’esborra.	desactivat
-forget-move-credentials	Esborra totes les claus desades d’apps anteriors i després s’atura.	desactivat
-allow-http-lan	Permet http:// simple a una adreça de la xarxa de casa. Mostra una advertència.	desactivat
-allow-readable-file	Accepta un fitxer que poden llegir altres usuaris. Docker Desktop a Windows mostra tots els fitxers com a llegibles.	desactivat

L’adreça de holyarrs ha de ser https://, o http:// simple només a aquest equip (127.0.0.1, ::1, localhost). Amb http simple, la teva clau de propietari i tot el fitxer viatgen sense xifrar.

Codi de sortida	Significat
0	Tots els elements han anat bé.
1	Un element ha fallat. Corregeix el fitxer i executa-ho de nou.
2	Línia d’ordres o fitxer incorrectes.

Sortida

Una línia per element: set (o would set en una execució de prova, de vegades amb una nota), unchanged, skipped (empty), skipped (why) o failed: why. No mostra mai una clau, una contrasenya, un token ni una adreça. L’Historial rep un Event amb només recomptes. Un error que mostraria un valor del teu fitxer mostra [hidden] en el seu lloc.

Format del fitxer

Una part petita i estricta de YAML:

• blocs per sagnat amb espais, mai tabuladors; llistes amb - ,
• valors simples, entre "double quotes" o 'single quotes' (escriu un ' dins de cometes simples dues vegades),
• # comença un comentari a l’inici de la línia o després d’un espai fora de cometes, així que posa entre cometes una contrasenya que contingui #,
• posa entre cometes un valor que comenci per &, *, !, |, >, [, {, %, @ o una cometa inversa, o que contingui : .

Una clau desconeguda o un fitxer de més de 256 KB atura tota la importació abans de desar res; el missatge nomena la clau i la línia. Un enllaç al fitxer es rebutja.

Camps especials

Camp	Regla
SABnzbd	Necessita l’api_key completa. Una nzb_key, un nom d’usuari o una contrasenya s’ometen i no es desen mai.
tvdb.api_key, tvdb.unique_user_key, trakt.redirect_urls	S’accepten i s’ometen.
smtp.host	Només el nom del servidor, sense esquema ni port.
smtp.port	De l’1 al 65535. Per defecte 587.
smtp.from	Una adreça d’email simple.
Blocs d’apps anteriors	S’usen a Import from other apps amb Use the saved key (usa la clau desada). No es mostren mai, només per al propietari, i s’esborren després d’una lectura correcta.

Relacionat

• Llegeix les teves apps anteriors
• Variables d’entorn