Salta ai contenuti

Configurazione

Configurazione

Compila HolyArrs dai sorgenti e aprilo nel browser sulla porta 6262.

Prima di iniziare

Link a Prima di iniziare
  • Go, nella versione indicata da go.mod.
  • Node 24 e npm.
  • Un terminale nella radice del repository.

Non serve nessun compilatore C. Le build usano CGO_ENABLED=0.

Compila ed esegui

Link a Compila ed esegui
  1. Installa i pacchetti dell’app web:

    Terminal window
    npm --prefix app/frontend ci
  2. Compila l’app web:

    Terminal window
    npm --prefix app/frontend run build

    Dovresti vedere la build terminare e app/frontend/dist riempirsi di file.

  3. Compila il programma:

    Terminal window
    go build -o bin/holyarrs ./app/backend/cmd/holyarrs
  4. Eseguilo con una cartella di configurazione tua:

    Terminal window
    ./bin/holyarrs -config ./config
  5. Apri http://localhost:6262.

    Dovresti vedere la procedura guidata del primo avvio. Crea l’account del proprietario.

-config accetta una cartella su disco locale e per impostazione predefinita vale /config. -addr cambia l’indirizzo di ascolto e per impostazione predefinita vale :6262.

Lavora sull’app web

Link a Lavora sull’app web

Lascia il programma in esecuzione. In un secondo terminale, avvia il server di sviluppo:

Terminal window
npm --prefix app/frontend run dev

Il server di sviluppo si ricarica a ogni salvataggio e manda le chiamate API al programma in esecuzione. Dovresti vedere la tua modifica nel browser entro 2 s.

Usa il Makefile

Link a Usa il Makefile
Comando Fa
make ui Installa i pacchetti web e compila l’app web
make build make ui, poi compila bin/holyarrs
make test go test con un timeout di 25 min
make vet go vet ./...
make docker Compila l’immagine come holyarrs:dev
make e2e Esegue i test end-to-end

Attiva una funzione in sospeso

Link a Attiva una funzione in sospeso

Alcune funzioni sono in sospeso e restano disattivate. Indicale in HOLYARRS_FLAGS, separate da virgole:

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

Le pagine nascondono una funzione disattivata e le sue route non esistono. Gli utenti ne leggono in Funzioni in sospeso.

Riempi la Libreria con dati demo

Link a Riempi la Libreria con dati demo

Lo strumento demo riempie una cartella di configurazione con una raccolta demo. Funziona solo con HolyArrs fermo e solo su una cartella che hai contrassegnato come laboratorio. Contrassegnala una volta sola:

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

Poi seed -config ./config aggiunge la libreria demo e seed -config ./config -reset-demo rimuove solo ciò che ha aggiunto. La cartella dei media deve essere /data/media, a meno che tu non passi -force. Gli strumenti di sviluppo restano fuori dall’immagine. Vedi Strumenti di sviluppo.

Se non funziona

Link a Se non funziona

Sintomo. Le pagine sembrano vecchie dopo che hai cambiato l’app web. Causa. Il programma serve la build che ha incorporato. Soluzione. Esegui la build web, poi la build Go, poi avvia il programma.

Sintomo. go build fallisce perché manca app/frontend/dist. Causa. L’app web non è ancora compilata. Soluzione. Esegui prima il passaggio 2.

Sintomo. Il programma dice che la porta è in uso. Causa. Un altro HolyArrs o un’altra app occupa 6262. Soluzione. Passa un altro indirizzo: ./bin/holyarrs -config ./config -addr :6263.

Interruttori delle funzioni in sospeso
Interruttore Funzione
plex_watchlists Le watchlist di Plex diventano richieste
row_title_stats Statistiche delle righe di Esplora per il proprietario
trakt_lists Liste Trakt
alert_channels_more Canali di avviso oltre a Discord e email
subtitle_sites Siti di sottotitoli e ricerca dei sottotitoli
emby_signin Accesso con Emby
go_back Passaggi per tornare alla versione precedente

Per aggiungerne uno, registra il suo nome con startup.RegisterFeature e controlla startup.FeatureOn prima di registrare le sue route. I nomi si trovano in app/backend/internal/core/startup (feature.go).

Strumenti di sviluppo
Strumento Comando Fa
Demo go run ./app/backend/tools/demo <command> -config DIR Lavora su una cartella di configurazione ferma. Comandi: inspect (conteggi), fingerprint, query "SELECT ..." (sola lettura), doctor, seed, showcase
Sito di sottotitoli finto go run ./app/backend/tools/fakesubs Serve siti di sottotitoli finti per i test su 127.0.0.1:18727. -addr lo sposta; -accounts-addr aggiunge i finti siti con account
Elenco delle route go run ./app/backend/tools/apidoc Riscrive Route dell’API
Compila l'immagine
Terminal window
docker build --file deploy/Dockerfile --tag holyarrs:dev .
docker run -p 6262:6262 -v ./config:/config holyarrs:dev

L’immagine parte da FROM scratch e contiene il programma, i certificati CA e le licenze. Esegue -config /config -addr :6262.

HolyArrs è gratis. Se ti ha fatto risparmiare tempo, metti una stella su GitHub, sostienilo o offrimi un caffè.