Import kluczy z pliku

Uzupełnij jeden plik swoimi źródłami, downloaderami, serwerami multimediów, serwisami z napisami i pocztą, zaimportuj go i nie wpisuj każdego klucza osobno w ustawieniach.

Zanim zaczniesz

• HolyArrs działa w Dockerze, a jego konfiguracja jest w /config.
• Możesz utworzyć klucz API właściciela w Settings > API > API keys (Ustawienia > API > Klucze API).

Zaimportuj plik

1. Skopiuj holyarrs-secrets.template.yaml do holyarrs-secrets.yaml.

2. Uzupełnij to, czego używasz. Resztę zostaw pustą; puste oznacza pominięcie.

3. Ogranicz dostęp do pliku tylko do siebie:

   chmod 600 holyarrs-secrets.yaml

4. Zamontuj go w kontenerze tylko do odczytu:

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

5. Utwórz klucz API właściciela z zakresem admin w Settings > API > API keys. Wpisz go w bloku holyarrs w pliku razem z adresem http://127.0.0.1:6262.

6. Zrób próbny przebieg. Niczego nie zmienia:

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

   Zobaczysz jedną linię would set dla każdej pozycji.

7. Wykonaj import naprawdę (to samo polecenie bez -dry-run). Zobaczysz linie set i kod wyjścia 0.

8. Sprawdź nowe źródła i downloadery, a potem je wznów. Przetestuj nowe serwery multimediów i Powiadomienia (Alerts), a potem je włącz.

9. Usuń plik na hoście (zobacz Usuń plik). Usuń też klucz API, jeśli już go nie potrzebujesz.

Uwaga

Plik trzyma wszystkie sekrety jawnym tekstem, dopóki go nie usuniesz. Usuń go na hoście zaraz po udanym imporcie.

Czym staje się każdy blok

W pliku	Staje się
trakt.client_id	Klucz aplikacji Trakt (Settings > Outside lists (Ustawienia > Listy zewnętrzne)).
tmdb, tvdb	Akceptowane ze starszych plików. Metadane nie wymagają kluczy.
opensubtitles, subdl	Serwis z napisami z twoim kontem.
addic7ed	Serwis z napisami Addic7ed, tylko seriale.
indexers	Jedno źródło na wpis, wstrzymane.
jackett, prowlarr	Ich klucz uzupełnia każdy wpis indexers z tym samym adresem, który nie ma klucza.
qbittorrent, sabnzbd	Downloader, wstrzymany.
nzbget, transmission, deluge	Pomijane. Import nie umie ich jeszcze skonfigurować; dodaj je w Settings > Downloaders.
jellyfin, emby, plex	Serwer multimediów, wyłączony, dopóki go nie przetestujesz.
smtp, discord, webhook	Powiadomienia „Email“, „Discord“ i „Webhook“, wyłączone, dopóki ich nie przetestujesz.
radarr, sonarr, lidarr, prowlarr, bazarr, seerr	Klucz zapisany dla Move from other apps (przejście z innych aplikacji).
holyarrs	Używane tylko do połączenia z HolyArrs, gdy działa. Nigdy nie jest zapisywane.

Każdy klucz trafia do zaszyfrowanego sejfu, tak samo jak wpisany w ustawieniach.

Opcje

Przełącznik sieci lokalnej

Każdy blok z adresem może mieć allow_local_network: true. Pozwala to danej pozycji łączyć się z tym komputerem lub z twoją siecią domową (192.168.x.x, 10.x.x.x, nazwa kontenera). Bez tego pozycja sięga tylko do internetu, więc downloader w domu nie odpowie. HolyArrs nigdy nie zgaduje tego z adresu. To ten sam przełącznik co May reach the local network (może łączyć się z siecią lokalną) w ustawieniach.

Przy zatrzymanym HolyArrs

Uruchom jednorazowy kontener na tej samej konfiguracji. Zapisuje wprost do folderu konfiguracji i nie potrzebuje bloku 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

Użyj tych samych PUID i PGID co aplikacja, bo inaczej folder konfiguracji zostanie przekazany użytkownikowi 1000:1000. Użytkownik PUID musi móc odczytać plik. Jeśli używasz HOLYARRS_MASTER_KEY_FILE, daj jednorazowemu kontenerowi tę samą zmienną i ten sam montaż.

Ponowne uruchomienie

Ponowne uruchomienie jest bezpieczne. Pasujące pozycje dostają unchanged; zapisywane są tylko zmienione.

Pozycja	Dopasowywana po
Źródła	nazwie
Downloadery, serwery multimediów	rodzaju i adresie
Powiadomienia	nazwie i rodzaju
Serwisy z napisami, dotychczasowe aplikacje	rodzaju

Źródło lub downloader, któremu zmienił się adres lub klucz, jest wstrzymywane ponownie. Gdy sam je wznowisz, kolejny import zostawi je uruchomione. Pusty api_key we wpisie indexers zachowuje zapisany klucz; dodaj clear_key: true, żeby go usunąć.

