Nastavenie

Zostav HolyArrs zo zdrojového kódu a otvor ho v prehliadači na porte 6262.

Skôr než začneš

• Go vo verzii, ktorú uvádza go.mod.
• Node 24 a npm.
• Terminál v koreni repozitára.

Prekladač C nepotrebuješ. Zostavenia používajú CGO_ENABLED=0.

Zostav a spusti

1. Nainštaluj balíky webovej aplikácie:

   npm --prefix app/frontend ci

2. Zostav webovú aplikáciu:

   npm --prefix app/frontend run build

   Mal by si vidieť, ako zostavenie skončí a app/frontend/dist sa naplní súbormi.

3. Zostav program:

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

4. Spusti ho s vlastným konfiguračným priečinkom:

   ./bin/holyarrs -config ./config

5. Otvor http://localhost:6262.

   Mal by si vidieť sprievodcu prvým spustením. Vytvor účet vlastníka.

Upozornenie

Program má vstavaný app/frontend/dist. Po zmene webovej aplikácie ju zostav znova pred programom, inak dostaneš staré stránky.

-config berie priečinok na lokálnom disku a predvolene je /config. -addr mení adresu, na ktorej program počúva, a predvolene je :6262.

Práca na webovej aplikácii

Nechaj program bežať. V druhom termináli spusti vývojový server:

npm --prefix app/frontend run dev

Vývojový server sa po uložení znova načíta a volania API posiela bežiacemu programu. Svoju úpravu by si mal vidieť v prehliadači do 2 s.

Možnosti

Použi Makefile

Príkaz	Robí
make ui	Nainštaluje balíky webu a zostaví webovú aplikáciu
make build	make ui, potom zostaví bin/holyarrs
make test	go test s časovým limitom 25 min
make vet	go vet ./...
make docker	Zostaví image ako holyarrs:dev
make e2e	Spustí end-to-end testy

Zapni pozdržanú funkciu

Niektoré funkcie sú pozdržané a ostávajú vypnuté. Pomenuj ich v HOLYARRS_FLAGS, oddelené čiarkou:

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

Stránky skryjú vypnutú funkciu a jej cesty neexistujú. Používatelia sa o nich dočítajú v Pozdržané funkcie.

Naplň knižnicu demo dátami

Demo nástroj naplní konfiguračný priečinok ukážkovou zbierkou. Funguje iba so zastaveným HolyArrs a iba na priečinku označenom ako laboratórny. Označ ho raz:

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

Potom seed -config ./config pridá demo knižnicu a seed -config ./config -reset-demo odstráni iba to, čo pridal. Mediálny priečinok musí byť /data/media, kým nepoužiješ -force. Vývojové nástroje do image nepatria. Pozri Vývojové nástroje.

Ak to nefunguje

Príznak. Stránky vyzerajú staré po zmene webovej aplikácie. Príčina. Program servíruje build, ktorý mal vstavaný. Riešenie. Spusti zostavenie webu, potom zostavenie Go a potom spusti program.

Príznak. go build zlyhá pre chýbajúci app/frontend/dist. Príčina. Webová aplikácia ešte nie je zostavená. Riešenie. Spusti najprv krok 2.

Príznak. Program hlási, že port je obsadený. Príčina. Port 6262 drží iný HolyArrs alebo iná aplikácia. Riešenie. Zadaj inú adresu: ./bin/holyarrs -config ./config -addr :6263.

Pre expertov

Pozdržané prepínače

Prepínač	Funkcia
row_title_stats	Štatistiky riadkov v Objavovaní pre vlastníka
trakt_lists	Zoznamy z Trakt
alert_channels_more	Kanály upozornení okrem Discordu a e-mailu
subtitle_sites	Stránky s titulkami a hľadanie titulkov
emby_signin	Prihlásenie cez Emby
go_back	Kroky na návrat na predchádzajúcu verziu

Ak chceš pridať nový, zaregistruj jeho názov cez startup.RegisterFeature a skontroluj startup.FeatureOn, skôr než zaregistruješ jeho cesty. Názvy sú v app/backend/internal/core/startup (feature.go).

Vývojové nástroje

Nástroj	Príkaz	Robí
Demo	go run ./app/backend/tools/demo <command> -config DIR	Funguje na zastavenom konfiguračnom priečinku. Príkazy: inspect (počty), fingerprint, query "SELECT ..." (iba na čítanie), doctor, seed, showcase
Falošná stránka s titulkami	go run ./app/backend/tools/fakesubs	Servíruje falošné stránky s titulkami pre testy na 127.0.0.1:18727. -addr ju presunie; -accounts-addr pridá falošné stránky s účtami
Zoznam ciest	go run ./app/backend/tools/apidoc	Prepíše Cesty API

Zostav image

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

Image začína od FROM scratch a obsahuje program, certifikáty CA a licencie. Spúšťa sa s -config /config -addr :6262.

Súvisiace stránky

• Prispievanie
• Testovanie
• Moduly