Konfiguration

Bygg HolyArrs från källkod och öppna det i webbläsaren på port 6262.

Innan du börjar

• Go, i den version go.mod anger.
• Node 24 och npm.
• En terminal i repots rot.

Du behöver ingen C-kompilator. Byggena använder CGO_ENABLED=0.

Bygg och kör

1. Installera paketen för webbappen:

   npm --prefix app/frontend ci

2. Bygg webbappen:

   npm --prefix app/frontend run build

   Du ska se bygget bli klart och app/frontend/dist fyllas med filer.

3. Bygg programmet:

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

4. Kör det med en egen konfigurationsmapp:

   ./bin/holyarrs -config ./config

5. Öppna http://localhost:6262.

   Du ska se guiden vid första start. Skapa ägarkontot.

Caution

Programmet bäddar in app/frontend/dist. Efter en ändring i webbappen bygger du om webbappen före programmet, annars får du de gamla sidorna.

-config tar en mapp på lokal disk och är som standard /config. -addr ändrar adressen programmet lyssnar på och är som standard :6262.

Arbeta med webbappen

Låt programmet vara igång. Starta utvecklingsservern i en andra terminal:

npm --prefix app/frontend run dev

Utvecklingsservern laddar om när du sparar och skickar API-anropen till programmet som körs. Du ska se din ändring i webbläsaren inom 2 s.

Val

Använd Makefile

Kommando	Gör
make ui	Installerar webbpaketen och bygger webbappen
make build	make ui, sedan bygger bin/holyarrs
make test	go test med 25 minuters tidsgräns
make vet	go vet ./...
make docker	Bygger imagen som holyarrs:dev
make e2e	Kör end-to-end-testerna

Slå på en tillbakahållen funktion

Vissa funktioner är tillbakahållna och förblir av. Ange dem i HOLYARRS_FLAGS, åtskilda med komma:

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

Sidorna döljer en funktion som är av, och dess routes finns inte. Användare kan läsa om dem i Tillbakahållna funktioner.

Fyll biblioteket med demodata

Demoverktyget fyller en konfigurationsmapp med en demosamling. Det fungerar bara på ett stoppat HolyArrs och bara på en mapp som du markerat som labb. Markera den en gång:

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

Sedan lägger seed -config ./config till demobiblioteket och seed -config ./config -reset-demo tar bara bort det den lade till. Mediamappen måste vara /data/media om du inte anger -force. Utvecklingsverktygen finns inte i imagen. Se Utvecklingsverktyg.

Om det inte fungerar

Symptom. Sidorna ser gamla ut efter att du ändrat webbappen. Orsak. Programmet serverar den build det har inbyggd. Lösning. Kör bygget av webbappen, sedan Go-bygget, och starta sedan programmet.

Symptom. go build misslyckas på att app/frontend/dist saknas. Orsak. Webbappen är inte byggd än. Lösning. Kör steg 2 först.

Symptom. Programmet säger att porten används. Orsak. Ett annat HolyArrs eller en annan app håller 6262. Lösning. Ange en annan adress: ./bin/holyarrs -config ./config -addr :6263.

För experter

Tillbakahållna reglage

Reglage	Funktion
row_title_stats	Statistik för rader i Utforska, för ägaren
trakt_lists	Trakt-listor
alert_channels_more	Aviseringskanaler utöver Discord och e-post
subtitle_sites	Undertextsidor och sökning efter undertexter
emby_signin	Logga in med Emby
go_back	Steg för att gå tillbaka till den förra versionen

För att lägga till ett registrerar du dess namn med startup.RegisterFeature och kontrollerar startup.FeatureOn innan du registrerar dess routes. Namnen finns i app/backend/internal/core/startup (feature.go).

Utvecklingsverktyg

Verktyg	Kommando	Gör
Demo	go run ./app/backend/tools/demo <command> -config DIR	Fungerar på en stoppad konfigurationsmapp. Kommandon: inspect (antal), fingerprint, query "SELECT ..." (skrivskyddad), doctor, seed, showcase
Fejkad undertextsida	go run ./app/backend/tools/fakesubs	Serverar fejkade undertextsidor för tester på 127.0.0.1:18727. -addr flyttar den; -accounts-addr lägger till fejkade kontosidor
Route-lista	go run ./app/backend/tools/apidoc	Skriver om API-routes

Bygg imagen

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

Imagen börjar FROM scratch och innehåller programmet, CA-certifikat och licenser. Den kör -config /config -addr :6262.

Relaterat

• Bidra
• Testning
• Moduler