Variáveis de ambiente

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

Comuns

Variável	O que faz	Predefinição	Exemplo
PUID, PGID	Utilizador e grupo com que o HolyArrs corre. Têm de ser donos de /config e das tuas pastas de multimédia.	1000, 1000	PUID=1000
TZ	Fuso horário para agendamentos e registos.	Etc/UTC	TZ=Europe/Amsterdam
UMASK	Bits de permissão que os ficheiros novos deixam de fora. Afeta só os ficheiros novos.	022	UMASK=002
HOLYARRS_SAVE_PATH	A pasta onde o gestor de transferências guarda, tal como ele a vê. Enviada com cada transferência.	nenhuma	/data/downloads
HOLYARRS_URL_BASE	Serve o HolyArrs num caminho atrás de um proxy inverso. / ignora um caminho guardado nas Definições.	nenhuma	/holyarrs
HOLYARRS_ALLOWED_HOSTS	Nomes de host adicionais que as pessoas usam para chegar ao HolyArrs, separados por vírgulas.	IPs e localhost	holyarrs.example.com
HOLYARRS_TRUSTED_PROXIES	O endereço ou a rede do teu proxy inverso, separados por vírgulas. Necessário para obter os endereços reais dos clientes.	nenhuma	172.18.0.0/16
HOLYARRS_MASTER_KEY_FILE	Lê a chave mestra do cofre a partir do seu próprio ficheiro. O utilizador PUID tem de a conseguir ler.	/config/holyarrs.key	/keys/holyarrs.key

Valores a partir de ficheiros

Põe FILE__ à frente de qualquer variável para ler o valor dela a partir de um ficheiro, como um segredo do Docker.

environment:
  - FILE__HOLYARRS_ALLOWED_HOSTS=/run/secrets/holyarrs_hosts

O HolyArrs retira uma mudança de linha no fim do ficheiro. Se o ficheiro não existir, o HolyArrs para e o registo (log) indica a variável e o ficheiro, nunca o valor.

Recuperação e resolução de problemas

Variável	O que faz	Predefinição	Exemplo
HOLYARRS_SAFE_MODE	Inicia só o essencial: início de sessão, Biblioteca, definições, cópias de segurança e saúde. Remove-a depois de corrigires o problema.	desativado	1
HOLYARRS_LOW_MEMORY	1 força o modo de pouca memória, 0 força-o desligado. Sem valor, liga-se com cerca de 2.5 GiB de RAM ou menos.	consoante o tamanho do computador	1
HOLYARRS_FOLLOW_LINKS	1 deixa a análise da Biblioteca e as importações usarem ficheiros de vídeo e de música que são symlinks (Bibliotecas feitas com ligações para uma unidade montada). Uma transferência ligada fica na Biblioteca como ligação.	desativado	1
GOMEMLIMIT	Substitui o objetivo de memória que o HolyArrs define para si.	definido pelo HolyArrs	1GiB
HOLYARRS_SKIP_SPACE_CHECK	Salta a verificação de espaço livre antes de uma atualização da base de dados.	desativado	yes
HOLYARRS_CONFIG_IN_MEMORY	Permite /config numa pasta em memória. Para máquinas de teste; os dados perdem-se ao reiniciar.	desativado	yes
HOLYARRS_ALLOW_DESKTOP_FOLDER	Arranca com /config numa pasta partilhada do Docker Desktop num Mac, depois de verificares que os bloqueios de ficheiros funcionam aí. O HolyArrs avisa em cada arranque.	desativado	1
HOLYARRS_READONLY_DOWNLOADERS	Gestores de transferências que o HolyArrs nunca pode alterar, por id ou endereço, separados por vírgulas.	nenhuma	3,http://qbit:8080
HOLYARRS_HEALTH_URL	Endereço que a verificação de saúde do contentor chama.	http://127.0.0.1:6262	http://127.0.0.1:6262/holyarrs

As variáveis de ligar/desligar aceitam 1, true, yes ou on.

Início de sessão único

