Mag-import ng mga key mula sa file

Punan ang isang file ng mga Pinagkukunan, Downloader, media server, site ng subtitle at mail mo, i-import ito, at huwag nang i-type isa-isa ang bawat key sa Settings.

Bago ka magsimula

• Tumatakbo ang HolyArrs sa Docker na ang config nito ay nasa /config.
• Puwede kang gumawa ng owner API key sa Settings > API > API keys.

I-import ang file

1. Kopyahin ang holyarrs-secrets.template.yaml sa holyarrs-secrets.yaml.

2. Punan ang mga ginagamit mo. Iwanang walang laman ang iba; ang walang laman ay nangangahulugang laktawan.

3. Gawin itong mababasa mo lang:

   chmod 600 holyarrs-secrets.yaml

4. I-mount ito nang read-only sa container:

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

5. Gumawa ng owner API key na may scope na admin sa Settings > API > API keys. Ilagay ito sa block na holyarrs ng file kasama ang address na http://127.0.0.1:6262.

6. Subukan ang dry run. Wala itong binabago:

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

   Dapat makita mo ang isang linyang would set kada aytem.

7. Patakbuhin ito nang totoo (parehong command na walang -dry-run). Dapat makita mo ang mga linyang set at exit code na 0.

8. Suriin ang mga bagong Pinagkukunan at Downloader, tapos ituloy ang mga ito. Subukan ang mga bagong media server at Alerto, tapos i-on ang mga ito.

9. Burahin ang file sa host (tingnan ang Burahin ang file). Burahin din ang API key kung hindi mo na kailangan.

Caution

Hawak ng file ang bawat sikreto nang plain text hanggang burahin mo ito. Burahin ito sa host sa sandaling magtagumpay ang takbo.

Ano ang nagiging bawat block

Sa file	Nagiging
trakt.client_id	Ang key ng Trakt app (Settings > Outside lists (panlabas na listahan)).
tmdb, tvdb	Tinatanggap mula sa mga lumang file. Hindi nangangailangan ng key ang metadata.
opensubtitles, subdl	Isang site ng subtitle na may account mo.
addic7ed	Isang site ng subtitle na Addic7ed, mga palabas lang.
indexers	Isang Pinagkukunan kada entry, paused (naka-pause).
jackett, prowlarr	Pinupunan ng key nila ang anumang entry ng indexers sa parehong address na walang key.
qbittorrent, sabnzbd	Isang Downloader, paused.
nzbget, transmission, deluge	Nilalampasan. Hindi pa kayang i-set up ng import ang mga ito; idagdag sa Settings > Downloaders.
jellyfin, emby, plex	Isang media server, off hanggang subukan mo.
smtp, discord, webhook	Ang “Email”, “Discord” at “Webhook” ng Alerto, off hanggang subukan mo.
radarr, sonarr, lidarr, prowlarr, bazarr, seerr	Isang key na naka-save para sa Import from other apps (mag-import mula sa ibang app).
holyarrs	Ginagamit lang para maabot ang HolyArrs habang tumatakbo ito. Hindi kailanman sine-save.

Napupunta ang bawat key sa naka-encrypt na vault, kapareho ng itina-type sa Settings.

Mga pagpipilian

Ang switch ng lokal na network

Ang bawat block na may address ay puwedeng magkaroon ng allow_local_network: true. Pinapayagan nito ang aytem na maabot ang computer na ito o ang home network mo (192.168.x.x, 10.x.x.x, pangalan ng container). Kung wala ito, internet lang ang maaabot ng aytem, kaya hindi sasagot ang Downloader sa bahay. Hindi kailanman hinuhulaan ito ng HolyArrs mula sa address. Ito ang parehong switch ng May reach the local network (maaaring umabot sa lokal na network) sa Settings.

Habang nakahinto ang HolyArrs

Magpatakbo ng pansamantalang container sa parehong config. Direkta itong nagse-save sa config folder at hindi nangangailangan ng block na 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

Gamitin ang parehong PUID at PGID ng app, kung hindi, ibibigay ang config folder sa 1000:1000. Dapat mabasa ng user ng PUID ang file. Kung ginagamit mo ang HOLYARRS_MASTER_KEY_FILE, ibigay sa pansamantalang container ang parehong variable at mount.

Pagpapatakbo ulit

Ligtas ang pagpapatakbo ulit. Ang mga tumutugmang aytem ay magsasabing unchanged; ang mga nagbago lang ang sine-save.

Aytem	Itinutugma ayon sa
Mga Pinagkukunan	pangalan
Mga Downloader, media server	uri at address
Mga Alerto	pangalan at uri
Mga site ng subtitle, mga naunang app	uri

Ang Pinagkukunan o Downloader na nagbago ang address o key ay ipo-pause ulit. Kapag ikaw mismo ang nagtuloy ng isa, hindi ito ititigil ng pagpapatakbo ulit. Ang walang lamang api_key sa entry ng indexers ay nagpapanatili sa naka-store na key; magdagdag ng clear_key: true para alisin ito.

