Importar chaves de um arquivo

Preencha um arquivo com suas Fontes, Gerenciadores de downloads, servidores de mídia, sites de legendas e e-mail, importe o arquivo e não precise digitar cada chave nas Configurações.

Antes de começar

• O HolyArrs funciona no Docker com a configuração em /config.
• Você consegue criar uma chave de API de dono em Settings > API > API keys (Configurações > API > chaves de API).

Importar o arquivo

1. Copie holyarrs-secrets.template.yaml para holyarrs-secrets.yaml.

2. Preencha o que você usa. Deixe o resto vazio; vazio significa pular.

3. Deixe o arquivo legível só por você:

   chmod 600 holyarrs-secrets.yaml

4. Monte o arquivo como somente leitura no container:

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

5. Crie uma chave de API de dono com o escopo admin em Settings > API > API keys. Coloque a chave no bloco holyarrs do arquivo, com o endereço http://127.0.0.1:6262.

6. Faça uma simulação. Ela não muda nada:

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

   Você deve ver uma linha would set por item.

7. Execute de verdade (o mesmo comando sem -dry-run). Você deve ver linhas set e o código de saída 0.

8. Verifique as novas Fontes e os novos Gerenciadores de downloads e depois retome cada um. Teste os novos servidores de mídia e Alertas e depois ative cada um.

9. Exclua o arquivo no host (veja Excluir o arquivo). Exclua também a chave de API, se você não precisar mais dela.

Cuidado

O arquivo guarda todos os segredos em texto puro até você excluir. Exclua o arquivo no host assim que a execução der certo.

O que cada bloco vira

No arquivo	Vira
trakt.client_id	A chave do app do Trakt (Settings > Outside lists (Configurações > Listas externas)).
tmdb, tvdb	Aceitos de arquivos mais antigos. Os metadados não precisam de chaves.
opensubtitles, subdl	Um site de legendas com sua conta.
addic7ed	Um site de legendas Addic7ed, só para séries.
indexers	Uma Fonte por entrada, paused (pausada).
jackett, prowlarr	A chave deles preenche qualquer entrada de indexers no mesmo endereço que não tenha chave.
qbittorrent, sabnzbd	Um Gerenciador de downloads, paused.
nzbget, transmission, deluge	Pulados. A importação ainda não consegue configurar esses; adicione cada um em Settings > Downloaders (Configurações > Gerenciadores de downloads).
jellyfin, emby, plex	Um servidor de mídia, off (desativado) até você testar.
smtp, discord, webhook	Os Alertas “Email”, “Discord” e “Webhook”, off até você testar.
radarr, sonarr, lidarr, prowlarr, bazarr, seerr	Uma chave salva para Move from other apps (migrar de outros apps).
holyarrs	Usado só para chegar ao HolyArrs enquanto ele está em execução. Nunca é salvo.

Toda chave vai para o cofre criptografado, igual a uma chave digitada nas Configurações.

Opções

A chave da rede local

Cada bloco com endereço aceita allow_local_network: true. Isso deixa aquele item alcançar este computador ou sua rede de casa (192.168.x.x, 10.x.x.x, um nome de container). Sem isso, o item alcança só a internet, então um Gerenciador de downloads em casa não responde. O HolyArrs nunca adivinha isso pelo endereço. É a mesma chave que May reach the local network (pode alcançar a rede local) nas Configurações.

Com o HolyArrs parado

Execute um container avulso com a mesma configuração. Ele salva direto na pasta de configuração e não precisa do bloco 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

Use os mesmos PUID e PGID do app, ou a pasta de configuração passa a pertencer a 1000:1000. O usuário do PUID precisa conseguir ler o arquivo. Se você usa HOLYARRS_MASTER_KEY_FILE, dê ao container avulso a mesma variável e a mesma montagem.

Executar de novo

Executar de novo é seguro. Os itens que batem mostram unchanged; só os itens que mudaram são salvos.

Item	Comparado por
Fontes	nome
Gerenciadores de downloads, servidores de mídia	tipo e endereço
Alertas	nome e tipo
Sites de legendas, apps anteriores	tipo

Uma Fonte ou um Gerenciador de downloads cujo endereço ou chave mudou é pausado de novo. Depois que você mesmo retoma um deles, uma nova execução deixa esse item funcionando. Um api_key vazio em uma entrada de indexers mantém a chave guardada; adicione clear_key: true para remover a chave.