Define-as antes de iniciar. Se HOLYARRS_OIDC_ENABLED existir de todo, mesmo como false, o ambiente é que manda no início de sessão único e as Definições só o mostram. As de ligar/desligar aqui aceitam só true ou false; qualquer outro valor impede o arranque.

Variável	O que faz	Predefinição
HOLYARRS_OIDC_ENABLED	Ativa o início de sessão único.	false
HOLYARRS_OIDC_ISSUER	O emissor HTTPS exato do fornecedor.	nenhuma
HOLYARRS_OIDC_CLIENT_ID	O id de cliente registado.	nenhuma
HOLYARRS_OIDC_CLIENT_SECRET_FILE	Ficheiro com o segredo do cliente, com 4096 bytes no máximo. Deixa de fora para um cliente público.	nenhuma
HOLYARRS_OIDC_REDIRECT_URL	O callback exato: o teu endereço, o URL base se existir, e depois /api/v1/auth/oidc/callback.	nenhuma
HOLYARRS_OIDC_ALLOW_JOIN	As pessoas novas entram como membros que só podem pedir.	false
HOLYARRS_OIDC_ALLOW_LOCAL_NETWORK	Permite um fornecedor na tua rede privada.	false
HOLYARRS_OIDC_ALLOW_LOOPBACK_HTTP	Permite HTTP simples neste computador, para testes.	false
HOLYARRS_FORWARD_AUTH_ENABLED	Ativa o início de sessão por proxy de confiança.	false
HOLYARRS_FORWARD_AUTH_ISSUER	Nome HTTPS estável para o proxy.	nenhuma
HOLYARRS_FORWARD_AUTH_TRUSTED_PEERS	Endereços ou intervalos do proxy autorizados a enviar cabeçalhos de identidade, separados por vírgulas.	nenhuma
HOLYARRS_FORWARD_AUTH_ALLOW_JOIN	Os nomes novos vindos do proxy entram como membros que só podem pedir.	false

Uma configuração errada impede o HolyArrs de arrancar. Os passos estão em Início de sessão e palavras-passe.

Para especialistas

Metadados

Variável	O que faz	Predefinição
HOLYARRS_METADATA_URL	O endereço do servidor de metadados.	https://api.holyarrs.com
HOLYARRS_TMDB_KEY	O teu próprio token de acesso de leitura do TMDB. Se estiver definido, as leituras do TMDB vão direitas ao TMDB em vez de passarem pelo servidor de metadados.	nenhuma
HOLYARRS_METADATA_SERVICE_TOKEN_FILE	Ficheiro com a credencial desta instalação para o servidor de metadados, lido em cada chamada. Sem valor, a credencial fica no cofre.	nenhuma

O que continua a passar pelo servidor de metadados com a tua própria chave do TMDB, e todos os outros endereços externos, estão em Endereços externos.

Atalhos do primeiro arranque

Cada uma adiciona um item ao arrancar. Usadas em demonstrações e testes; o assistente da primeira execução faz o mesmo.

Variável	Adiciona
HOLYARRS_MOVIES	Uma pasta de filmes da Biblioteca.
HOLYARRS_QBITTORRENT_URL	Um gestor de transferências qBittorrent.
HOLYARRS_SOURCE_URL	Uma Fonte Torznab sem chave.

Variáveis de programador e de teste

Estas apontam o HolyArrs para substitutos, em testes. Deixa-as sem valor numa instalação a sério.

Variável	O que faz
HOLYARRS_FLAGS	Interruptores separados por vírgulas para funcionalidades que estão desativadas por predefinição nesta versão. Vê Atualizações.
HOLYARRS_DIRECT_SOURCES	1 deixa esta instalação consultar ela própria as fontes de música e de TV em vez do servidor de metadados.
HOLYARRS_METADATA_SERVICE_ALLOW_LOCAL	Permite um servidor de metadados na rede local.
HOLYARRS_METADATA_COUNT	Conta e regista os pedidos de metadados.
HOLYARRS_TMDB_TOKEN_FILE, HOLYARRS_TMDB_URL	Ficheiro de token do TMDB de teste 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 dos trailers, como durações, por exemplo 2s.

Relacionado

• Instalar
• Executar sob um caminho
• Início de sessão e palavras-passe