Flytja inn lykla úr skrá

Fylltu út eina skrá með uppsprettum, niðurhalsforritum, margmiðlunarþjónum, textasíðum og tölvupósti, fluttu hana inn og sparaðu þér að slá inn hvern lykil í stillingum.

Áður en þú byrjar

• HolyArrs keyrir í Docker með stillingar í /config.
• Þú getur búið til API-lykil eiganda í Settings > API > API keys (stillingar > API > API-lyklar).

Flytja inn skrána

1. Afritaðu holyarrs-secrets.template.yaml í holyarrs-secrets.yaml.

2. Fylltu inn það sem þú notar. Skildu restina eftir tóma; tómt þýðir sleppa.

3. Gerðu hana læsilega aðeins fyrir þig:

   chmod 600 holyarrs-secrets.yaml

4. Tengdu hana skrifvarða inn í container:

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

5. Búðu til API-lykil eiganda með umfanginu admin í Settings > API > API keys. Settu hann í holyarrs-blokkina í skránni ásamt vistfanginu http://127.0.0.1:6262.

6. Prófaðu þurrkeyrslu. Hún breytir engu:

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

   Þú ættir að sjá eina would set-línu fyrir hvert atriði.

7. Keyrðu hana í alvöru (sama skipun án -dry-run). Þú ættir að sjá set-línur og skilakóðann 0.

8. Athugaðu nýjar uppsprettur og niðurhalsforrit og haltu svo áfram með þau. Prófaðu nýja margmiðlunarþjóna og tilkynningar og kveiktu svo á þeim.

9. Eyddu skránni á host-tölvunni (sjá Eyða skránni). Eyddu líka API-lyklinum ef þú þarft hann ekki lengur.

Caution

Skráin geymir alla lykla og lykilorð sem læsilegan texta þar til þú eyðir henni. Eyddu henni á host-tölvunni um leið og keyrslan tekst.

Í hvað hver blokk verður

Í skránni	Verður að
trakt.client_id	Trakt-forritslykillinn (Settings > Outside lists (stillingar > ytri listar)).
tmdb, tvdb	Tekið við úr eldri skrám. Lýsigögn þurfa enga lykla.
opensubtitles, subdl	Textasíða með þínum reikningi.
addic7ed	Addic7ed-textasíða, aðeins fyrir þætti.
indexers	Ein uppspretta fyrir hverja færslu, í bið.
jackett, prowlarr	Lykill þeirra fyllir út hverja indexers-færslu á sama vistfangi sem hefur engan lykil.
qbittorrent, sabnzbd	Niðurhalsforrit, í bið.
nzbget, transmission, deluge	Sleppt. Innflutningurinn getur ekki sett þetta upp enn; bættu þeim við í Settings > Downloaders (stillingar > niðurhalsforrit).
jellyfin, emby, plex	Margmiðlunarþjónn, slökkt þar til þú prófar hann.
smtp, discord, webhook	Tilkynningarnar „Email“, „Discord“ og „Webhook“, slökkt þar til þú prófar þær.
radarr, sonarr, lidarr, prowlarr, bazarr, seerr	Lykill vistaður fyrir Import from other apps (flytja inn úr öðrum forritum).
holyarrs	Aðeins notað til að ná til HolyArrs meðan það keyrir. Aldrei vistað.

Hver lykill fer í dulkóðuðu hvelfinguna, alveg eins og lykill sem er sleginn inn í stillingum.

Valkostir

Rofinn fyrir staðarnetið

Hver blokk með vistfangi getur tekið allow_local_network: true. Hann leyfir því atriði að ná til þessarar tölvu eða heimanetsins þíns (192.168.x.x, 10.x.x.x, nafn á container). Án hans nær atriðið aðeins til internetsins, svo niðurhalsforrit heima svarar ekki. HolyArrs giskar aldrei á þetta út frá vistfanginu. Þetta er sami rofi og May reach the local network (má ná til staðarnetsins) í stillingum.

Með HolyArrs stöðvað

Keyrðu stakan container á sömu stillingum. Hann vistar beint í stillingamöppuna og þarf enga holyarrs-blokk:

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

Notaðu sömu PUID og PGID og forritið, annars er stillingamappan afhent 1000:1000. Notandinn PUID verður að geta lesið skrána. Ef þú notar HOLYARRS_MASTER_KEY_FILE, gefðu stöku container sömu breytu og tengingu.

Keyra aftur

Það er öruggt að keyra aftur. Atriði sem passa segja unchanged; aðeins breytt atriði eru vistuð.

Atriði	Parað eftir
Uppsprettur	nafni
Niðurhalsforrit, margmiðlunarþjónar	tegund og vistfangi
Tilkynningar	nafni og tegund
Textasíður, eldri forrit	tegund

Uppspretta eða niðurhalsforrit þar sem vistfang eða lykill breyttist fer aftur í bið. Þegar þú hefur haldið áfram með það handvirkt lætur ný keyrsla það í friði. Tómur api_key á indexers-færslu heldur vistaða lyklinum; bættu við clear_key: true til að fjarlægja hann.

