Opsætning

Byg HolyArrs fra kildekoden og åbn det i din browser på port 6262.

Før du begynder

• Go, i den version go.mod nævner.
• Node 24 og npm.
• En terminal i roden af repoet.

Du behøver ingen C-compiler. Builds bruger CGO_ENABLED=0.

Byg og kør

1. Installer pakkerne til web-appen:

   npm --prefix app/frontend ci

2. Byg web-appen:

   npm --prefix app/frontend run build

   Du bør se buildet blive færdigt og app/frontend/dist blive fyldt med filer.

3. Byg programmet:

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

4. Kør det med en konfigurationsmappe, du selv har lavet:

   ./bin/holyarrs -config ./config

5. Åbn http://localhost:6262.

   Du bør se guiden ved første start. Lav ejerkontoen.

Bemærk

Programmet indlejrer app/frontend/dist. Efter en ændring i web-appen skal du bygge web-appen igen, før du bygger programmet, ellers får du de gamle sider.

-config tager en mappe på en lokal disk og er som standard /config. -addr ændrer lytteadressen og er som standard :6262.

Arbejd på web-appen

Lad programmet køre. Start dev-serveren i en anden terminal:

npm --prefix app/frontend run dev

Dev-serveren genindlæser, når du gemmer, og sender API-kald til det kørende program. Du bør se din ændring i browseren inden for 2 s.

Valg

Brug Makefile

Kommando	Gør
make ui	Installer webpakkerne og byg web-appen
make build	make ui, så byg bin/holyarrs
make test	go test med en timeout på 25 min
make vet	go vet ./...
make docker	Byg imaget som holyarrs:dev
make e2e	Kør end-to-end-testene

Slå en tilbageholdt funktion til

Nogle funktioner er tilbageholdt og forbliver slået fra. Skriv dem i HOLYARRS_FLAGS, adskilt af komma:

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

Siderne skjuler en funktion, der er slået fra, og dens ruter findes ikke. Brugerne kan læse om dem i Tilbageholdte funktioner.

Fyld biblioteket med demodata

Demoværktøjet fylder en konfigurationsmappe med en demosamling. Det virker kun på et stoppet HolyArrs og kun på en mappe, du har markeret som lab. Marker den én gang:

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

Derefter tilføjer seed -config ./config demobiblioteket, og seed -config ./config -reset-demo fjerner kun det, det selv tilføjede. Mediemappen skal være /data/media, medmindre du angiver -force. Dev-værktøjerne bliver uden for imaget. Se Dev-værktøjer.

Hvis det ikke virker

Symptom. Siderne ser gamle ud, efter du har ændret web-appen. Årsag. Programmet serverer det build, det har indlejret. Løsning. Kør web-buildet, så Go-buildet, og start så programmet.

Symptom. go build fejler på en manglende app/frontend/dist. Årsag. Web-appen er ikke bygget endnu. Løsning. Kør trin 2 først.

Symptom. Programmet siger, at porten er i brug. Årsag. Et andet HolyArrs eller en anden app har 6262. Løsning. Angiv en anden adresse: ./bin/holyarrs -config ./config -addr :6263.

For erfarne

Tilbageholdte kontakter

Kontakt	Funktion
row_title_stats	Statistik for rækker i Explore til ejeren
trakt_lists	Trakt-lister
alert_channels_more	Beskedkanaler ud over Discord og e-mail
subtitle_sites	Undertekstsider og søgning efter undertekster
emby_signin	Login med Emby
go_back	Trin til at gå tilbage til den forrige version

For at tilføje en skal du registrere dens navn med startup.RegisterFeature og tjekke startup.FeatureOn, før du registrerer dens ruter. Navnene ligger i app/backend/internal/core/startup (feature.go).

Dev-værktøjer

Værktøj	Kommando	Gør
Demo	go run ./app/backend/tools/demo <command> -config DIR	Virker på en stoppet konfigurationsmappe. Kommandoer: inspect (tal), fingerprint, query "SELECT ..." (skrivebeskyttet), doctor, seed, showcase
Falsk undertekstside	go run ./app/backend/tools/fakesubs	Serverer falske undertekstsider til tests på 127.0.0.1:18727. -addr flytter den; -accounts-addr tilføjer falske kontosider
Rutelisten	go run ./app/backend/tools/apidoc	Skriver API-ruter om

Byg imaget

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

Imaget starter FROM scratch og indeholder programmet, CA-certifikater og licenser. Det kører -config /config -addr :6262.

Se også

• Bidrag
• Testning
• Moduler