Tuo avaimet tiedostosta

Käyttöönotto

Täytä yksi tiedosto lähteistäsi, latausohjelmistasi, mediapalvelimistasi, tekstitysten sivustoistasi ja sähköpostistasi, tuo se ja jätä jokaisen avaimen kirjoittaminen asetuksiin väliin.

Ennen kuin aloitat

HolyArrs toimii Dockerissa ja sen asetukset ovat kansiossa /config.
Voit luoda omistajan API-avaimen kohdassa Settings > API > API keys (asetukset > API > API-avaimet).

Tuo tiedosto

Kopioi holyarrs-secrets.template.yaml tiedostoksi holyarrs-secrets.yaml.
Täytä se, mitä käytät. Jätä loput tyhjiksi; tyhjä tarkoittaa ohitusta.
Tee siitä vain sinun luettavissasi:
Terminal window
```
chmod 600 holyarrs-secrets.yaml
```

Liitä se containeriin vain luku -tilassa:

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

Luo omistajan API-avain admin-oikeudella kohdassa Settings > API > API keys. Laita se tiedoston holyarrs-lohkoon osoitteen http://127.0.0.1:6262 kanssa.
Kokeile kuivaharjoitusta. Se ei muuta mitään:
Terminal window
```
docker exec holyarrs /holyarrs import-secrets -file /run/secrets/holyarrs.yaml -dry-run
```
Näet yhden would set -rivin jokaisesta kohdasta.
Suorita se oikeasti (sama komento ilman -dry-run). Näet set-rivejä ja poistumiskoodin 0.
Tarkista uudet lähteet ja latausohjelmat ja jatka ne sitten. Testaa uudet mediapalvelimet ja ilmoitukset ja ota ne sitten käyttöön.
Poista tiedosto isännältä (katso Poista tiedosto). Poista myös API-avain, jos et enää tarvitse sitä.

Mitä kustakin lohkosta tulee

Tiedostossa	Muuttuu
`trakt.client_id`	Traktin sovellusavain (Settings > Outside lists, asetukset > ulkoiset listat).
`tmdb`, `tvdb`	Hyväksytään vanhoista tiedostoista. Metadata ei tarvitse avaimia.
`opensubtitles`, `subdl`	Tekstitysten sivusto tilisi kanssa.
`addic7ed`	Addic7ed-tekstitysten sivusto, vain sarjoille.
`indexers`	Yksi lähde kohdetta kohden, paused (tauolla).
`jackett`, `prowlarr`	Niiden avain täyttää jokaisen `indexers`-kohdan, jolla on sama osoite eikä avainta.
`qbittorrent`, `sabnzbd`	Latausohjelma, paused.
`nzbget`, `transmission`, `deluge`	Ohitetaan. Tuonti ei vielä osaa määrittää näitä; lisää ne kohdassa Settings > Downloaders (asetukset > latausohjelmat).
`jellyfin`, `emby`, `plex`	Mediapalvelin, off (pois), kunnes testaat sen.
`smtp`, `discord`, `webhook`	Ilmoitukset ”Email”, ”Discord” ja ”Webhook”, off, kunnes testaat ne.
`radarr`, `sonarr`, `lidarr`, `prowlarr`, `bazarr`, `seerr`	Avain tallennetaan toimintoa Import from other apps (tuonti muista sovelluksista) varten.
`holyarrs`	Käytetään vain HolyArrsin tavoittamiseen sen toimiessa. Ei koskaan tallenneta.

Jokainen avain menee salattuun holviin, samoin kuin asetuksiin kirjoitettu.

Vaihtoehdot

Paikallisen verkon kytkin

Jokainen osoitteellinen lohko voi sisältää allow_local_network: true. Se sallii kyseisen kohdan tavoittaa tämän koneen tai kotiverkkosi (192.168.x.x, 10.x.x.x, containerin nimi). Ilman sitä kohta tavoittaa vain internetin, joten kotona oleva latausohjelma ei vastaa. HolyArrs ei koskaan arvaa tätä osoitteesta. Se on sama kytkin kuin May reach the local network (saa tavoittaa paikallisen verkon) asetuksissa.

HolyArrsin ollessa pysäytettynä

Suorita kertakäyttöinen container samoilla asetuksilla. Se tallentaa suoraan asetuskansioon eikä tarvitse holyarrs-lohkoa:

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

Käytä samoja PUID- ja PGID-arvoja kuin sovellus, tai asetuskansio siirtyy omistajalle 1000:1000. PUID-käyttäjän täytyy pystyä lukemaan tiedosto. Jos käytät HOLYARRS_MASTER_KEY_FILE-muuttujaa, anna kertakäyttöiselle containerille sama muuttuja ja liitos.

Ajo uudelleen

Uudelleenajo on turvallista. Täsmäävät kohdat sanovat unchanged; vain muuttuneet kohdat tallennetaan.

Kohde	Täsmäytetään
Lähteet	nimellä
Latausohjelmat, mediapalvelimet	tyypillä ja osoitteella
Ilmoitukset	nimellä ja tyypillä
Tekstitysten sivustot, aiemmat sovellukset	tyypillä

Lähde tai latausohjelma, jonka osoite tai avain muuttui, laitetaan taas tauolle. Kun olet itse jatkanut sen, uudelleenajo jättää sen käyntiin. Tyhjä api_key indexers-kohdassa säilyttää tallennetun avaimen; lisää clear_key: true poistaaksesi sen.

Poista tiedosto