Eyða skránni

Með -delete yfirskrifar skipunin skrána með núllum og fjarlægir hana, aðeins eftir keyrslu þar sem ekkert mistókst. Ekki er hægt að eyða skrifvarinni tengingu innan úr container-num, svo eyddu henni á host-tölvunni:

Kerfi	Skipun
Linux	shred -u holyarrs-secrets.yaml
macOS	rm -P holyarrs-secrets.yaml
Windows	Remove-Item holyarrs-secrets.yaml, tæmdu svo ruslafötuna.

Á SSD-diskum og skráakerfum með copy-on-write geta gamlir blokkir orðið eftir á disknum. Lyklarnir sjálfir eru nú í dulkóðuðu hvelfingunni.

Ef það virkar ekki

Einkenni	Orsök	Lausn
Aðrir notendur geta lesið skrána	Heimildir of opnar.	Keyrðu chmod 600. Á Windows, hafðu hana í möppu sem aðeins þú getur opnað.
Óþekktur lykill stöðvaði innflutninginn	Innsláttarvilla eða tab í línunni sem nefnd er.	Lagaðu þá línu. Ekkert var vistað.
Venjulegu http var hafnað	holyarrs-vistfangið er ekki á þessari tölvu.	Keyrðu inni í container-num með http://127.0.0.1:6262, eða notaðu https.
Niðurhalsforrit heima svarar ekki	Engin heimild fyrir staðarnetið.	Stilltu allow_local_network: true á þeirri blokk.
Stakur container breytti eigendum mappa	Önnur PUID/PGID.	Notaðu PUID og PGID forritsins.
-delete gerði ekkert	Eitthvað mistókst, eða tengingin er skrifvarin.	Eyddu henni á host-tölvunni.

Fyrir sérfræðinga

Rofar og skilakóðar

Rofi	Hvað hann gerir	Sjálfgefið
-file <path>	Leyniskráin.	engin
-dry-run	Segir aðeins hvað yrði stillt.	slökkt
-config <folder>	Stillingamappan.	/config
-delete	Eftir keyrslu án mistaka, yfirskrifar skrána með núllum og eyðir henni.	slökkt
-forget-move-credentials	Eyðir öllum vistuðum lyklum eldri forrita og stöðvar svo.	slökkt
-allow-http-lan	Leyfir venjulegt http:// á vistfang á heimaneti. Prentar viðvörun.	slökkt
-allow-readable-file	Tekur við skrá sem aðrir notendur mega lesa. Docker Desktop á Windows sýnir allar skrár sem læsilegar.	slökkt

holyarrs-vistfangið verður að vera https://, eða venjulegt http:// aðeins á þessa tölvu (127.0.0.1, ::1, localhost). Yfir venjulegu http ferðast eigandalykillinn þinn og öll skráin ódulkóðuð.

Skilakóði	Merking
0	Öll atriði gengu vel.
1	Atriði mistókst. Lagaðu skrána og keyrðu aftur.
2	Röng skipanalína eða skrá.

Úttak

Ein lína fyrir hvert atriði: set (eða would set í þurrkeyrslu, stundum með athugasemd), unchanged, skipped (empty), skipped (why) eða failed: why. Það prentar aldrei lykil, lykilorð, token eða vistfang. Sagan fær einn atburð með tölum einum saman. Villa sem myndi sýna gildi úr skránni þinni sýnir [hidden] í staðinn.

Skráarsnið

Lítill og strangur hluti af YAML:

• blokkir með inndrætti úr bilum, aldrei tab; listar með - ,
• gildi án gæsalappa, í "double quotes" eða 'single quotes' (skrifaðu ' innan í single quotes tvisvar),
• # hefst athugasemd í upphafi línu eða eftir bil utan gæsalappa, svo settu lykilorð sem inniheldur # í gæsalappir,
• settu í gæsalappir gildi sem byrjar á &, *, !, |, >, [, {, %, @ eða öfugu úrfellingarmerki, eða inniheldur : .

Óþekktur lykill eða skrá yfir 256 KB stöðvar allan innflutninginn áður en nokkuð er vistað; skilaboðin nefna lykilinn og línuna. Tengli á skrána er hafnað.

Sérstakir reitir

Reitur	Regla
SABnzbd	Þarf allan api_key. nzb_key, notandanafni eða lykilorði er sleppt og það aldrei vistað.
tvdb.api_key, tvdb.unique_user_key, trakt.redirect_urls	Tekið við og sleppt.
smtp.host	Aðeins heiti server, ekkert scheme eða port.
smtp.port	1 til 65535. Sjálfgefið 587.
smtp.from	Eitt venjulegt tölvupóstfang.
Blokkir eldri forrita	Notaðar í Import from other apps með Use the saved key (nota vistaða lykilinn). Aldrei sýndar, aðeins eigandi, eytt eftir einn vel heppnaðan lestur.

Tengt efni

• Lestur á eldri forritum þínum
• Umhverfisbreytur