Импортиране на ключове от файл

Попълни един файл с твоите Източници, програми за изтегляне, медийни сървъри, сайтове за субтитри и поща, импортирай го и не въвеждай всеки ключ в Settings.

Преди да започнеш

• 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. Изтрий файла на host-а (виж Изтрий файла). Изтрий и API ключа, ако вече не ти трябва.

Caution

Файлът държи всяка тайна като обикновен текст, докато не го изтриеш. Изтрий го на host-а веднага щом изпълнението успее.

В какво се превръща всеки блок

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

Всеки ключ отива в криптирания трезор, както и ключ, въведен в Settings.

Възможности

Превключвателят за локалната мрежа

Всеки блок с адрес може да приеме allow_local_network: true. Той позволява на този елемент да стигне до този компютър или до домашната ти мрежа (192.168.x.x, 10.x.x.x, име на контейнер). Без него елементът стига само до интернет, така че програма за изтегляне вкъщи няма да отговори. HolyArrs никога не го отгатва от адреса. Това е същият превключвател като May reach the local network (може да стига до локалната мрежа) в Settings.

При спрян 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 командата презаписва файла с нули и го премахва, само след изпълнение, в което нищо не е пропаднало. Монтиране само за четене не може да се изтрие отвътре на контейнера, затова го изтрий на host-а:

Система	Команда
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 не направи нищо	Нещо е пропаднало или монтирането е само за четене.	Изтрий го на host-а.

За експерти

Флагове и изходни кодове

Флаг	Какво прави	По подразбиране
-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 (ползвай запазения ключ). Никога не се показват, само за собственик, изтриват се след едно успешно четене.

Свързано

• Прочети по-старите си приложения
• Променливи на средата