Увоз кључева из фајла

Попуни један фајл својим изворима, преузимачима, медија серверима, сајтовима за титлове и поштом, увези га и немој да куцаш сваки кључ у подешавањима.

Пре него што почнеш

• HolyArrs ради у Docker-у, а његова конфигурација је у /config.
• Можеш да направиш API кључ власника у Settings > API > API keys (подешавања > API > API кључеви).

Увези фајл

1. Копирај holyarrs-secrets.template.yaml у holyarrs-secrets.yaml.

2. Попуни оно што користиш. Остало остави празно; празно значи прескочи.

3. Подеси да га можеш читати само ти:

   chmod 600 holyarrs-secrets.yaml

4. Монтирај га у контејнер само за читање:

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

5. Направи API кључ власника са опсегом admin у Settings > API > API keys. Стави га у блок holyarrs у фајлу са адресом http://127.0.0.1:6262.

6. Прво покрени пробно извршавање. Не мења ништа:

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

   Требало би да видиш по једну линију would set за сваку ставку.

7. Покрени стварно (иста команда без -dry-run). Требало би да видиш линије set и излазни код 0.

8. Провери нове изворе и преузимаче, па их настави. Тестирај нове медија сервере и обавештења, па их укључи.

9. Обриши фајл на хосту (погледај Обриши фајл). Обриши и API кључ ако ти више не треба.

Caution

Фајл држи сваку тајну као обичан текст док га не обришеш. Обриши га на хосту чим извршавање успе.

Шта сваки блок постаје

У фајлу	Постаје
trakt.client_id	Кључ Trakt апликације (Settings > Outside lists, подешавања > спољне листе).
tmdb, tvdb	Прихватају се из старијих фајлова. Метаподаци не траже кључеве.
opensubtitles, subdl	Сајт за титлове са твојим налогом.
addic7ed	Addic7ed сајт за титлове, само серије.
indexers	По један извор за сваки унос, paused (паузиран).
jackett, prowlarr	Њихов кључ попуњава сваки унос у indexers на истој адреси који нема кључ.
qbittorrent, sabnzbd	Преузимач, paused.
nzbget, transmission, deluge	Прескачу се. Увоз још не може да их подеси; додај их у Settings > Downloaders.
jellyfin, emby, plex	Медија сервер, off (искључен) док га не тестираш.
smtp, discord, webhook	Обавештења „Email“, „Discord“ и „Webhook“, off док их не тестираш.
radarr, sonarr, lidarr, prowlarr, bazarr, seerr	Кључ сачуван за Import from other apps (увоз из других апликација).
holyarrs	Користи се само за приступ HolyArrs док ради. Никад се не чува.

Сваки кључ иде у шифровани сеф, исто као онај који унесеш у подешавањима.

Опције

Прекидач локалне мреже

Сваки блок са адресом може да добије allow_local_network: true. То му дозвољава да приступи овом рачунару или твојој кућној мрежи (192.168.x.x, 10.x.x.x, име контејнера). Без тога ставка стиже само до интернета, па преузимач код куће неће одговарати. HolyArrs то никад не погађа из адресе. То је исти прекидач као May reach the local network (сме да приступи локалној мрежи) у подешавањима.

Док је HolyArrs заустављен

Покрени једнократни контејнер на истој конфигурацији. Чува директно у конфигурациони фолдер и не треба му блок 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

Користи исте PUID и PGID као апликација, иначе се конфигурациони фолдер предаје власнику 1000:1000. Корисник PUID мора да може да чита фајл. Ако користиш HOLYARRS_MASTER_KEY_FILE, дај једнократном контејнеру исту променљиву и монтирање.

Поновно покретање

Поновно покретање је безбедно. Ставке које се поклапају кажу unchanged; чувају се само измењене.

Ставка	Поклапа се по
Извори	имену
Преузимачи, медија сервери	врсти и адреси
Обавештења	имену и врсти
Сајтови за титлове, претходне апликације	врсти

Извор или преузимач чија се адреса или кључ променио поново се паузира. Када га једном сам наставиш, поновно покретање га оставља да ради. Празан api_key на уносу indexers задржава сачувани кључ; додај clear_key: true да га уклониш.

