Oppsett

Bygg HolyArrs fra kildekoden og åpne det i nettleseren på port 6262.

Før du begynner

• Go, i den versjonen go.mod nevner.
• Node 24 og npm.
• En terminal i roten av repoet.

Du trenger ingen C-kompilator. Byggene bruker CGO_ENABLED=0.

Bygg og kjør

1. Installer pakkene til web-appen:

   npm --prefix app/frontend ci

2. Bygg web-appen:

   npm --prefix app/frontend run build

   Du skal se at bygget blir ferdig og at app/frontend/dist fylles med filer.

3. Bygg programmet:

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

4. Kjør det med en egen konfigurasjonsmappe:

   ./bin/holyarrs -config ./config

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

   Du skal se veiviseren ved første oppstart. Lag eierkontoen.

Advarsel

Programmet har app/frontend/dist innebygd. Etter en endring i web-appen må du bygge web-appen på nytt før programmet, ellers får du de gamle sidene.

-config tar en mappe på lokal disk og er som standard /config. -addr endrer lytteadressen og er som standard :6262.

Jobb med web-appen

La programmet kjøre. Start dev-serveren i en andre terminal:

npm --prefix app/frontend run dev

Dev-serveren laster på nytt ved lagring og sender API-kall til programmet som kjører. Du skal se endringen din i nettleseren innen 2 s.

Valg

Bruk Makefile

Kommando	Gjør
make ui	Installer web-pakkene og bygg web-appen
make build	make ui, så bygg bin/holyarrs
make test	go test med en tidsgrense på 25 min
make vet	go vet ./...
make docker	Bygg imaget som holyarrs:dev
make e2e	Kjør ende-til-ende-testene

Slå på en tilbakeholdt funksjon

Noen funksjoner er tilbakeholdt og forblir av. Nevn dem i HOLYARRS_FLAGS, adskilt med komma:

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

Sidene skjuler en funksjon som er av, og rutene dens finnes ikke. Brukere kan lese om dem i Tilbakeholdte funksjoner.

Fyll biblioteket med demodata

Demoverktøyet fyller en konfigurasjonsmappe med en demosamling. Det virker bare på et stoppet HolyArrs og bare på en mappe du har merket som lab. Merk den én gang:

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

Deretter legger seed -config ./config til demobiblioteket, og seed -config ./config -reset-demo fjerner bare det den la til. Mediemappen må være /data/media med mindre du gir -force. Dev-verktøyene holdes utenfor imaget. Se Dev-verktøy.

Hvis det ikke fungerer

Symptom. Sidene ser gamle ut etter at du endret web-appen. Årsak. Programmet serverer bygget det har innebygd. Løsning. Kjør web-bygget, så Go-bygget, og start så programmet.

Symptom. go build feiler på manglende app/frontend/dist. Årsak. Web-appen er ikke bygget ennå. Løsning. Kjør trinn 2 først.

Symptom. Programmet sier at porten er i bruk. Årsak. Et annet HolyArrs eller en annen app holder 6262. Løsning. Gi en annen adresse: ./bin/holyarrs -config ./config -addr :6263.

For viderekomne

Tilbakeholdte brytere

Bryter	Funksjon
row_title_stats	Statistikk for Explore-rader, for eieren
trakt_lists	Trakt-lister
alert_channels_more	Varselkanaler utover Discord og e-post
subtitle_sites	Undertekstsider og undertekstsøk
emby_signin	Innlogging med Emby
go_back	Trinn for å gå tilbake til forrige versjon

For å legge til en, registrer navnet med startup.RegisterFeature og sjekk startup.FeatureOn før du registrerer rutene. Navnene ligger i app/backend/internal/core/startup (feature.go).

Dev-verktøy

Verktøy	Kommando	Gjør
Demo	go run ./app/backend/tools/demo <command> -config DIR	Virker på en stoppet konfigurasjonsmappe. Kommandoer: inspect (antall), fingerprint, query "SELECT ..." (skrivebeskyttet), doctor, seed, showcase
Falsk undertekstside	go run ./app/backend/tools/fakesubs	Serverer falske undertekstsider for tester på 127.0.0.1:18727. -addr flytter den; -accounts-addr legger til falske kontosider
Ruteliste	go run ./app/backend/tools/apidoc	Skriver API-ruter på nytt

Bygg imaget

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

Imaget starter FROM scratch og inneholder programmet, CA-sertifikater og lisenser. Det kjører -config /config -addr :6262.

Relatert

• Bidra
• Testing
• Moduler