Valinnalla -delete komento ylikirjoittaa tiedoston nollilla ja poistaa sen, vain ajon jälkeen, jossa mikään ei epäonnistunut. Vain luku -liitosta ei voi poistaa containerin sisältä, joten poista se isännältä:

Järjestelmä	Komento
Linux	`shred -u holyarrs-secrets.yaml`
macOS	`rm -P holyarrs-secrets.yaml`
Windows	`Remove-Item holyarrs-secrets.yaml`, tyhjennä sitten roskakori.

SSD-levyillä ja copy-on-write-tiedostojärjestelmissä vanhat lohkot voivat jäädä levylle. Itse avaimet ovat nyt salatussa holvissa.

Jos se ei toimi

Oire	Syy	Ratkaisu
Tiedosto on muiden käyttäjien luettavissa	Oikeudet ovat liian väljät.	Suorita `chmod 600`. Windowsissa pidä se kansiossa, jonka vain sinä voit avata.
Tuntematon avain pysäytti tuonnin	Kirjoitusvirhe tai tabulaattori nimetyllä rivillä.	Korjaa kyseinen rivi. Mitään ei tallennettu.
Pelkkä http hylättiin	`holyarrs`-osoite ei ole tällä koneella.	Suorita containerin sisällä osoitteella `http://127.0.0.1:6262` tai käytä https:ää.
Kotona oleva latausohjelma ei vastaa	Ei oikeutta paikalliseen verkkoon.	Aseta kyseiseen lohkoon `allow_local_network: true`.
Kertakäyttöinen container muutti kansioiden omistajat	Eri `PUID`/`PGID`.	Käytä sovelluksen `PUID`- ja `PGID`-arvoja.
`-delete` ei tehnyt mitään	Jokin epäonnistui tai liitos on vain luku.	Poista se isännältä.

Asiantuntijoille

Liput ja poistumiskoodit

Lippu	Mitä se tekee	Oletus
`-file <path>`	Salaisuustiedosto.	ei mitään
`-dry-run`	Kertoo vain, mitä asetettaisiin.	pois
`-config <folder>`	Asetuskansio.	`/config`
`-delete`	Ajon jälkeen, jossa ei ole virheitä, ylikirjoittaa tiedoston nollilla ja poistaa sen.	pois
`-forget-move-credentials`	Poistaa jokaisen tallennetun aiemman sovelluksen avaimen ja pysähtyy sitten.	pois
`-allow-http-lan`	Sallii pelkän `http://`-yhteyden kotiverkon osoitteeseen. Tulostaa varoituksen.	pois
`-allow-readable-file`	Hyväksyy tiedoston, jonka muut käyttäjät voivat lukea. Docker Desktop Windowsissa näyttää jokaisen tiedoston luettavana.	pois

holyarrs-osoitteen täytyy olla https:// tai pelkkä http:// vain tälle koneelle (127.0.0.1, ::1, localhost). Pelkän http:n yli omistajan avain ja koko tiedosto kulkevat salaamattomina.

Poistumiskoodi	Merkitys
`0`	Jokainen kohta onnistui.
`1`	Jokin kohta epäonnistui. Korjaa tiedosto ja suorita uudelleen.
`2`	Virheellinen komentorivi tai tiedosto.

Tuloste

Yksi rivi kohdetta kohden: set (tai would set kuivaharjoituksessa, joskus huomautuksen kanssa), unchanged, skipped (empty), skipped (why) tai failed: why. Se ei koskaan tulosta avainta, salasanaa, tokenia tai osoitetta. Historiaan tulee yksi tapahtuma, jossa on vain määrät. Virhe, joka näyttäisi arvon tiedostostasi, näyttää sen sijaan [hidden].

Tiedostomuoto

Pieni, tiukka osa YAMLia:

lohkot sisennyksellä välilyönneillä, ei koskaan tabulaattoreilla; listat - -merkillä,
arvot sellaisenaan, "double quotes" (kaksoislainausmerkit) tai 'single quotes' (yksittäiset lainausmerkit) (kirjoita ' yksittäisten lainausmerkkien sisällä kahdesti),
# aloittaa kommentin rivin alussa tai välilyönnin jälkeen lainausmerkkien ulkopuolella, joten laita lainausmerkkeihin salasana, jossa on #,
laita lainausmerkkeihin arvo, joka alkaa merkillä &, *, !, |, >, [, {, %, @ tai gravis, tai jossa on : .

Tuntematon avain tai yli 256 kt tiedosto pysäyttää koko tuonnin ennen kuin mitään tallennetaan; viesti nimeää avaimen ja rivin. Linkki tiedostoon hylätään.

Erikoiskentät

Kenttä	Sääntö
SABnzbd	Tarvitsee täyden `api_key`-arvon. `nzb_key`, käyttäjätunnus tai salasana ohitetaan eikä niitä koskaan tallenneta.
`tvdb.api_key`, `tvdb.unique_user_key`, `trakt.redirect_urls`	Hyväksytään ja ohitetaan.
`smtp.host`	Vain palvelimen nimi, ei skeemaa eikä porttia.
`smtp.port`	1–65535. Oletus `587`.
`smtp.from`	Yksi tavallinen sähköpostiosoite.
Aiempien sovellusten lohkot	Käytetään toiminnossa Import from other apps valinnalla Use the saved key (käytä tallennettua avainta). Ei koskaan näytetä, vain omistajalle, poistetaan yhden onnistuneen luvun jälkeen.

Aiheesta lisää

HolyArrs on ilmainen. Jos se säästi aikaasi, anna sille tähti GitHubissa, tue sitä tai tarjoa minulle kahvit.