Burahin ang file

Sa -delete, ino-overwrite ng command ang file ng mga zero at tinatanggal ito, pagkatapos lang ng takbo na walang pumalya. Hindi mabubura ang read-only na mount mula sa loob ng container, kaya burahin ito sa host:

System	Command
Linux	shred -u holyarrs-secrets.yaml
macOS	rm -P holyarrs-secrets.yaml
Windows	Remove-Item holyarrs-secrets.yaml, tapos alisin ang laman ng Recycle Bin.

Sa mga SSD at copy-on-write na file system, maaaring manatili sa disk ang mga lumang block. Ang mga key mismo ay nasa naka-encrypt na vault na ngayon.

Kung hindi gumana

Sintomas	Dahilan	Solusyon
Nababasa ng ibang user ang file	Masyadong bukas ang mga permiso.	Patakbuhin ang chmod 600. Sa Windows, itago ito sa folder na ikaw lang ang makakabukas.
Pinahinto ng hindi kilalang key ang import	Typo o tab sa pinangalanang linya.	Ayusin ang linyang iyon. Walang na-save.
Tinanggihan ang plain http	Wala sa computer na ito ang address ng holyarrs.	Patakbuhin sa loob ng container gamit ang http://127.0.0.1:6262, o gumamit ng https.
Hindi sumasagot ang Downloader sa bahay	Walang permiso sa lokal na network.	I-set ang allow_local_network: true sa block na iyon.
Binago ng pansamantalang container ang mga owner ng folder	Magkaibang PUID/PGID.	Gamitin ang PUID at PGID ng app.
Walang ginawa ang -delete	May pumalya, o read-only ang mount.	Burahin ito sa host.

Para sa mga eksperto

Mga flag at exit code

Flag	Ano ang ginagawa	Default
-file <path>	Ang file ng mga sikreto.	wala
-dry-run	Sasabihin lang kung ano ang ise-set.	off
-config <folder>	Ang config folder.	/config
-delete	Pagkatapos ng takbo na walang pumalya, ino-overwrite ang file ng mga zero at binubura ito.	off
-forget-move-credentials	Binubura ang bawat naka-save na key ng naunang app, tapos hihinto.	off
-allow-http-lan	Pinapayagan ang plain na http:// sa address ng home network. Nagpi-print ng babala.	off
-allow-readable-file	Tumatanggap ng file na mababasa ng ibang user. Ipinapakitang nababasa ng Docker Desktop sa Windows ang bawat file.	off

Ang address ng holyarrs ay dapat https://, o plain na http:// sa computer na ito lang (127.0.0.1, ::1, localhost). Sa plain http, hindi naka-encrypt ang owner key mo at ang buong file habang bumibiyahe.

Exit code	Kahulugan
0	Naging maayos ang bawat aytem.
1	Pumalya ang isang aytem. Ayusin ang file at patakbuhin ulit.
2	Maling command line o file.

Output

Isang linya kada aytem: set (o would set sa dry run, minsan may tala), unchanged, skipped (empty), skipped (why) o failed: why. Hindi ito nagpi-print ng key, password, token o address. Ang History ay nakakakuha ng isang Event na may bilang lang. Ang error na magpapakita sana ng halaga mula sa file mo ay nagpapakita ng [hidden] sa halip.

Format ng file

Isang maliit at mahigpit na bahagi ng YAML:

• mga block ayon sa indentation gamit ang mga space, hindi kailanman tab; mga listahan na may - ,
• mga value na plain, sa "double quotes" o 'single quotes' (isulat nang dalawang beses ang ' sa loob ng single quotes),
• nagsisimula ang komento sa # sa simula ng linya o pagkatapos ng space sa labas ng quotes, kaya lagyan ng quotes ang password na may #,
• lagyan ng quotes ang value na nagsisimula sa &, *, !, |, >, [, {, %, @ o backquote, o may : .

Ang hindi kilalang key o file na mahigit 256 KB ay pinahihinto ang buong import bago may ma-save; pinapangalanan ng mensahe ang key at linya. Tinatanggihan ang link papunta sa file.

Mga espesyal na field

Field	Patakaran
SABnzbd	Kailangan ang buong api_key. Ang nzb_key, username o password ay nilalampasan at hindi kailanman sine-store.
tvdb.api_key, tvdb.unique_user_key, trakt.redirect_urls	Tinatanggap at nilalampasan.
smtp.host	Pangalan ng server lang, walang scheme o port.
smtp.port	1 hanggang 65535. Default 587.
smtp.from	Isang plain na email address.
Mga block ng naunang app	Ginagamit sa Import from other apps na may Use the saved key (gamitin ang naka-save na key). Hindi kailanman ipinapakita, owner lang, binubura pagkatapos ng isang matagumpay na pagbasa.

Kaugnay

• Basahin ang mga naunang app mo
• Mga environment variable