Beállítás

Fordítsd le a HolyArrs-t forrásból, és nyisd meg a böngésződben a 6262 porton.

Mielőtt elkezdenéd

• Go, abban a verzióban, amelyet a go.mod megnevez.
• Node 24 és npm.
• Egy terminál a repo gyökerében.

C fordítóra nincs szükséged. A buildek CGO_ENABLED=0 értékkel futnak.

Fordítás és futtatás

1. Telepítsd a webes app csomagjait:

   npm --prefix app/frontend ci

2. Fordítsd le a webes appot:

   npm --prefix app/frontend run build

   Azt kell látnod, hogy a build lefut, és az app/frontend/dist megtelik fájlokkal.

3. Fordítsd le a programot:

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

4. Futtasd a saját konfigurációs mappáddal:

   ./bin/holyarrs -config ./config

5. Nyisd meg a http://localhost:6262 címet.

   Az első indítás varázslóját kell látnod. Hozd létre a tulajdonosi fiókot.

Figyelem

A program beágyazza az app/frontend/dist mappát. Egy webes app változtatás után a program előtt fordítsd le újra a webes appot, különben a régi oldalakat kapod.

A -config egy helyi lemezen lévő mappát vár, alapértelmezése /config. A -addr a figyelt címet változtatja, alapértelmezése :6262.

Dolgozz a webes appon

Hagyd futni a programot. Egy második terminálban indítsd el a fejlesztői szervert:

npm --prefix app/frontend run dev

A fejlesztői szerver mentéskor újratölt, és az API-hívásokat a futó programhoz küldi. A módosításodat 2 s-on belül látnod kell a böngészőben.

Lehetőségek

A Makefile használata

Parancs	Feladata
make ui	Telepíti a webes csomagokat, és lefordítja a webes appot
make build	make ui, aztán lefordítja a bin/holyarrs-t
make test	go test 25 perces időkorláttal
make vet	go vet ./...
make docker	Megépíti az image-et holyarrs:dev néven
make e2e	Futtatja az end-to-end teszteket

Későbbre halasztott funkció bekapcsolása

Néhány funkció későbbre van halasztva, és ki van kapcsolva. Nevezd meg őket a HOLYARRS_FLAGS-ben, vesszővel elválasztva:

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

Az oldalak elrejtik a kikapcsolt funkciót, és a route-jai nem léteznek. A felhasználók a Későbbre halasztott funkciók oldalon olvashatnak róluk.

A Médiatár feltöltése demóadatokkal

A demó eszköz egy demógyűjteménnyel tölt fel egy konfigurációs mappát. Csak leállított HolyArrs-on működik, és csak olyan mappán, amelyet labornak jelöltél. Jelöld meg egyszer:

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

Ezután a seed -config ./config hozzáadja a demó médiatárat, a seed -config ./config -reset-demo pedig csak azt távolítja el, amit hozzáadott. A média mappájának /data/media-nak kell lennie, hacsak nem adod meg a -force-ot. A fejlesztői eszközök nem kerülnek az image-be. Lásd: Fejlesztői eszközök.

Ha nem működik

Tünet. Az oldalak réginek tűnnek, miután módosítottad a webes appot. Ok. A program a beágyazott buildet szolgálja ki. Megoldás. Futtasd a webes buildet, aztán a Go buildet, és csak utána indítsd el a programot.

Tünet. A go build hibával áll le a hiányzó app/frontend/dist miatt. Ok. A webes app még nincs lefordítva. Megoldás. Futtasd előbb a 2. lépést.

Tünet. A program azt írja, hogy a port foglalt. Ok. Egy másik HolyArrs vagy app fogja a 6262-t. Megoldás. Adj meg másik címet: ./bin/holyarrs -config ./config -addr :6263.

Haladóknak

Későbbre halasztott funkciók kapcsolói

Kapcsoló	Funkció
row_title_stats	Felfedezés-sorok statisztikái a tulajdonosnak
trakt_lists	Trakt listák
alert_channels_more	Értesítési csatornák a Discordon és az e-mailen túl
subtitle_sites	Feliratoldalak és feliratkeresés
emby_signin	Bejelentkezés Emby-vel
go_back	Lépések az előző verzióra való visszatéréshez

Újat úgy adhatsz hozzá, hogy a nevét regisztrálod a startup.RegisterFeature-rel, és a route-jai regisztrálása előtt ellenőrzöd a startup.FeatureOn-t. A nevek az app/backend/internal/core/startup mappában vannak (feature.go).

Fejlesztői eszközök

Eszköz	Parancs	Feladata
Demó	go run ./app/backend/tools/demo <command> -config DIR	Leállított konfigurációs mappán működik. Parancsok: inspect (darabszámok), fingerprint, query "SELECT ..." (csak olvasás), doctor, seed, showcase
Hamis feliratoldal	go run ./app/backend/tools/fakesubs	Hamis feliratoldalakat szolgál ki a tesztekhez a 127.0.0.1:18727 címen. Az -addr áthelyezi; az -accounts-addr hozzáadja a fiókos oldalak hamisítványait
Route-lista	go run ./app/backend/tools/apidoc	Újraírja az API route-ok oldalt

Az image megépítése

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

Az image FROM scratch alapról indul, és a programot, a CA-tanúsítványokat és a licenceket tartalmazza. A -config /config -addr :6262 paraméterekkel fut.

Kapcsolódó oldalak

• Közreműködés
• Tesztelés
• Modulok