Excluir o arquivo

Com -delete, o comando sobrescreve o arquivo com zeros e remove o arquivo, só depois de uma execução em que nada falhou. Uma montagem somente leitura não pode ser excluída de dentro do container, então exclua o arquivo no host:

Sistema	Comando
Linux	shred -u holyarrs-secrets.yaml
macOS	rm -P holyarrs-secrets.yaml
Windows	Remove-Item holyarrs-secrets.yaml, depois esvazie a Lixeira.

Em SSDs e em sistemas de arquivos copy-on-write, blocos antigos podem continuar no disco. As chaves em si agora ficam no cofre criptografado.

Se não funcionar

Sintoma	Causa	Solução
O arquivo pode ser lido por outros usuários	Permissões abertas demais.	Execute chmod 600. No Windows, guarde o arquivo em uma pasta que só você consegue abrir.
Uma chave desconhecida parou a importação	Erro de digitação ou uma tabulação na linha indicada.	Corrija essa linha. Nada foi salvo.
http simples recusado	O endereço de holyarrs não fica neste computador.	Execute dentro do container com http://127.0.0.1:6262, ou use https.
Um Gerenciador de downloads em casa não responde	Sem permissão para a rede local.	Defina allow_local_network: true nesse bloco.
O container avulso mudou os proprietários das pastas	PUID/PGID diferentes.	Use o PUID e o PGID do app.
-delete não fez nada	Alguma coisa falhou, ou a montagem é somente leitura.	Exclua o arquivo no host.

Para especialistas

Opções do comando e códigos de saída

Opção	O que faz	Padrão
-file <path>	O arquivo de segredos.	nenhum
-dry-run	Só diz o que seria definido.	desativado
-config <folder>	A pasta de configuração.	/config
-delete	Depois de uma execução sem falhas, sobrescreve o arquivo com zeros e exclui o arquivo.	desativado
-forget-move-credentials	Exclui todas as chaves salvas de apps anteriores e depois para.	desativado
-allow-http-lan	Permite http:// simples para um endereço da rede de casa. Mostra um aviso.	desativado
-allow-readable-file	Aceita um arquivo que outros usuários podem ler. O Docker Desktop no Windows mostra todos os arquivos como legíveis.	desativado

O endereço de holyarrs precisa ser https://, ou http:// simples só para este computador (127.0.0.1, ::1, localhost). Por http simples, sua chave de dono e o arquivo inteiro trafegam sem criptografia.

Código de saída	Significado
0	Todos os itens deram certo.
1	Um item falhou. Corrija o arquivo e execute de novo.
2	Linha de comando ou arquivo inválido.

Saída

Uma linha por item: set (ou would set em uma simulação, às vezes com uma observação), unchanged, skipped (empty), skipped (why) ou failed: why. O comando nunca mostra uma chave, senha, token ou endereço. O Histórico recebe um Evento só com contagens. Um erro que mostraria um valor do seu arquivo mostra [hidden] no lugar.

Formato do arquivo

Uma parte pequena e estrita do YAML:

• blocos por indentação com espaços, nunca tabulações; listas com - ,
• valores simples, entre "double quotes" ou 'single quotes' (escreva um ' dentro de aspas simples duas vezes),
• # começa um comentário no início da linha ou depois de um espaço fora das aspas, então coloque entre aspas uma senha que contenha #,
• coloque entre aspas um valor que comece com &, *, !, |, >, [, {, %, @ ou um acento grave, ou que contenha : .

Uma chave desconhecida ou um arquivo com mais de 256 KB interrompe a importação inteira antes de qualquer coisa ser salva; a mensagem informa a chave e a linha. Um link para o arquivo é recusado.

Campos especiais

Campo	Regra
SABnzbd	Precisa do api_key completo. Um nzb_key, nome de usuário ou senha é pulado e nunca é guardado.
tvdb.api_key, tvdb.unique_user_key, trakt.redirect_urls	Aceitos e pulados.
smtp.host	Só o nome do servidor, sem esquema nem porta.
smtp.port	1 a 65535. Padrão 587.
smtp.from	Um endereço de e-mail simples.
Blocos de apps anteriores	Usados em Move from other apps com Use the saved key (usar a chave salva). Nunca mostrados, só para o dono, excluídos depois de uma leitura bem-sucedida.

Relacionados

• Ler seus apps anteriores
• Variáveis de ambiente