Variáveis de ambiente

Todas as variáveis que o container do HolyArrs lê. A maioria das instalações define só PUID, PGID e TZ.

Comuns

Variável	O que faz	Padrão	Exemplo
PUID, PGID	Usuário e grupo com que o HolyArrs é executado. Precisam ser os proprietários de /config e das suas pastas de mídia.	1000, 1000	PUID=1000
TZ	Fuso horário dos agendamentos e dos logs.	Etc/UTC	TZ=Europe/Amsterdam
UMASK	Bits de permissão que os arquivos novos deixam de fora. Só vale para arquivos novos.	022	UMASK=002
HOLYARRS_SAVE_PATH	A pasta onde o gerenciador de downloads salva, como o gerenciador de downloads a vê. Vai junto com cada download.	nenhum	/data/downloads
HOLYARRS_URL_BASE	Serve o HolyArrs em um caminho atrás de um proxy reverso. / ignora um caminho salvo em Configurações.	nenhum	/holyarrs
HOLYARRS_ALLOWED_HOSTS	Outros nomes de host que as pessoas usam para chegar ao HolyArrs, separados por vírgula.	IPs e localhost	holyarrs.example.com
HOLYARRS_TRUSTED_PROXIES	O endereço ou a rede do seu proxy reverso, separados por vírgula. Necessário para ver os endereços reais dos clientes.	nenhum	172.18.0.0/16
HOLYARRS_MASTER_KEY_FILE	Lê a chave mestra do cofre de um arquivo próprio. O usuário do PUID precisa conseguir ler esse arquivo.	/config/holyarrs.key	/keys/holyarrs.key

Valores vindos de arquivos

Coloque FILE__ na frente de qualquer variável para ler o valor de um arquivo, como um secret do Docker.

environment:
  - FILE__HOLYARRS_ALLOWED_HOSTS=/run/secrets/holyarrs_hosts

O HolyArrs descarta uma quebra de linha no fim do arquivo. Se o arquivo não existir, o HolyArrs para e o log mostra o nome da variável e do arquivo, nunca o valor.

Recuperação e solução de problemas

Variável	O que faz	Padrão	Exemplo
HOLYARRS_SAFE_MODE	Inicia só o núcleo: login, Biblioteca, configurações, backups e saúde. Remova depois de resolver o problema.	desativado	1
HOLYARRS_LOW_MEMORY	1 força o modo de pouca memória ativado, 0 força desativado. Sem valor, o modo é ativado com cerca de 2.5 GiB de RAM ou menos.	conforme o tamanho do computador	1
GOMEMLIMIT	Substitui a meta de memória que o HolyArrs define para si mesmo.	definido pelo HolyArrs	1GiB
HOLYARRS_SKIP_SPACE_CHECK	Pula a verificação de espaço livre antes de uma atualização do banco de dados.	desativado	yes
HOLYARRS_CONFIG_IN_MEMORY	Permite /config em uma pasta que fica na memória. Para computadores de teste; os dados se perdem ao reiniciar.	desativado	yes
HOLYARRS_ALLOW_DESKTOP_FOLDER	Inicia com /config em uma pasta compartilhada do Docker Desktop em um Mac, depois de você conferir que os bloqueios de arquivo funcionam ali. O HolyArrs avisa a cada início.	desativado	1
HOLYARRS_READONLY_DOWNLOADERS	Gerenciadores de downloads que o HolyArrs nunca deve alterar, por id ou endereço, separados por vírgula.	nenhum	3,http://qbit:8080
HOLYARRS_HEALTH_URL	Endereço que a verificação de saúde do container chama.	http://127.0.0.1:6262	http://127.0.0.1:6262/holyarrs

As variáveis de ativar/desativar aceitam 1, true, yes ou on.

Login único (SSO)

Defina estas variáveis antes de iniciar. Se HOLYARRS_OIDC_ENABLED estiver presente, mesmo como false, o ambiente passa a mandar no login único e Configurações só mostra os valores. As variáveis de ativar/desativar daqui aceitam só true ou false; qualquer outro valor impede o início.

