Käyttöönotto

Rakenna HolyArrs lähdekoodista ja avaa se selaimessa portissa 6262.

Ennen kuin aloitat

• Go siinä versiossa, jonka go.mod mainitsee.
• Node 24 ja npm.
• Pääte repon juuressa.

C-kääntäjää ei tarvita. Buildit käyttävät asetusta CGO_ENABLED=0.

Rakenna ja aja

1. Asenna verkkosovelluksen paketit:

   npm --prefix app/frontend ci

2. Rakenna verkkosovellus:

   npm --prefix app/frontend run build

   Build valmistuu, ja kansioon app/frontend/dist ilmestyy tiedostoja.

3. Rakenna ohjelma:

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

4. Aja se omalla asetuskansiollasi:

   ./bin/holyarrs -config ./config

5. Avaa http://localhost:6262.

   Näet ensimmäisen käynnistyksen ohjatun toiminnon. Tee omistajan tili.

Varoitus

Ohjelma upottaa kansion app/frontend/dist itseensä. Rakenna verkkosovellus uudelleen ennen ohjelmaa aina verkkosovelluksen muutoksen jälkeen, tai saat vanhat sivut.

-config ottaa paikallisen levyn kansion ja oletus on /config. -addr muuttaa kuunteluosoitetta, ja oletus on :6262.

Työskentele verkkosovelluksen parissa

Pidä ohjelma käynnissä. Käynnistä toisessa päätteessä kehityspalvelin:

npm --prefix app/frontend run dev

Kehityspalvelin lataa sivun uudelleen tallennettaessa ja lähettää API-kutsut käynnissä olevalle ohjelmalle. Näet muutoksesi selaimessa 2 sekunnin kuluessa.

Vaihtoehdot

Käytä Makefilea

Komento	Tehtävä
make ui	Asentaa verkkopaketit ja rakentaa verkkosovelluksen
make build	Suorittaa make ui, sitten rakentaa bin/holyarrs
make test	go test 25 minuutin aikarajalla
make vet	go vet ./...
make docker	Rakentaa imagen nimellä holyarrs:dev
make e2e	Ajaa end-to-end-testit

Ota myöhemmäksi jätetty ominaisuus käyttöön

Jotkin ominaisuudet on jätetty myöhemmäksi ja ne pysyvät pois päältä. Nimeä ne muuttujassa HOLYARRS_FLAGS pilkulla erotettuina:

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

Sivut piilottavat ominaisuuden, joka on pois päältä, eikä sen reittejä ole. Käyttäjät lukevat niistä sivulta Myöhemmäksi jätetyt ominaisuudet.

Täytä kirjasto demodatalla

Demotyökalu täyttää asetuskansion demokokoelmalla. Se toimii vain pysäytetylle HolyArrsille ja vain kansiolle, jonka olet merkinnyt labiksi. Merkitse se kerran:

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

Sen jälkeen seed -config ./config lisää demokirjaston ja seed -config ./config -reset-demo poistaa vain sen, minkä se lisäsi. Mediakansion on oltava /data/media, ellet anna lippua -force. Kehitystyökalut eivät päädy imageen. Katso Kehitystyökalut.

Jos se ei toimi

Oire. Sivut näyttävät vanhoilta verkkosovelluksen muutoksen jälkeen. Syy. Ohjelma tarjoaa sen buildin, jonka se on upottanut itseensä. Ratkaisu. Suorita web-build, sitten Go-build ja käynnistä ohjelma.

Oire. go build epäonnistuu, koska app/frontend/dist puuttuu. Syy. Verkkosovellusta ei ole vielä rakennettu. Ratkaisu. Suorita ensin vaihe 2.

Oire. Ohjelma kertoo, että portti on käytössä. Syy. Toinen HolyArrs tai sovellus käyttää porttia 6262. Ratkaisu. Anna toinen osoite: ./bin/holyarrs -config ./config -addr :6263.

Asiantuntijoille

Myöhemmäksi jätettyjen ominaisuuksien kytkimet

Kytkin	Ominaisuus
row_title_stats	Rivien tilastot sivulla Explore (selaa), omistajalle
trakt_lists	Trakt-listat
alert_channels_more	Ilmoituskanavat Discordin ja sähköpostin lisäksi
subtitle_sites	Tekstitysten sivustot ja tekstitysten haku
emby_signin	Kirjautuminen Embyllä
go_back	Vaiheet paluuseen edelliseen versioon

Lisää kytkin rekisteröimällä sen nimi funktiolla startup.RegisterFeature ja tarkista startup.FeatureOn ennen kuin rekisteröit sen reitit. Nimet ovat kansiossa app/backend/internal/core/startup (feature.go).

Kehitystyökalut

Työkalu	Komento	Tehtävä
Demo	go run ./app/backend/tools/demo <command> -config DIR	Toimii pysäytetylle asetuskansiolle. Komennot: inspect (määrät), fingerprint, query "SELECT ..." (vain luku), doctor, seed, showcase
Feikki tekstitysten sivusto	go run ./app/backend/tools/fakesubs	Tarjoaa feikkejä tekstitysten sivustoja testeille osoitteessa 127.0.0.1:18727. -addr siirtää sen, -accounts-addr lisää tilisivustojen feikit
Reittilista	go run ./app/backend/tools/apidoc	Kirjoittaa uudelleen sivun API-reitit

Rakenna image

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

Image alkaa kohdasta FROM scratch, ja siinä on ohjelma, CA-varmenteet ja lisenssit. Se ajaa komennon -config /config -addr :6262.

Aiheesta lisää

• Osallistuminen
• Testaus
• Moduulit