Impor kunci dari file

Isi satu file dengan Sumber, Downloader, server media, situs subtitle, dan email kamu, impor, dan lewati mengetik tiap kunci di Settings.

Sebelum mulai

• HolyArrs berjalan di Docker dengan konfigurasinya di /config.
• Kamu bisa membuat kunci API pemilik di Settings > API > API keys (pengaturan > API > kunci API).

Impor filenya

1. Salin holyarrs-secrets.template.yaml menjadi holyarrs-secrets.yaml.

2. Isi yang kamu pakai. Biarkan sisanya kosong; kosong berarti dilewati.

3. Buat agar hanya bisa dibaca oleh kamu:

   chmod 600 holyarrs-secrets.yaml

4. Mount ke container dalam mode hanya-baca:

   volumes:
     - /srv/holyarrs/config:/config
     - /srv/holyarrs/holyarrs-secrets.yaml:/run/secrets/holyarrs.yaml:ro

5. Buat kunci API pemilik dengan scope admin di Settings > API > API keys. Taruh di blok holyarrs pada file, dengan alamat http://127.0.0.1:6262.

6. Coba dry run. Ini tidak mengubah apa pun:

   docker exec holyarrs /holyarrs import-secrets -file /run/secrets/holyarrs.yaml -dry-run

   Kamu akan melihat satu baris would set untuk tiap item.

7. Jalankan sungguhan (perintah yang sama tanpa -dry-run). Kamu akan melihat baris set dan exit code 0.

8. Periksa Sumber dan Downloader baru, lalu lanjutkan. Uji server media dan Notifikasi baru, lalu aktifkan.

9. Hapus file di host (lihat Hapus filenya). Hapus juga kunci API kalau tidak diperlukan lagi.

Perhatian

File ini menyimpan semua rahasia sebagai teks biasa sampai kamu menghapusnya. Hapus di host segera setelah proses berhasil.

Hasil dari tiap blok

Di file	Menjadi
trakt.client_id	Kunci aplikasi Trakt (Settings > Outside lists (daftar luar)).
tmdb, tvdb	Diterima dari file lama. Metadata tidak butuh kunci.
opensubtitles, subdl	Situs subtitle dengan akun kamu.
addic7ed	Situs subtitle Addic7ed, hanya serial.
indexers	Satu Sumber per entri, paused (dijeda).
jackett, prowlarr	Kuncinya mengisi setiap entri indexers di alamat yang sama yang belum punya kunci.
qbittorrent, sabnzbd	Sebuah Downloader, paused.
nzbget, transmission, deluge	Dilewati. Impor belum bisa menyiapkan ini; tambahkan di Settings > Downloaders.
jellyfin, emby, plex	Sebuah server media, off (nonaktif) sampai kamu mengujinya.
smtp, discord, webhook	Notifikasi “Email”, “Discord”, dan “Webhook”, off sampai kamu mengujinya.
radarr, sonarr, lidarr, prowlarr, bazarr, seerr	Kunci yang disimpan untuk Import from other apps (impor dari aplikasi lain).
holyarrs	Hanya dipakai untuk menjangkau HolyArrs saat berjalan. Tidak pernah disimpan.

Setiap kunci masuk ke vault terenkripsi, sama seperti yang diketik di Settings.

Pilihan

Sakelar jaringan lokal

Tiap blok yang punya alamat bisa memakai allow_local_network: true. Ini membuat item itu bisa menjangkau komputer ini atau jaringan rumah kamu (192.168.x.x, 10.x.x.x, nama container). Tanpanya, item itu hanya menjangkau internet, jadi Downloader di rumah tidak akan merespons. HolyArrs tidak pernah menebak ini dari alamatnya. Ini sakelar yang sama dengan May reach the local network (boleh menjangkau jaringan lokal) di Settings.

Saat HolyArrs dihentikan

Jalankan container sekali pakai di konfigurasi yang sama. Container itu menyimpan langsung ke folder konfigurasi dan tidak butuh blok holyarrs:

docker stop holyarrs
docker run --rm -e PUID=1000 -e PGID=1000 \
  -v /srv/holyarrs/config:/config \
  -v /srv/holyarrs/holyarrs-secrets.yaml:/run/secrets/holyarrs.yaml:ro \
  holyarrs/holyarrs:latest import-secrets -file /run/secrets/holyarrs.yaml
docker start holyarrs

Pakai PUID dan PGID yang sama dengan aplikasi, kalau tidak folder konfigurasi diserahkan ke 1000:1000. Pengguna PUID harus bisa membaca file itu. Kalau kamu memakai HOLYARRS_MASTER_KEY_FILE, beri container sekali pakai itu variabel dan mount yang sama.

Menjalankannya lagi

Menjalankannya lagi aman. Item yang cocok menampilkan unchanged; hanya item yang berubah yang disimpan.

Item	Dicocokkan lewat
Sumber	nama
Downloader, server media	jenis dan alamat
Notifikasi	nama dan jenis
Situs subtitle, aplikasi lama	jenis

