파일에서 키 가져오기

설정

소스, 다운로더, 미디어 서버, 자막 사이트, 메일 정보를 파일 하나에 채워서 가져오면 설정에서 키를 하나씩 입력하지 않아도 됩니다.

시작하기 전에

HolyArrs가 Docker에서 실행 중이고 설정이 /config에 있어야 합니다.
Settings > API > API keys(설정 > API > API 키)에서 소유자 API 키를 만들 수 있어야 합니다.

파일 가져오기

holyarrs-secrets.template.yaml을 holyarrs-secrets.yaml로 복사하세요.
쓰는 항목만 채우세요. 나머지는 비워 두세요. 비어 있으면 건너뜁니다.
본인만 읽을 수 있게 하세요.
Terminal window
```
chmod 600 holyarrs-secrets.yaml
```

컨테이너에 읽기 전용으로 마운트하세요.

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

Settings > API > API keys에서 admin 범위의 소유자 API 키를 만드세요. 이 키를 주소 http://127.0.0.1:6262와 함께 파일의 holyarrs 블록에 넣으세요.
먼저 시험 실행을 해 보세요. 아무것도 바뀌지 않습니다.
Terminal window
```
docker exec holyarrs /holyarrs import-secrets -file /run/secrets/holyarrs.yaml -dry-run
```
항목마다 would set 줄이 하나씩 표시됩니다.
실제로 실행하세요(같은 명령에서 -dry-run만 뺍니다). set 줄들과 종료 코드 0이 표시됩니다.
새 소스와 다운로더를 확인한 다음 재개하세요. 새 미디어 서버와 알림은 테스트한 다음 켜세요.
호스트에서 파일을 삭제하세요(파일 삭제하기 참고). API 키도 더 필요 없으면 삭제하세요.

블록별 결과

파일의 항목	결과
`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`	Move 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로 나오고, 바뀐 항목만 저장됩니다.

항목	일치 기준
소스	이름
다운로더, 미디어 서버	종류와 주소
알림	이름과 종류
자막 사이트, 기존 앱	종류

주소나 키가 바뀐 소스나 다운로더는 다시 일시 중지됩니다. 직접 재개한 항목은 다시 실행해도 계속 돌아갑니다. indexers 항목의 api_key가 비어 있으면 저장된 키를 유지합니다. 키를 지우려면 clear_key: true를 추가하세요.

파일 삭제하기

-delete를 붙이면 실패한 항목이 하나도 없는 실행 뒤에만 명령이 파일을 0으로 덮어쓰고 지웁니다. 읽기 전용 마운트는 컨테이너 안에서 삭제할 수 없으므로 호스트에서 삭제하세요.

시스템	명령
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`	실패 없이 실행된 뒤 파일을 0으로 덮어쓰고 삭제합니다.	꺼짐
`-forget-move-credentials`	저장된 기존 앱 키를 모두 삭제하고 끝냅니다.	꺼짐
`-allow-http-lan`	홈 네트워크 주소로 가는 일반 `http://`를 허용합니다. 경고를 출력합니다.	꺼짐
`-allow-readable-file`	다른 사용자가 읽을 수 있는 파일도 받아들입니다. Windows의 Docker Desktop은 모든 파일을 읽을 수 있는 것으로 보여줍니다.	꺼짐

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`	일반 이메일 주소 하나.
기존 앱 블록	Move from other apps에서 Use the saved key(저장된 키 사용)로 씁니다. 다시 보여주지 않고, 소유자 전용이며, 읽기에 한 번 성공하면 삭제됩니다.