İçeriğe geç

Kurulum

Kurulum

HolyArrs’ı kaynaktan derle ve tarayıcında 6262 portundan aç.

  • Go, go.mod dosyasının adını verdiği sürümde.
  • Node 24 ve npm.
  • Repo kökünde açık bir terminal.

C derleyicisine ihtiyacın yok. Derlemeler CGO_ENABLED=0 kullanır.

  1. Web uygulaması paketlerini kur:

    Terminal window
    npm --prefix app/frontend ci
  2. Web uygulamasını derle:

    Terminal window
    npm --prefix app/frontend run build

    Derlemenin bittiğini ve app/frontend/dist klasörünün dosyalarla dolduğunu görmelisin.

  3. Programı derle:

    Terminal window
    go build -o bin/holyarrs ./app/backend/cmd/holyarrs
  4. Kendi yapılandırma klasörünle çalıştır:

    Terminal window
    ./bin/holyarrs -config ./config
  5. http://localhost:6262 adresini aç.

    İlk açılış sihirbazını görmelisin. Sahip hesabını oluştur.

-config yerel diskteki bir klasör alır ve varsayılanı /config’dir. -addr dinleme adresini değiştirir ve varsayılanı :6262’dir.

Web uygulaması üzerinde çalış

Web uygulaması üzerinde çalış bağlantısı

Programı çalışır halde bırak. İkinci bir terminalde geliştirme sunucusunu başlat:

Terminal window
npm --prefix app/frontend run dev

Geliştirme sunucusu kaydettiğinde yeniden yüklenir ve API çağrılarını çalışan programa gönderir. Düzenlemeni tarayıcıda 2 saniye içinde görmelisin.

Komut Ne yapar
make ui Web paketlerini kurar ve web uygulamasını derler
make build make ui çalıştırır, sonra bin/holyarrs dosyasını derler
make test 25 dakikalık zaman aşımıyla go test
make vet go vet ./...
make docker İmajı holyarrs:dev olarak derler
make e2e Uçtan uca testleri çalıştırır

Bekletilen bir özelliği aç

Bekletilen bir özelliği aç bağlantısı

Bazı özellikler bekletilir ve kapalı kalır. Bunları HOLYARRS_FLAGS içinde virgülle ayırarak yaz:

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

Kapalı bir özelliği sayfalar gizler ve rotaları yoktur. Kullanıcılar bunları Bekletilen özellikler bölümünden okur.

Kütüphaneyi demo verisiyle doldur

Kütüphaneyi demo verisiyle doldur bağlantısı

Demo aracı bir yapılandırma klasörünü demo koleksiyonla doldurur. Yalnızca durdurulmuş bir HolyArrs üzerinde ve lab olarak işaretlediğin bir klasörde çalışır. Bir kez işaretle:

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

Sonra seed -config ./config demo kütüphaneyi ekler, seed -config ./config -reset-demo ise yalnızca eklediklerini siler. -force vermezsen medya klasörü /data/media olmalıdır. Geliştirme araçları imajın dışında kalır. Bkz. Geliştirme araçları.

Belirti. Web uygulamasını değiştirdikten sonra sayfalar eski görünüyor. Neden. Program, içine gömdüğü derlemeyi sunar. Çözüm. Önce web derlemesini, sonra Go derlemesini çalıştır, sonra programı başlat.

Belirti. go build, eksik app/frontend/dist yüzünden başarısız oluyor. Neden. Web uygulaması henüz derlenmedi. Çözüm. Önce 2. adımı çalıştır.

Belirti. Program portun kullanımda olduğunu söylüyor. Neden. Başka bir HolyArrs ya da uygulama 6262 portunu tutuyor. Çözüm. Başka bir adres ver: ./bin/holyarrs -config ./config -addr :6263.

Bekletilen anahtarlar
Anahtar Özellik
plex_watchlists Plex izleme listeleri istek olur
row_title_stats Sahip için Explore satırı istatistikleri
trakt_lists Trakt listeleri
alert_channels_more Discord ve e-posta dışındaki uyarı kanalları
subtitle_sites Altyazı siteleri ve altyazı arama
emby_signin Emby ile giriş
go_back Önceki sürüme dönme adımları

Bir tane eklemek için adını startup.RegisterFeature ile kaydet ve rotalarını kaydetmeden önce startup.FeatureOn değerine bak. Adlar app/backend/internal/core/startup içinde (feature.go).

Geliştirme araçları
Araç Komut Ne yapar
Demo go run ./app/backend/tools/demo <command> -config DIR Durdurulmuş bir yapılandırma klasöründe çalışır. Komutlar: inspect (sayımlar), fingerprint, query "SELECT ..." (salt okunur), doctor, seed, showcase
Sahte altyazı sitesi go run ./app/backend/tools/fakesubs Testler için sahte altyazı sitelerini 127.0.0.1:18727 üzerinden sunar. -addr onu taşır; -accounts-addr hesap sitesi sahtelerini ekler
Rota listesi go run ./app/backend/tools/apidoc API rotalarını yeniden yazar
İmajı derle
Terminal window
docker build --file deploy/Dockerfile --tag holyarrs:dev .
docker run -p 6262:6262 -v ./config:/config holyarrs:dev

İmaj FROM scratch ile başlar ve programı, CA sertifikalarını ve lisansları tutar. -config /config -addr :6262 ile çalışır.

HolyArrs ücretsiz. Zamanından tasarruf ettirdiyse GitHub'da yıldızla, sponsor ol ya da bana bir kahve ısmarla.