Persediaan

Bina HolyArrs daripada sumber dan bukanya dalam pelayar anda pada port 6262.

Sebelum bermula

• Go, pada versi yang dinamakan oleh go.mod.
• Node 24 dan npm.
• Terminal dalam akar repo.

Anda tidak memerlukan pengkompil C. Binaan menggunakan CGO_ENABLED=0.

Bina dan jalankan

1. Pasang pakej app web:

   npm --prefix app/frontend ci

2. Bina app web:

   npm --prefix app/frontend run build

   Anda akan nampak binaan selesai dan app/frontend/dist terisi dengan fail.

3. Bina program:

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

4. Jalankannya dengan folder konfigurasi anda sendiri:

   ./bin/holyarrs -config ./config

5. Buka http://localhost:6262.

   Anda akan nampak wizard larian pertama. Buat akaun pemilik.

Caution

Program membenamkan app/frontend/dist. Selepas perubahan pada app web, bina semula app web sebelum program, atau anda akan mendapat halaman lama.

-config menerima folder pada cakera setempat dan lalai kepada /config. -addr mengubah alamat mendengar dan lalai kepada :6262.

Bekerja pada app web

Biarkan program berjalan. Dalam terminal kedua, mulakan pelayan pembangunan:

npm --prefix app/frontend run dev

Pelayan pembangunan memuat semula apabila anda simpan dan menghantar panggilan API kepada program yang sedang berjalan. Anda akan nampak suntingan anda dalam pelayar dalam masa 2 s.

Pilihan

Gunakan Makefile

Arahan	Fungsi
make ui	Pasang pakej web dan bina app web
make build	make ui, kemudian bina bin/holyarrs
make test	go test dengan had masa 25 min
make vet	go vet ./...
make docker	Bina imej sebagai holyarrs:dev
make e2e	Jalankan ujian hujung ke hujung

Hidupkan ciri ditahan

Sesetengah ciri ditahan dan kekal mati. Namakannya dalam HOLYARRS_FLAGS, dipisahkan dengan koma:

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

Halaman menyembunyikan ciri yang mati, dan laluannya tidak wujud. Pengguna membaca tentangnya dalam Ciri ditahan.

Isi Pustaka dengan data demo

Alat demo mengisi folder konfigurasi dengan koleksi demo. Ia hanya berfungsi pada HolyArrs yang dihentikan dan hanya pada folder yang anda tandakan sebagai makmal. Tandakan sekali:

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

Kemudian seed -config ./config menambah pustaka demo dan seed -config ./config -reset-demo membuang hanya apa yang ditambahnya. Folder media mestilah /data/media melainkan anda menghantar -force. Alat pembangunan tidak masuk dalam imej. Lihat Alat pembangunan.

Jika tidak berfungsi

Gejala. Halaman nampak lama selepas anda mengubah app web. Punca. Program menggunakan binaan yang dibenamkan padanya. Penyelesaian. Jalankan binaan web, kemudian binaan Go, kemudian mulakan program.

Gejala. go build gagal kerana app/frontend/dist tiada. Punca. App web belum dibina. Penyelesaian. Jalankan langkah 2 dahulu.

Gejala. Program berkata port sedang digunakan. Punca. HolyArrs lain atau app lain memegang 6262. Penyelesaian. Hantar alamat lain: ./bin/holyarrs -config ./config -addr :6263.

Untuk pakar

Suis ciri ditahan

Suis	Ciri
row_title_stats	Statistik baris Teroka untuk pemilik
trakt_lists	Senarai Trakt
alert_channels_more	Saluran amaran selain Discord dan email
subtitle_sites	Laman sari kata dan carian sari kata
emby_signin	Log masuk dengan Emby
go_back	Langkah untuk kembali ke versi sebelumnya

Untuk menambah satu, daftarkan namanya dengan startup.RegisterFeature dan semak startup.FeatureOn sebelum anda mendaftarkan laluannya. Nama-namanya ada dalam app/backend/internal/core/startup (feature.go).

Alat pembangunan

Alat	Arahan	Fungsi
Demo	go run ./app/backend/tools/demo <command> -config DIR	Berfungsi pada folder konfigurasi yang dihentikan. Arahan: inspect (kiraan), fingerprint, query "SELECT ..." (baca sahaja), doctor, seed, showcase
Laman sari kata palsu	go run ./app/backend/tools/fakesubs	Menyediakan laman sari kata palsu untuk ujian pada 127.0.0.1:18727. -addr mengalihkannya; -accounts-addr menambah laman akaun palsu
Senarai laluan	go run ./app/backend/tools/apidoc	Menulis semula Laluan API

Bina imej

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

Imej bermula FROM scratch dan memuatkan program, sijil CA dan lesen. Ia menjalankan -config /config -addr :6262.

Berkaitan

• Menyumbang
• Pengujian
• Modul