Pāriet uz saturu

Importē atslēgas no faila

Iestatīšana

Aizpildi vienu failu ar saviem avotiem, lejupielādētājiem, multivides serveriem, subtitru vietnēm un pastu, importē to un neraksti katru atslēgu iestatījumos.

  • HolyArrs darbojas Docker vidē, un tā konfigurācija ir mapē /config.
  • Īpašnieka API atslēgu vari izveidot sadaļā Settings > API > API keys (iestatījumi > API > API atslēgas).
  1. Nokopē holyarrs-secrets.template.yaml uz holyarrs-secrets.yaml.

  2. Aizpildi to, ko izmanto. Pārējo atstāj tukšu; tukšs nozīmē izlaist.

  3. Padari to lasāmu tikai tev:

    Terminal window
    chmod 600 holyarrs-secrets.yaml
  4. Piemontē to konteinerā tikai lasāmu:

    volumes:
    - /srv/holyarrs/config:/config
    - /srv/holyarrs/holyarrs-secrets.yaml:/run/secrets/holyarrs.yaml:ro
  5. Sadaļā Settings > API > API keys izveido īpašnieka API atslēgu ar darbības jomu admin. Ieliec to faila blokā holyarrs ar adresi http://127.0.0.1:6262.

  6. Veic izmēģinājuma palaišanu. Tā neko nemaina:

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

    Tev vajadzētu redzēt vienu rindu would set katram vienumam.

  7. Palaid to pa īstam (tā pati komanda bez -dry-run). Tev vajadzētu redzēt rindas set un izejas kodu 0.

  8. Pārbaudi jaunos avotus un lejupielādētājus, tad atsāc tos. Pārbaudi jaunos multivides serverus un paziņojumus, tad ieslēdz tos.

  9. Izdzēs failu resursdatorā (skaties Izdzēs failu). Izdzēs arī API atslēgu, ja tā vairs nav vajadzīga.

Par ko kļūst katrs bloks

Saite uz Par ko kļūst katrs bloks
Failā Kļūst par
trakt.client_id Trakt lietotnes atslēga (Settings > Outside lists, iestatījumi > ārējie saraksti).
tmdb, tvdb Pieņem no senākiem failiem. Metadatiem atslēgas nav vajadzīgas.
opensubtitles, subdl Subtitru vietne ar tavu kontu.
addic7ed Addic7ed subtitru vietne, tikai seriāliem.
indexers Viens avots katram ierakstam, paused (apturēts).
jackett, prowlarr Tās atslēga aizpilda katru indexers ierakstu ar to pašu adresi, kuram nav atslēgas.
qbittorrent, sabnzbd Lejupielādētājs, paused.
nzbget, transmission, deluge Izlaisti. Imports tos vēl nevar iestatīt; pievieno tos sadaļā Settings > Downloaders.
jellyfin, emby, plex Multivides serveris, off (izslēgts), kamēr tu to nepārbaudi.
smtp, discord, webhook Paziņojumi „Email”, „Discord” un „Webhook”, off, kamēr tu tos nepārbaudi.
radarr, sonarr, lidarr, prowlarr, bazarr, seerr Atslēga, kas saglabāta sadaļai Import from other apps (importēt no citām lietotnēm).
holyarrs Izmanto tikai, lai sasniegtu HolyArrs, kamēr tas darbojas. Nekad netiek saglabāts.

Katra atslēga nonāk šifrētajā glabātuvē, tāpat kā atslēga, ko ieraksti iestatījumos.

Vietējā tīkla slēdzis

Saite uz Vietējā tīkla slēdzis

Katrs bloks ar adresi var saņemt allow_local_network: true. Tas ļauj šim vienumam sasniegt šo datoru vai tavu mājas tīklu (192.168.x.x, 10.x.x.x, konteinera nosaukums). Bez tā vienums sasniedz tikai internetu, tāpēc mājās esošs lejupielādētājs neatbildēs. HolyArrs to nekad nenospriež pēc adreses. Tas ir tas pats slēdzis kā May reach the local network (drīkst sasniegt vietējo tīklu) iestatījumos.

Kad HolyArrs ir apturēts

Saite uz Kad HolyArrs ir apturēts

Palaid vienreizēju konteineru ar to pašu konfigurāciju. Tas saglabā tieši konfigurācijas mapē un tam nav vajadzīgs bloks holyarrs:

Terminal window
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

Izmanto tos pašus PUID un PGID kā lietotne, citādi konfigurācijas mape tiek nodota 1000:1000. PUID lietotājam jāspēj nolasīt fails. Ja tu izmanto HOLYARRS_MASTER_KEY_FILE, dod vienreizējam konteineram to pašu mainīgo un montējumu.

Palaišana vēlreiz

Saite uz Palaišana vēlreiz

Palaist vēlreiz ir droši. Atbilstošie vienumi saka unchanged; tiek saglabāti tikai mainītie.

Vienums Atbilstību nosaka pēc
Avoti nosaukuma
Lejupielādētāji, multivides serveri veida un adreses
Paziņojumi nosaukuma un veida
Subtitru vietnes, iepriekšējās lietotnes veida

