Configuração inicial

Compile o HolyArrs a partir do código-fonte e abra o HolyArrs no navegador, na porta 6262.

Antes de começar

• Go, na versão que o go.mod indica.
• Node 24 e npm.
• Um terminal na raiz do repositório.

Você não precisa de um compilador C. As compilações usam CGO_ENABLED=0.

Compile e execute

1. Instale os pacotes do app web:

   npm --prefix app/frontend ci

2. Compile o app web:

   npm --prefix app/frontend run build

   Você deve ver a compilação terminar e a pasta app/frontend/dist se encher de arquivos.

3. Compile o programa:

   go build -o bin/holyarrs ./app/backend/cmd/holyarrs

4. Execute o programa com uma pasta de configuração sua:

   ./bin/holyarrs -config ./config

5. Abra http://localhost:6262.

   Você deve ver o assistente de primeira execução. Crie a conta do dono.

Cuidado

O programa embute app/frontend/dist. Depois de uma mudança no app web, compile o app web de novo antes do programa, senão você vê as páginas antigas.

-config recebe uma pasta em disco local e o padrão é /config. -addr muda o endereço de escuta e o padrão é :6262.

Trabalhe no app web

Deixe o programa em execução. Em um segundo terminal, inicie o servidor de desenvolvimento:

npm --prefix app/frontend run dev

O servidor de desenvolvimento recarrega a cada salvamento e envia as chamadas de API para o programa em execução. Você deve ver sua edição no navegador em até 2 s.

Opções

Use o Makefile

Comando	Faz
make ui	Instala os pacotes web e compila o app web
make build	make ui, depois compila bin/holyarrs
make test	go test com um limite de tempo de 25 min
make vet	go vet ./...
make docker	Compila a imagem como holyarrs:dev
make e2e	Executa os testes de ponta a ponta

Ative um recurso retido

Alguns recursos estão retidos e ficam desativados. Coloque os nomes deles em HOLYARRS_FLAGS, separados por vírgula:

HOLYARRS_FLAGS=subtitle_sites,ai_apps ./bin/holyarrs -config ./config

As páginas escondem um recurso desativado, e as rotas dele não existem. Os usuários leem sobre esses recursos em Recursos retidos.

Encha a Biblioteca com dados de demonstração

A ferramenta de demonstração enche uma pasta de configuração com uma coleção de demonstração. Ela só funciona com o HolyArrs parado e só em uma pasta que você marcou como laboratório. Marque a pasta uma vez:

go run ./app/backend/tools/demo seed -config ./config -init-lab

Depois, seed -config ./config adiciona a biblioteca de demonstração e seed -config ./config -reset-demo remove só o que ela adicionou. A pasta de mídia precisa ser /data/media, a não ser que você passe -force. As ferramentas de desenvolvimento ficam fora da imagem. Veja Ferramentas de desenvolvimento.

Se não funcionar

Sintoma. As páginas parecem antigas depois que você mudou o app web. Causa. O programa serve a compilação que ele embutiu. Solução. Execute a compilação web, depois a compilação Go, depois inicie o programa.

Sintoma. O go build falha porque falta app/frontend/dist. Causa. O app web ainda não foi compilado. Solução. Execute o passo 2 primeiro.

Sintoma. O programa diz que a porta está em uso. Causa. Outro HolyArrs ou outro app está usando a 6262. Solução. Passe outro endereço: ./bin/holyarrs -config ./config -addr :6263.

Para especialistas

Chaves de recursos retidos

Chave	Recurso
plex_watchlists	As watchlists do Plex viram pedidos
row_title_stats	Estatísticas das fileiras do Explorar para o dono
trakt_lists	Listas do Trakt
alert_channels_more	Canais de alerta além do Discord e do e-mail
subtitle_sites	Sites de legendas e busca de legendas
emby_signin	Entrar com o Emby
go_back	Passos para voltar para a versão anterior

Para adicionar uma, registre o nome dela com startup.RegisterFeature e confira startup.FeatureOn antes de registrar as rotas dela. Os nomes ficam em app/backend/internal/core/startup (feature.go).

Ferramentas de desenvolvimento

Ferramenta	Comando	Faz
Demo	go run ./app/backend/tools/demo <command> -config DIR	Trabalha em uma pasta de configuração parada. Comandos: inspect (contagens), fingerprint, query "SELECT ..." (somente leitura), doctor, seed, showcase
Site de legendas falso	go run ./app/backend/tools/fakesubs	Serve sites de legendas falsos para testes em 127.0.0.1:18727. -addr muda o endereço; -accounts-addr adiciona os falsos do site de contas
Lista de rotas	go run ./app/backend/tools/apidoc	Reescreve Rotas da API

Compile a imagem

docker build --file deploy/Dockerfile --tag holyarrs:dev .
docker run -p 6262:6262 -v ./config:/config holyarrs:dev

A imagem começa com FROM scratch e contém o programa, os certificados de CA e as licenças. Ela executa -config /config -addr :6262.

Relacionados

• Como contribuir
• Testes
• Módulos