Обриши фајл

Са -delete, команда пребрише фајл нулама и уклони га, и то само после покретања у ком ништа није пало. Монтирање само за читање не може да се обрише изнутра контејнера, па га обриши на хосту:

Систем	Команда
Linux	shred -u holyarrs-secrets.yaml
macOS	rm -P holyarrs-secrets.yaml
Windows	Remove-Item holyarrs-secrets.yaml, па испразни корпу за смеће.

На SSD-овима и фајл системима са copy-on-write, стари блокови могу да остану на диску. Сами кључеви сада живе у шифрованом сефу.

Ако не ради

Симптом	Узрок	Решење
Фајл могу да читају други корисници	Дозволе су превише отворене.	Изврши chmod 600. На Windows-у држи га у фолдеру који можеш да отвориш само ти.
Непознат кључ је зауставио увоз	Грешка у куцању или табулатор у наведеној линији.	Исправи ту линију. Ништа није сачувано.
Обичан http је одбијен	Адреса holyarrs није на овом рачунару.	Покрени унутар контејнера са http://127.0.0.1:6262, или користи https.
Преузимач код куће не одговара	Нема дозволе за локалну мрежу.	Постави allow_local_network: true на том блоку.
Једнократни контејнер је променио власнике фолдера	Различити PUID/PGID.	Користи PUID и PGID апликације.
-delete није урадио ништа	Нешто је пало, или је монтирање само за читање.	Обриши га на хосту.

За напредне

Заставице и излазни кодови

Заставица	Шта ради	Подразумевано
-file <path>	Фајл са тајнама.	нема
-dry-run	Само каже шта би било подешено.	искључено
-config <folder>	Конфигурациони фолдер.	/config
-delete	После покретања без грешака пребрише фајл нулама и обрише га.	искључено
-forget-move-credentials	Брише сваки сачуван кључ претходне апликације, па стаје.	искључено
-allow-http-lan	Дозвољава обичан http:// ка адреси у кућној мрежи. Исписује упозорење.	искључено
-allow-readable-file	Прихвата фајл који могу да читају други корисници. Docker Desktop на Windows-у приказује сваки фајл као читљив.	искључено

Адреса holyarrs мора бити https://, или обичан http:// само ка овом рачунару (127.0.0.1, ::1, localhost). Преко обичног http-а твој кључ власника и цео фајл путују нешифровани.

Излазни код	Значење
0	Свака ставка је прошла добро.
1	Нека ставка је пала. Исправи фајл и покрени поново.
2	Лоша командна линија или фајл.

Излаз

Једна линија по ставци: set (или would set у пробном извршавању, понекад са напоменом), unchanged, skipped (empty), skipped (why) или failed: why. Никад не исписује кључ, лозинку, токен ни адресу. Историја добија један догађај само са бројевима. Грешка која би показала вредност из твог фајла уместо тога показује [hidden].

Формат фајла

Мали, строги део YAML-а:

• блокови по увлачењу размацима, никад таб; листе са - ,
• вредности без наводника, у "double quotes" или 'single quotes' (' унутар једноструких пиши двапут),
• # почиње коментар на почетку линије или после размака ван наводника, па стави у наводнике лозинку која садржи #,
• стави у наводнике вредност која почиње са &, *, !, |, >, [, {, %, @ или обрнутим апострофом, или која садржи : .

Непознат кључ или фајл већи од 256 KB зауставља цео увоз пре него што се било шта сачува; порука наводи кључ и линију. Линк на фајл се одбија.

Посебна поља

Поље	Правило
SABnzbd	Треба му цео api_key. nzb_key, корисничко име или лозинка се прескачу и никад не чувају.
tvdb.api_key, tvdb.unique_user_key, trakt.redirect_urls	Прихватају се и прескачу.
smtp.host	Само име сервера, без шеме и порта.
smtp.port	1 до 65535. Подразумевано 587.
smtp.from	Једна обична имејл адреса.
Блокови претходних апликација	Користе се у Import from other apps са Use the saved key (користи сачуван кључ). Никад се не приказују, само за власника, бришу се после једног успешног читања.

Повезане странице

• Прочитај своје претходне апликације
• Променљиве окружења