Avots vai lejupielādētājs, kuram mainījās adrese vai atslēga, tiek apturēts vēlreiz. Kad tu kādu atsāc pats, atkārtota palaišana to atstāj darbojamies. Tukša api_key ierakstā indexers patur saglabāto atslēgu; pievieno clear_key: true, lai to noņemtu.

Ar -delete komanda pārraksta failu ar nullēm un noņem to, tikai pēc palaišanas, kurā nekas neizgāzās. Tikai lasāmu montējumu nevar izdzēst no konteinera iekšpuses, tāpēc izdzēs to resursdatorā:

Sistēma Komanda
Linux shred -u holyarrs-secrets.yaml
macOS rm -P holyarrs-secrets.yaml
Windows Remove-Item holyarrs-secrets.yaml, tad iztukšo atkritni.

SSD un failu sistēmās ar copy-on-write vecie bloki var palikt diskā. Pašas atslēgas tagad atrodas šifrētajā glabātuvē.

Simptoms Cēlonis Risinājums
Failu var lasīt citi lietotāji Atļaujas ir pārāk vaļīgas. Izpildi chmod 600. Operētājsistēmā Windows glabā to mapē, ko vari atvērt tikai tu.
Nezināma atslēga apturēja importu Drukas kļūda vai tabulācija norādītajā rindā. Izlabo šo rindu. Nekas netika saglabāts.
Vienkāršs http atteikts Adrese holyarrs nav šajā datorā. Izpildi konteinera iekšpusē ar http://127.0.0.1:6262 vai izmanto https.
Mājās esošs lejupielādētājs neatbild Nav vietējā tīkla atļaujas. Šajā blokā iestati allow_local_network: true.
Vienreizējais konteiners nomainīja mapju īpašniekus Citi PUID/PGID. Izmanto lietotnes PUID un PGID.
-delete neko nedarīja Kaut kas neizdevās vai montējums ir tikai lasāms. Izdzēs to resursdatorā.
Parametri un izejas kodi
Parametrs Ko dara Pēc noklusējuma
-file <path> Noslēpumu fails. nav
-dry-run Tikai pasaka, kas tiktu iestatīts. izslēgts
-config <folder> Konfigurācijas mape. /config
-delete Pēc palaišanas bez neveiksmēm pārraksta failu ar nullēm un izdzēš to. izslēgts
-forget-move-credentials Izdzēš katru saglabāto iepriekšējās lietotnes atslēgu, tad apstājas. izslēgts
-allow-http-lan Atļauj vienkāršu http:// uz mājas tīkla adresi. Izdrukā brīdinājumu. izslēgts
-allow-readable-file Pieņem failu, ko var lasīt citi lietotāji. Docker Desktop operētājsistēmā Windows rāda katru failu kā lasāmu. izslēgts

Adresei holyarrs jābūt https:// vai vienkāršam http:// tikai uz šo datoru (127.0.0.1, ::1, localhost). Pa vienkāršu http tava īpašnieka atslēga un viss fails ceļo nešifrēti.

Izejas kods Nozīme
0 Katrs vienums izdevās.
1 Kāds vienums neizdevās. Izlabo failu un palaid vēlreiz.
2 Slikta komandrinda vai fails.
Izvade

Viena rinda katram vienumam: set (vai would set izmēģinājuma palaišanā, dažreiz ar piezīmi), unchanged, skipped (empty), skipped (why) vai failed: why. Tā nekad neizdrukā atslēgu, paroli, token vai adresi. Sadaļā History parādās viens notikums tikai ar skaitiem. Kļūda, kas parādītu vērtību no tava faila, tās vietā rāda [hidden].

Faila formāts

Maza, stingra YAML daļa:

  • bloki pēc atkāpēm ar atstarpēm, nekad ar tabulācijām; saraksti ar - ,
  • vērtības vienkāršas, "double quotes" vai 'single quotes' (vienpēdiņās ' raksti divreiz),
  • # sāk komentāru rindas sākumā vai pēc atstarpes ārpus pēdiņām, tāpēc pēdiņās ieliec paroli, kas satur #,
  • pēdiņās ieliec vērtību, kas sākas ar &, *, !, |, >, [, {, %, @ vai atpakaļvērsto apostrofu, vai kas satur : .

Nezināma atslēga vai fails virs 256 KB aptur visu importu, pirms kaut kas tiek saglabāts; ziņojums nosauc atslēgu un rindu. Saite uz failu tiek atteikta.

Īpašie lauki
Lauks Noteikums
SABnzbd Vajadzīga pilna api_key. nzb_key, lietotājvārds vai parole tiek izlaisti un nekad netiek glabāti.
tvdb.api_key, tvdb.unique_user_key, trakt.redirect_urls Pieņem un izlaiž.
smtp.host Tikai servera nosaukums, bez shēmas vai porta.
smtp.port No 1 līdz 65535. Pēc noklusējuma 587.
smtp.from Viena vienkārša e-pasta adrese.
Iepriekšējo lietotņu bloki Izmanto sadaļā Import from other apps ar Use the saved key (izmantot saglabāto atslēgu). Nekad netiek rādīti, tikai īpašniekam, izdzēsti pēc vienas sekmīgas nolasīšanas.

HolyArrs ir bezmaksas. Ja tas ietaupīja tavu laiku, atzīmē to ar zvaigznīti GitHub, atbalsti to vai uzcienā mani ar kafiju.