Příprava

Sestav HolyArrs ze zdrojových kódů a otevři ho v prohlížeči na portu 6262.

Než začneš

• Go ve verzi, kterou uvádí go.mod.
• Node 24 a npm.
• Terminál v kořeni repozitáře.

C kompilátor nepotřebuješ. Buildy používají CGO_ENABLED=0.

Sestav a spusť

1. Nainstaluj balíčky webové aplikace:

   npm --prefix app/frontend ci

2. Sestav webovou aplikaci:

   npm --prefix app/frontend run build

   Měl bys vidět, jak build doběhne a app/frontend/dist se naplní soubory.

3. Sestav program:

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

4. Spusť ho s vlastní konfigurační složkou:

   ./bin/holyarrs -config ./config

5. Otevři http://localhost:6262.

   Měl bys vidět průvodce prvním spuštěním. Vytvoř účet vlastníka.

Upozornění

Program vestavuje app/frontend/dist. Po změně webové aplikace ji před programem sestav znovu, jinak dostaneš staré stránky.

-config bere složku na místním disku a ve výchozím stavu je /config. -addr mění adresu, na které program naslouchá, a výchozí je :6262.

Pracuj na webové aplikaci

Nech program běžet. Ve druhém terminálu spusť vývojový server:

npm --prefix app/frontend run dev

Vývojový server se po uložení načte znovu a posílá volání API běžícímu programu. Svou úpravu bys měl vidět v prohlížeči do 2 s.

Možnosti

Použij Makefile

Příkaz	Dělá
make ui	Nainstaluje balíčky webu a sestaví webovou aplikaci
make build	make ui a potom sestaví bin/holyarrs
make test	go test s časovým limitem 25 min
make vet	go vet ./...
make docker	Sestaví image jako holyarrs:dev
make e2e	Spustí end-to-end testy

Zapni odloženou funkci

Některé funkce jsou odložené a zůstávají vypnuté. Pojmenuj je v HOLYARRS_FLAGS, oddělené čárkou:

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

Stránky vypnutou funkci skryjí a její trasy neexistují. Uživatelé se o nich dočtou v odložených funkcích.

Naplň Knihovnu ukázkovými daty

Demo nástroj naplní konfigurační složku ukázkovou sbírkou. Funguje jen na zastaveném HolyArrs a jen na složce označené jako laboratoř. Označ ji jednou:

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

Potom seed -config ./config přidá ukázkovou knihovnu a seed -config ./config -reset-demo odebere jen to, co přidal. Složka s médii musí být /data/media, pokud nepřidáš -force. Vývojové nástroje zůstávají mimo image. Viz vývojové nástroje.

Když to nefunguje

Příznak. Stránky po změně webové aplikace vypadají staře. Příčina. Program servíruje build, který má vestavěný. Řešení. Spusť build webu, potom build Go a potom program.

Příznak. go build selže kvůli chybějícímu app/frontend/dist. Příčina. Webová aplikace ještě není sestavená. Řešení. Nejdřív proveď krok 2.

Příznak. Program hlásí, že port je obsazený. Příčina. Port 6262 drží jiný HolyArrs nebo jiná aplikace. Řešení. Zadej jinou adresu: ./bin/holyarrs -config ./config -addr :6263.

Pro pokročilé

Přepínače odložených funkcí

Přepínač	Funkce
row_title_stats	Statistiky řádků v Explore pro vlastníka
trakt_lists	Seznamy z Trakt
alert_channels_more	Kanály upozornění kromě Discordu a e-mailu
subtitle_sites	Weby s titulky a hledání titulků
emby_signin	Přihlášení přes Emby
go_back	Kroky pro návrat k předchozí verzi

Chceš-li přidat nový, zaregistruj jeho název přes startup.RegisterFeature a před registrací jeho tras zkontroluj startup.FeatureOn. Názvy žijí v app/backend/internal/core/startup (feature.go).

Vývojové nástroje

Nástroj	Příkaz	Dělá
Demo	go run ./app/backend/tools/demo <command> -config DIR	Pracuje se zastavenou konfigurační složkou. Příkazy: inspect (počty), fingerprint, query "SELECT ..." (jen pro čtení), doctor, seed, showcase
Falešný web s titulky	go run ./app/backend/tools/fakesubs	Servíruje falešné weby s titulky pro testy na 127.0.0.1:18727. -addr ho přesune; -accounts-addr přidá falešné weby s účty
Seznam tras	go run ./app/backend/tools/apidoc	Přepíše trasy API

Sestav image

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

Image začíná od FROM scratch a obsahuje program, certifikáty CA a licence. Spouští -config /config -addr :6262.

Související

• Přispívání
• Testování
• Moduly