Sumber atau Downloader yang alamat atau kuncinya berubah dijeda lagi. Setelah kamu melanjutkannya sendiri, menjalankan ulang membiarkannya tetap berjalan. api_key kosong pada entri indexers mempertahankan kunci yang tersimpan; tambahkan clear_key: true untuk menghapusnya.

Hapus filenya

Dengan -delete, perintah menimpa file dengan nol lalu menghapusnya, hanya setelah proses tanpa kegagalan. Mount hanya-baca tidak bisa dihapus dari dalam container, jadi hapus di host:

Sistem	Perintah
Linux	shred -u holyarrs-secrets.yaml
macOS	rm -P holyarrs-secrets.yaml
Windows	Remove-Item holyarrs-secrets.yaml, lalu kosongkan Recycle Bin.

Di SSD dan sistem file copy-on-write, blok lama mungkin tetap ada di disk. Kunci itu sendiri sekarang ada di vault terenkripsi.

Kalau tidak berhasil

Gejala	Penyebab	Solusi
File bisa dibaca pengguna lain	Izin terlalu terbuka.	Jalankan chmod 600. Di Windows, simpan di folder yang hanya bisa kamu buka.
Kunci yang tidak dikenal menghentikan impor	Salah ketik atau ada tab di baris yang disebut.	Perbaiki baris itu. Tidak ada yang disimpan.
http biasa ditolak	Alamat holyarrs tidak ada di komputer ini.	Jalankan di dalam container dengan http://127.0.0.1:6262, atau pakai https.
Downloader di rumah tidak merespons	Tidak ada izin jaringan lokal.	Atur allow_local_network: true pada blok itu.
Container sekali pakai mengubah pemilik folder	PUID/PGID berbeda.	Pakai PUID dan PGID milik aplikasi.
-delete tidak melakukan apa-apa	Ada yang gagal, atau mount-nya hanya-baca.	Hapus di host.

Untuk yang mahir

Flag dan exit code

Flag	Fungsi	Bawaan
-file <path>	File rahasia.	tidak ada
-dry-run	Hanya menyebut apa yang akan diatur.	nonaktif
-config <folder>	Folder konfigurasi.	/config
-delete	Setelah proses tanpa kegagalan, menimpa file dengan nol dan menghapusnya.	nonaktif
-forget-move-credentials	Menghapus setiap kunci aplikasi lama yang tersimpan, lalu berhenti.	nonaktif
-allow-http-lan	Mengizinkan http:// biasa ke alamat jaringan rumah. Mencetak peringatan.	nonaktif
-allow-readable-file	Menerima file yang bisa dibaca pengguna lain. Docker Desktop di Windows menampilkan setiap file sebagai bisa dibaca.	nonaktif

Alamat holyarrs harus https://, atau http:// biasa hanya ke komputer ini (127.0.0.1, ::1, localhost). Lewat http biasa, kunci pemilik dan seluruh file dikirim tanpa enkripsi.

Exit code	Arti
0	Setiap item berhasil.
1	Sebuah item gagal. Perbaiki file dan jalankan lagi.
2	Baris perintah atau file salah.

Output

Satu baris per item: set (atau would set pada dry run, kadang dengan catatan), unchanged, skipped (empty), skipped (why), atau failed: why. Output tidak pernah mencetak kunci, kata sandi, token, atau alamat. Riwayat mendapat satu kejadian dengan jumlah saja. Error yang akan menampilkan nilai dari file kamu menampilkan [hidden] sebagai gantinya.

Format file

Bagian YAML yang kecil dan ketat:

• blok lewat indentasi dengan spasi, tidak pernah tab; daftar dengan - ,
• nilai biasa, dalam "double quotes" atau 'single quotes' (tulis ' di dalam kutip tunggal dua kali),
• # memulai komentar di awal baris atau setelah spasi di luar kutip, jadi beri kutip pada kata sandi yang memuat #,
• beri kutip pada nilai yang diawali &, *, !, |, >, [, {, %, @, atau backquote, atau yang memuat : .

Kunci yang tidak dikenal atau file di atas 256 KB menghentikan seluruh impor sebelum apa pun disimpan; pesannya menyebut kunci dan barisnya. Tautan ke file ditolak.

Kolom khusus

Kolom	Aturan
SABnzbd	Butuh api_key lengkap. nzb_key, nama pengguna, atau kata sandi dilewati dan tidak pernah disimpan.
tvdb.api_key, tvdb.unique_user_key, trakt.redirect_urls	Diterima dan dilewati.
smtp.host	Hanya nama server, tanpa skema atau port.
smtp.port	1 sampai 65535. Bawaan 587.
smtp.from	Satu alamat email biasa.
Blok aplikasi lama	Dipakai di Import from other apps dengan Use the saved key (pakai kunci tersimpan). Tidak pernah ditampilkan, hanya untuk pemilik, dihapus setelah satu kali dibaca dengan berhasil.

Terkait

• Baca aplikasi lama kamu
• Variabel lingkungan