Configuració

Compila HolyArrs des del codi font i obre’l al navegador al port 6262.

Abans de començar

• Go, a la versió que indica go.mod.
• Node 24 i npm.
• Un terminal a l’arrel del repositori.

No necessites cap compilador de C. Les compilacions usen CGO_ENABLED=0.

Compila i executa

1. Instal·la els paquets de l’app web:

   npm --prefix app/frontend ci

2. Compila l’app web:

   npm --prefix app/frontend run build

   Hauries de veure que la compilació acaba i que app/frontend/dist s’omple de fitxers.

3. Compila el programa:

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

4. Executa’l amb una carpeta de configuració teva:

   ./bin/holyarrs -config ./config

5. Obre http://localhost:6262.

   Hauries de veure l’assistent del primer inici. Crea el compte del propietari.

Precaució

El programa integra app/frontend/dist. Després de canviar l’app web, torna-la a compilar abans del programa, o tindràs les pàgines antigues.

-config accepta una carpeta del disc local i per defecte és /config. -addr canvia l’adreça on escolta i per defecte és :6262.

Treballa amb l’app web

Deixa el programa executant-se. En un segon terminal, inicia el servidor de desenvolupament:

npm --prefix app/frontend run dev

El servidor de desenvolupament es recarrega en desar i envia les crides de l’API al programa que s’està executant. Hauries de veure el teu canvi al navegador en menys de 2 s.

Opcions

Fes servir el Makefile

Ordre	Fa
make ui	Instal·la els paquets web i compila l’app web
make build	make ui, i després compila bin/holyarrs
make test	go test amb un temps màxim de 25 min
make vet	go vet ./...
make docker	Compila la imatge com a holyarrs:dev
make e2e	Executa les proves d’extrem a extrem

Activa una funció retinguda

Algunes funcions estan retingudes i es queden desactivades. Posa’n els noms a HOLYARRS_FLAGS, separats per comes:

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

Les pàgines amaguen una funció desactivada, i les seves rutes no existeixen. Els usuaris en llegeixen a Funcions retingudes.

Omple la Biblioteca amb dades de demostració

L’eina de demostració omple una carpeta de configuració amb una col·lecció de demostració. Només funciona amb HolyArrs aturat i només en una carpeta que hagis marcat com a laboratori. Marca-la una vegada:

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

Després, seed -config ./config afegeix la biblioteca de demostració i seed -config ./config -reset-demo treu només el que ha afegit. La carpeta multimèdia ha de ser /data/media tret que passis -force. Les eines de desenvolupament es queden fora de la imatge. Mira Eines de desenvolupament.

Si no funciona

Símptoma. Les pàgines es veuen antigues després de canviar l’app web. Causa. El programa serveix la compilació que va integrar. Solució. Executa la compilació web, després la de Go, i després inicia el programa.

Símptoma. go build falla perquè falta app/frontend/dist. Causa. L’app web encara no està compilada. Solució. Executa primer el pas 2.

Símptoma. El programa diu que el port està en ús. Causa. Un altre HolyArrs o una altra app té el 6262. Solució. Passa una altra adreça: ./bin/holyarrs -config ./config -addr :6263.

Per a experts

Interruptors de funcions retingudes

Interruptor	Funció
row_title_stats	Estadístiques de les files d’Explorar per al propietari
trakt_lists	Llistes de Trakt
alert_channels_more	Canals d’avisos a més de Discord i email
subtitle_sites	Llocs de subtítols i cerca de subtítols
emby_signin	Inici de sessió amb Emby
go_back	Passos per tornar a la versió anterior

Per afegir-ne un, registra’n el nom amb startup.RegisterFeature i comprova startup.FeatureOn abans de registrar-ne les rutes. Els noms són a app/backend/internal/core/startup (feature.go).

Eines de desenvolupament

Eina	Ordre	Fa
Demo	go run ./app/backend/tools/demo <command> -config DIR	Funciona amb una carpeta de configuració aturada. Ordres: inspect (recomptes), fingerprint, query "SELECT ..." (només lectura), doctor, seed, showcase
Lloc de subtítols fals	go run ./app/backend/tools/fakesubs	Serveix llocs de subtítols falsos per a les proves a 127.0.0.1:18727. -addr el mou; -accounts-addr afegeix els falsos dels llocs amb compte
Llista de rutes	go run ./app/backend/tools/apidoc	Reescriu Rutes de l’API

Compila la imatge

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

La imatge comença FROM scratch i conté el programa, els certificats de CA i les llicències. Executa -config /config -addr :6262.

Relacionat

• Contribuir
• Proves
• Mòduls