Usuń plik

Z opcją -delete polecenie nadpisuje plik zerami i usuwa go, tylko po przebiegu, w którym nic nie zawiodło. Z kontenera nie da się usunąć pliku zamontowanego tylko do odczytu, więc usuń go na hoście:

System	Polecenie
Linux	shred -u holyarrs-secrets.yaml
macOS	rm -P holyarrs-secrets.yaml
Windows	Remove-Item holyarrs-secrets.yaml, a potem opróżnij Kosz.

Na dyskach SSD i systemach plików typu copy-on-write stare bloki mogą zostać na dysku. Same klucze są teraz w zaszyfrowanym sejfie.

Jeśli to nie działa

Objaw	Przyczyna	Rozwiązanie
Plik może być czytany przez innych użytkowników	Uprawnienia są zbyt szerokie.	Wykonaj chmod 600. W Windows trzymaj go w folderze, który możesz otworzyć tylko ty.
Nieznany klucz zatrzymał import	Literówka albo tabulator w wymienionej linii.	Popraw tę linię. Nic nie zostało zapisane.
Zwykłe http odrzucone	Adres holyarrs nie wskazuje tego komputera.	Wykonaj polecenie wewnątrz kontenera z http://127.0.0.1:6262 albo użyj https.
Downloader w domu nie odpowiada	Brak zgody na sieć lokalną.	Ustaw allow_local_network: true w tym bloku.
Jednorazowy kontener zmienił właścicieli folderów	Inne PUID/PGID.	Użyj PUID i PGID aplikacji.
-delete nic nie zrobiło	Coś się nie udało albo montaż jest tylko do odczytu.	Usuń plik na hoście.

Dla zaawansowanych

Flagi i kody wyjścia

Flaga	Co robi	Domyślnie
-file <path>	Plik z sekretami.	brak
-dry-run	Tylko mówi, co zostałoby ustawione.	wyłączone
-config <folder>	Folder konfiguracji.	/config
-delete	Po przebiegu bez błędów nadpisuje plik zerami i usuwa go.	wyłączone
-forget-move-credentials	Usuwa wszystkie zapisane klucze dotychczasowych aplikacji, a potem kończy.	wyłączone
-allow-http-lan	Pozwala na zwykłe http:// do adresu w sieci domowej. Wypisuje ostrzeżenie.	wyłączone
-allow-readable-file	Akceptuje plik, który mogą czytać inni użytkownicy. Docker Desktop w Windows pokazuje każdy plik jako czytelny.	wyłączone

Adres holyarrs musi zaczynać się od https:// albo być zwykłym http:// tylko do tego komputera (127.0.0.1, ::1, localhost). Przez zwykłe http twój klucz właściciela i cały plik płyną bez szyfrowania.

Kod wyjścia	Znaczenie
0	Każda pozycja się udała.
1	Pozycja się nie udała. Popraw plik i uruchom ponownie.
2	Błędne polecenie lub plik.

Wynik

Jedna linia na pozycję: set (albo would set w próbnym przebiegu, czasem z notatką), unchanged, skipped (empty), skipped (why) lub failed: why. Nigdy nie wypisuje klucza, hasła, tokenu ani adresu. Historia dostaje jedno zdarzenie (Event) tylko z liczbami. Błąd, który pokazałby wartość z twojego pliku, pokazuje zamiast niej [hidden].

Format pliku

Mała, ścisła część YAML:

• bloki przez wcięcia spacjami, nigdy tabulatorami; listy z - ,
• wartości zwykłe, w "double quotes" lub 'single quotes' (apostrof ' wewnątrz pojedynczych cudzysłowów pisz dwa razy),
• # zaczyna komentarz na początku linii lub po spacji poza cudzysłowami, więc ujmij w cudzysłów hasło zawierające #,
• ujmij w cudzysłów wartość, która zaczyna się od &, *, !, |, >, [, {, %, @ lub odwrotnego apostrofu albo zawiera : .

Nieznany klucz albo plik większy niż 256 KB zatrzymuje cały import, zanim cokolwiek zostanie zapisane; komunikat podaje klucz i linię. Dowiązanie do pliku jest odrzucane.

Pola specjalne

Pole	Reguła
SABnzbd	Wymaga pełnego api_key. nzb_key, nazwa użytkownika lub hasło są pomijane i nigdy nie zapisywane.
tvdb.api_key, tvdb.unique_user_key, trakt.redirect_urls	Akceptowane i pomijane.
smtp.host	Tylko nazwa serwera, bez schematu i portu.
smtp.port	Od 1 do 65535. Domyślnie 587.
smtp.from	Jeden zwykły adres e-mail.
Bloki dotychczasowych aplikacji	Używane w Move from other apps z Use the saved key (użyj zapisanego klucza). Nigdy nie są pokazywane, tylko dla właściciela, usuwane po jednym udanym odczycie.

Powiązane strony

• Odczyt dotychczasowych aplikacji
• Zmienne środowiskowe