Thiết lập

Build HolyArrs từ mã nguồn và mở nó trong trình duyệt trên cổng 6262.

Trước khi bắt đầu

• Go, đúng phiên bản mà go.mod nêu.
• Node 24 và npm.
• Một terminal ở thư mục gốc của repo.

Bạn không cần trình biên dịch C. Các bản build dùng CGO_ENABLED=0.

Build và chạy

1. Cài các gói của ứng dụng web:

   npm --prefix app/frontend ci

2. Build ứng dụng web:

   npm --prefix app/frontend run build

   Bạn sẽ thấy bản build hoàn tất và app/frontend/dist có đầy tệp.

3. Build chương trình:

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

4. Chạy nó với một thư mục cấu hình của riêng bạn:

   ./bin/holyarrs -config ./config

5. Mở http://localhost:6262.

   Bạn sẽ thấy trình hướng dẫn lần chạy đầu tiên. Hãy tạo tài khoản chủ sở hữu.

Chú ý

Chương trình nhúng sẵn app/frontend/dist. Sau khi sửa ứng dụng web, hãy build lại ứng dụng web trước khi build chương trình, nếu không bạn sẽ nhận các trang cũ.

-config nhận một thư mục trên ổ đĩa cục bộ và mặc định là /config. -addr đổi địa chỉ lắng nghe và mặc định là :6262.

Làm việc với ứng dụng web

Cứ để chương trình chạy. Trong một terminal thứ hai, khởi động dev server:

npm --prefix app/frontend run dev

Dev server tải lại khi bạn lưu và gửi các lệnh gọi API đến chương trình đang chạy. Bạn sẽ thấy thay đổi của mình trong trình duyệt trong vòng 2 s.

Lựa chọn

Dùng Makefile

Lệnh	Tác dụng
make ui	Cài các gói web và build ứng dụng web
make build	make ui, rồi build bin/holyarrs
make test	go test với thời gian chờ 25 phút
make vet	go vet ./...
make docker	Build image với tên holyarrs:dev
make e2e	Chạy các bài kiểm thử end-to-end

Bật một tính năng chưa mở

Một số tính năng chưa mở và luôn tắt. Gọi tên chúng trong HOLYARRS_FLAGS, phân tách bằng dấu phẩy:

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

Các trang ẩn tính năng đang tắt, và route của nó không tồn tại. Người dùng đọc về chúng trong Tính năng chưa mở.

Đổ dữ liệu demo vào Thư viện

Công cụ demo đổ một bộ sưu tập demo vào thư mục cấu hình. Nó chỉ hoạt động khi HolyArrs đã dừng và chỉ trên thư mục mà bạn đã đánh dấu là lab. Đánh dấu một lần:

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

Sau đó seed -config ./config thêm thư viện demo và seed -config ./config -reset-demo chỉ gỡ những gì nó đã thêm. Thư mục media phải là /data/media trừ khi bạn truyền -force. Các công cụ phát triển không có trong image. Xem Công cụ phát triển.

Nếu không hoạt động

Triệu chứng. Các trang trông như bản cũ sau khi bạn sửa ứng dụng web. Nguyên nhân. Chương trình phục vụ bản build mà nó đã nhúng sẵn. Cách khắc phục. Chạy bản build web, rồi bản build Go, rồi khởi động chương trình.

Triệu chứng. go build thất bại vì thiếu app/frontend/dist. Nguyên nhân. Ứng dụng web chưa được build. Cách khắc phục. Chạy bước 2 trước.

Triệu chứng. Chương trình báo cổng đang được dùng. Nguyên nhân. Một HolyArrs khác hoặc một ứng dụng khác đang giữ 6262. Cách khắc phục. Truyền một địa chỉ khác: ./bin/holyarrs -config ./config -addr :6263.

Dành cho người dùng nâng cao

Công tắc tính năng chưa mở

Công tắc	Tính năng
row_title_stats	Thống kê hàng trên Khám phá cho chủ sở hữu
trakt_lists	Danh sách Trakt
alert_channels_more	Các kênh cảnh báo ngoài Discord và email
subtitle_sites	Các trang phụ đề và tìm phụ đề
emby_signin	Đăng nhập bằng Emby
go_back	Các bước để quay lại phiên bản trước

Để thêm một công tắc, đăng ký tên của nó bằng startup.RegisterFeature và kiểm tra startup.FeatureOn trước khi đăng ký các route của nó. Các tên nằm trong app/backend/internal/core/startup (feature.go).

Công cụ phát triển

Công cụ	Lệnh	Tác dụng
Demo	go run ./app/backend/tools/demo <command> -config DIR	Hoạt động trên thư mục cấu hình đã dừng. Các lệnh: inspect (đếm số lượng), fingerprint, query "SELECT ..." (chỉ đọc), doctor, seed, showcase
Trang phụ đề giả	go run ./app/backend/tools/fakesubs	Phục vụ các trang phụ đề giả cho kiểm thử trên 127.0.0.1:18727. -addr đổi địa chỉ; -accounts-addr thêm các trang tài khoản giả
Danh sách route	go run ./app/backend/tools/apidoc	Viết lại Các route API

Build image

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

Image bắt đầu từ FROM scratch và chứa chương trình, chứng chỉ CA và các giấy phép. Nó chạy -config /config -addr :6262.

Liên quan

• Đóng góp
• Kiểm thử
• Module