Import kunci daripada fail
Persediaan
Isi satu fail dengan Sumber, pemuat turun, pelayan media, laman sari kata dan email anda, import fail itu, dan tidak perlu menaip setiap kunci dalam Tetapan.
Sebelum bermula
Pautan ke Sebelum bermula- HolyArrs berjalan dalam Docker dengan konfigurasinya di
/config. - Anda boleh membuat kunci API pemilik dalam Settings > API > API keys (Tetapan > API > kunci API).
Import fail itu
Pautan ke Import fail itu-
Salin holyarrs-secrets.template.yaml ke
holyarrs-secrets.yaml. -
Isi apa yang anda gunakan. Biarkan selebihnya kosong; kosong bermaksud langkau.
-
Jadikan ia boleh dibaca oleh anda sahaja:
Terminal window chmod 600 holyarrs-secrets.yaml -
Lekapkan ia sebagai baca sahaja ke dalam kontena:
volumes:- /srv/holyarrs/config:/config- /srv/holyarrs/holyarrs-secrets.yaml:/run/secrets/holyarrs.yaml:ro -
Buat kunci API pemilik dengan skop admin dalam Settings > API > API keys. Letakkan ia dalam blok
holyarrsfail itu dengan alamathttp://127.0.0.1:6262. -
Cuba larian percubaan. Ia tidak mengubah apa-apa:
Terminal window docker exec holyarrs /holyarrs import-secrets -file /run/secrets/holyarrs.yaml -dry-runAnda akan nampak satu baris
would setbagi setiap item. -
Jalankan sebenarnya (arahan yang sama tanpa
-dry-run). Anda akan nampak barissetdan kod keluar0. -
Semak Sumber dan pemuat turun baharu, kemudian sambungkannya semula. Uji pelayan media dan amaran baharu, kemudian hidupkannya.
-
Padam fail itu pada host (lihat Padam fail). Padam kunci API juga jika anda tidak memerlukannya lagi.
Setiap blok menjadi apa
Pautan ke Setiap blok menjadi apa| Dalam fail | Menjadi |
|---|---|
trakt.client_id |
Kunci app Trakt (Settings > Outside lists (Tetapan > Senarai luar)). |
tmdb, tvdb |
Diterima daripada fail lama. Metadata tidak memerlukan kunci. |
opensubtitles, subdl |
Laman sari kata dengan akaun anda. |
addic7ed |
Laman sari kata Addic7ed, siri sahaja. |
indexers |
Satu Sumber bagi setiap entri, dijeda. |
jackett, prowlarr |
Kuncinya mengisi mana-mana entri indexers pada alamat yang sama yang tiada kunci. |
qbittorrent, sabnzbd |
Satu pemuat turun, dijeda. |
nzbget, transmission, deluge |
Dilangkau. Import belum dapat menyediakan ini; tambahkannya dalam Settings > Downloaders (Tetapan > Pemuat turun). |
jellyfin, emby, plex |
Satu pelayan media, mati sehingga anda mengujinya. |
smtp, discord, webhook |
Amaran “Email”, “Discord” dan “Webhook”, mati sehingga anda mengujinya. |
radarr, sonarr, lidarr, prowlarr, bazarr, seerr |
Kunci yang disimpan untuk Import from other apps (import dari app lain). |
holyarrs |
Hanya digunakan untuk mencapai HolyArrs semasa ia berjalan. Tidak pernah disimpan. |
Setiap kunci masuk ke dalam peti besi yang disulitkan, sama seperti yang ditaip dalam Tetapan.
Pilihan
Pautan ke PilihanSuis rangkaian setempat
Pautan ke Suis rangkaian setempatSetiap blok yang mempunyai alamat boleh menerima allow_local_network: true. Ia membenarkan item itu mencapai komputer ini atau rangkaian rumah anda (192.168.x.x, 10.x.x.x, nama kontena). Tanpanya item itu hanya mencapai internet, jadi pemuat turun di rumah tidak akan memberi respons. HolyArrs tidak pernah meneka ini daripada alamat. Ia suis yang sama seperti May reach the local network (boleh mencapai rangkaian setempat) dalam Tetapan.
Semasa HolyArrs dihentikan
Pautan ke Semasa HolyArrs dihentikanJalankan kontena sekali guna pada konfigurasi yang sama. Ia menyimpan terus ke dalam folder konfigurasi dan tidak memerlukan blok holyarrs:
docker stop holyarrsdocker 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.yamldocker start holyarrsGunakan PUID dan PGID yang sama seperti app, atau folder konfigurasi diserahkan kepada 1000:1000. Pengguna PUID mesti boleh membaca fail itu. Jika anda menggunakan HOLYARRS_MASTER_KEY_FILE, berikan kontena sekali guna itu pemboleh ubah dan pelekapan yang sama.
Menjalankannya semula
Pautan ke Menjalankannya semulaSelamat untuk menjalankannya semula. Item yang sepadan menyatakan unchanged; hanya item yang berubah disimpan.
| Item | Dipadankan mengikut |
|---|---|
| Sumber | nama |
| Pemuat turun, pelayan media | jenis dan alamat |
| Amaran | nama dan jenis |
| Laman sari kata, app lama | jenis |
Sumber atau pemuat turun yang alamat atau kuncinya berubah dijeda semula. Sebaik sahaja anda menyambungnya semula sendiri, larian semula membiarkannya berjalan. api_key kosong pada entri indexers mengekalkan kunci yang disimpan; tambah clear_key: true untuk membuangnya.
Padam fail
Pautan ke Padam failDengan -delete, arahan itu menimpa fail dengan sifar dan membuangnya, hanya selepas larian yang tiada kegagalan. Pelekapan baca sahaja tidak boleh dipadam dari dalam kontena, jadi padamkannya pada host:
| Sistem | Arahan |
|---|---|
| Linux | shred -u holyarrs-secrets.yaml |
| macOS | rm -P holyarrs-secrets.yaml |
| Windows | Remove-Item holyarrs-secrets.yaml, kemudian kosongkan Recycle Bin. |
Pada SSD dan sistem fail copy-on-write, blok lama mungkin kekal pada cakera. Kunci itu sendiri kini berada dalam peti besi yang disulitkan.
Jika tidak berfungsi
Pautan ke Jika tidak berfungsi| Gejala | Punca | Penyelesaian |
|---|---|---|
| Fail boleh dibaca oleh pengguna lain | Kebenaran terlalu terbuka. | Jalankan chmod 600. Pada Windows, simpan dalam folder yang hanya anda boleh buka. |
| Kunci tidak dikenali menghentikan import | Salah taip atau tab pada baris yang dinamakan. | Betulkan baris itu. Tiada apa disimpan. |
| http biasa ditolak | Alamat holyarrs tidak berada pada komputer ini. |
Jalankan di dalam kontena dengan http://127.0.0.1:6262, atau gunakan https. |
| Pemuat turun di rumah tidak memberi respons | Tiada kebenaran rangkaian setempat. | Tetapkan allow_local_network: true pada blok itu. |
| Kontena sekali guna menukar pemilik folder | PUID/PGID berbeza. |
Gunakan PUID dan PGID app. |
-delete tidak melakukan apa-apa |
Sesuatu gagal, atau pelekapan baca sahaja. | Padamkannya pada host. |
Untuk pakar
Pautan ke Untuk pakarBendera dan kod keluar
| Bendera | Fungsi | Lalai |
|---|---|---|
-file <path> |
Fail rahsia. | tiada |
-dry-run |
Hanya menyatakan apa yang akan ditetapkan. | mati |
-config <folder> |
Folder konfigurasi. | /config |
-delete |
Selepas larian tanpa kegagalan, timpa fail dengan sifar dan padamkannya. | mati |
-forget-move-credentials |
Padam setiap kunci app lama yang disimpan, kemudian berhenti. | mati |
-allow-http-lan |
Benarkan http:// biasa ke alamat rangkaian rumah. Mencetak amaran. |
mati |
-allow-readable-file |
Terima fail yang boleh dibaca oleh pengguna lain. Docker Desktop pada Windows menunjukkan setiap fail sebagai boleh dibaca. | mati |
Alamat holyarrs mestilah https://, atau http:// biasa ke komputer ini sahaja (127.0.0.1, ::1, localhost). Melalui http biasa, kunci pemilik dan seluruh fail anda bergerak tanpa penyulitan.
| Kod keluar | Maksud |
|---|---|
0 |
Setiap item berjaya. |
1 |
Satu item gagal. Betulkan fail dan jalankan semula. |
2 |
Baris arahan atau fail tidak sah. |
Output
Satu baris bagi setiap item: set (atau would set dalam larian percubaan, kadangkala dengan nota), unchanged, skipped (empty), skipped (why) atau failed: why. Ia tidak pernah mencetak kunci, kata laluan, token atau alamat. Sejarah mendapat satu peristiwa dengan kiraan sahaja. Ralat yang akan menunjukkan nilai daripada fail anda menunjukkan [hidden] sebagai ganti.
Format fail
Bahagian YAML yang kecil dan ketat:
- blok mengikut lekukan dengan jarak kosong, tidak pernah tab; senarai dengan
-, - nilai biasa, dalam
"double quotes"atau'single quotes'(tulis'dua kali di dalam petikan tunggal), #memulakan komen pada permulaan baris atau selepas jarak kosong di luar petikan, jadi letakkan kata laluan yang mengandungi#dalam petikan,- letakkan nilai dalam petikan jika ia bermula dengan
&,*,!,|,>,[,{,%,@atau tanda petikan terbalik, atau mengandungi:.
Kunci yang tidak dikenali atau fail melebihi 256 KB menghentikan keseluruhan import sebelum apa-apa disimpan; mesej itu menamakan kunci dan baris. Pautan ke fail itu ditolak.
Medan khas
| Medan | Peraturan |
|---|---|
| SABnzbd | Memerlukan api_key penuh. nzb_key, nama pengguna atau kata laluan dilangkau dan tidak pernah disimpan. |
tvdb.api_key, tvdb.unique_user_key, trakt.redirect_urls |
Diterima dan dilangkau. |
smtp.host |
Nama pelayan sahaja, tanpa skema atau port. |
smtp.port |
1 hingga 65535. Lalai 587. |
smtp.from |
Satu alamat email biasa. |
| Blok app lama | Digunakan dalam Import from other apps dengan Use the saved key (guna kunci yang disimpan). Tidak pernah dipaparkan, pemilik sahaja, dipadam selepas satu bacaan berjaya. |
Berkaitan
Pautan ke BerkaitanHolyArrs percuma. Jika ia menjimatkan masa anda, beri bintang di GitHub, taja projek ini atau belanja saya kopi.