Penyiapan

Bangun HolyArrs dari source dan buka di browser di port 6262.

Sebelum mulai

• Go, dengan versi yang disebut go.mod.
• Node 24 dan npm.
• Sebuah terminal di root repo.

Kamu tidak butuh compiler C. Build memakai CGO_ENABLED=0.

Bangun dan jalankan

1. Pasang package aplikasi web:

   npm --prefix app/frontend ci

2. Bangun aplikasi web:

   npm --prefix app/frontend run build

   Kamu akan melihat build selesai dan app/frontend/dist terisi file.

3. Bangun programnya:

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

4. Jalankan dengan folder konfigurasi kamu sendiri:

   ./bin/holyarrs -config ./config

5. Buka http://localhost:6262.

   Kamu akan melihat wizard pertama kali dijalankan. Buat akun pemilik.

Perhatian

Program menanamkan app/frontend/dist di dalamnya. Setelah mengubah aplikasi web, bangun ulang aplikasi web sebelum programnya, atau kamu mendapat halaman lama.

-config menerima folder di disk lokal dan bawaannya /config. -addr mengubah alamat yang didengarkan dan bawaannya :6262.

Mengerjakan aplikasi web

Biarkan programnya tetap berjalan. Di terminal kedua, mulai dev server:

npm --prefix app/frontend run dev

Dev server memuat ulang saat kamu menyimpan dan mengirim panggilan API ke program yang sedang berjalan. Kamu akan melihat perubahan kamu di browser dalam 2 detik.

Pilihan

Pakai Makefile

Perintah	Fungsinya
make ui	Pasang package web dan bangun aplikasi web
make build	make ui, lalu bangun bin/holyarrs
make test	go test dengan batas waktu 25 menit
make vet	go vet ./...
make docker	Bangun image sebagai holyarrs:dev
make e2e	Jalankan tes end-to-end

Aktifkan fitur yang ditunda

Beberapa fitur ditunda dan tetap mati. Sebutkan namanya di HOLYARRS_FLAGS, dipisah koma:

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

Halaman menyembunyikan fitur yang mati, dan route-nya tidak ada. Pengguna bisa membacanya di Fitur yang ditunda.

Isi pustaka dengan data demo

Alat demo mengisi folder konfigurasi dengan koleksi demo. Alat ini hanya bekerja pada HolyArrs yang sudah dihentikan dan hanya pada folder yang kamu tandai sebagai lab. Tandai sekali:

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

Lalu seed -config ./config menambahkan pustaka demo dan seed -config ./config -reset-demo menghapus hanya yang ditambahkannya. Folder media harus /data/media kecuali kamu menyertakan -force. Alat dev tidak masuk ke image. Lihat Alat dev.

Kalau tidak berhasil

Gejala. Halaman terlihat lama setelah kamu mengubah aplikasi web. Penyebab. Program melayani build yang tertanam di dalamnya. Solusi. Jalankan build web, lalu build Go, lalu mulai programnya.

Gejala. go build gagal karena app/frontend/dist tidak ada. Penyebab. Aplikasi web belum dibangun. Solusi. Jalankan langkah 2 dulu.

Gejala. Program bilang port sedang dipakai. Penyebab. HolyArrs lain atau aplikasi lain memakai 6262. Solusi. Beri alamat lain: ./bin/holyarrs -config ./config -addr :6263.

Untuk yang mahir

Sakelar fitur yang ditunda

Sakelar	Fitur
row_title_stats	Statistik baris Jelajahi untuk pemilik
trakt_lists	Daftar Trakt
alert_channels_more	Saluran notifikasi selain Discord dan email
subtitle_sites	Situs subtitle dan pencarian subtitle
emby_signin	Masuk dengan Emby
go_back	Langkah untuk kembali ke versi sebelumnya

Untuk menambahkan satu, daftarkan namanya dengan startup.RegisterFeature dan periksa startup.FeatureOn sebelum mendaftarkan route-nya. Nama-namanya ada di app/backend/internal/core/startup (feature.go).

Alat dev

Alat	Perintah	Fungsinya
Demo	go run ./app/backend/tools/demo <command> -config DIR	Bekerja pada folder konfigurasi yang sudah dihentikan. Perintah: inspect (hitungan), fingerprint, query "SELECT ..." (hanya-baca), doctor, seed, showcase
Situs subtitle palsu	go run ./app/backend/tools/fakesubs	Melayani situs subtitle palsu untuk tes di 127.0.0.1:18727. -addr memindahkannya; -accounts-addr menambahkan situs akun palsu
Daftar route	go run ./app/backend/tools/apidoc	Menulis ulang Route API

Bangun image

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

Image dimulai dari FROM scratch dan berisi program, sertifikat CA, dan lisensi. Image menjalankan -config /config -addr :6262.

Terkait

• Berkontribusi
• Pengujian
• Modul