Variável	O que faz	Padrão
HOLYARRS_OIDC_ENABLED	Ativa o login único.	false
HOLYARRS_OIDC_ISSUER	O emissor HTTPS exato do provedor.	nenhum
HOLYARRS_OIDC_CLIENT_ID	Id de cliente registrado.	nenhum
HOLYARRS_OIDC_CLIENT_SECRET_FILE	Arquivo com o segredo do cliente, de no máximo 4096 bytes. Deixe de fora para um cliente público.	nenhum
HOLYARRS_OIDC_REDIRECT_URL	Endereço de retorno exato: seu endereço, a URL base se houver, e depois /api/v1/auth/oidc/callback.	nenhum
HOLYARRS_OIDC_ALLOW_JOIN	Pessoas novas entram como membros que só podem pedir.	false
HOLYARRS_OIDC_ALLOW_LOCAL_NETWORK	Permite um provedor na sua rede privada.	false
HOLYARRS_OIDC_ALLOW_LOOPBACK_HTTP	Permite HTTP simples neste computador, para testes.	false
HOLYARRS_FORWARD_AUTH_ENABLED	Ativa o login por proxy confiável.	false
HOLYARRS_FORWARD_AUTH_ISSUER	Nome HTTPS estável do proxy.	nenhum
HOLYARRS_FORWARD_AUTH_TRUSTED_PEERS	Endereços ou faixas de proxy que podem enviar cabeçalhos de identidade, separados por vírgula.	nenhum
HOLYARRS_FORWARD_AUTH_ALLOW_JOIN	Nomes novos vindos do proxy entram como membros que só podem pedir.	false

Uma configuração errada impede o HolyArrs de iniciar. Os passos estão em Login e senhas.

Para especialistas

Metadados

Variável	O que faz	Padrão
HOLYARRS_METADATA_URL	O endereço do servidor de metadados.	https://api.holyarrs.com
HOLYARRS_TMDB_KEY	Seu próprio token de acesso de leitura do TMDB. Com ele definido, as leituras do TMDB vão direto ao TMDB em vez de passar pelo servidor de metadados.	nenhum
HOLYARRS_METADATA_SERVICE_TOKEN_FILE	Arquivo com a credencial desta instalação para o servidor de metadados, lido a cada chamada. Sem valor, a credencial fica no cofre.	nenhum

Atalhos do primeiro início

Cada uma adiciona um item no início. Servem para demonstrações e testes; o assistente da primeira execução faz o mesmo.

Variável	Adiciona
HOLYARRS_MOVIES	Uma pasta da Biblioteca de filmes.
HOLYARRS_QBITTORRENT_URL	Um gerenciador de downloads qBittorrent.
HOLYARRS_SOURCE_URL	Uma Fonte Torznab sem chave.

Variáveis de desenvolvimento e teste

Estas variáveis apontam o HolyArrs para substitutos usados em testes. Deixe sem valor em uma instalação real.

Variável	O que faz
HOLYARRS_FLAGS	Chaves, separadas por vírgula, de recursos que vêm desativados por padrão nesta versão. Veja Atualizações.
HOLYARRS_DIRECT_SOURCES	1 deixa esta instalação consultar ela mesma as fontes de música e TV, em vez do servidor de metadados.
HOLYARRS_METADATA_SERVICE_ALLOW_LOCAL	Permite um servidor de metadados na rede local.
HOLYARRS_METADATA_COUNT	Conta os pedidos de metadados e registra no log.
HOLYARRS_TMDB_TOKEN_FILE, HOLYARRS_TMDB_URL	Arquivo de token do TMDB para testes e endereço substituto.
HOLYARRS_TVMAZE_URL, HOLYARRS_MUSICBRAINZ_URL, HOLYARRS_DEEZER_URL, HOLYARRS_TRAKT_URL, HOLYARRS_PLEX_URL, HOLYARRS_PLEX_APP_URL, HOLYARRS_PLEX_DISCOVER_URL, HOLYARRS_PUSHOVER_URL, HOLYARRS_TELEGRAM_URL, HOLYARRS_YOUTUBE_URL, HOLYARRS_RELEASE_FEED	Endereços substitutos para serviços externos.
HOLYARRS_TRAILER_PASS_FIRST, HOLYARRS_TRAILER_PASS_EVERY	Tempos da passagem de trailers, como durações, por exemplo 2s.

Relacionados

• Instalação
• Executar em um caminho
• Login e senhas