Nhập khóa từ một tệp

Điền một tệp với các Nguồn, trình tải xuống, máy chủ media, trang phụ đề và email của bạn, nhập nó vào, và khỏi phải nhập từng khóa trong Settings.

Trước khi bắt đầu

• HolyArrs chạy trong Docker với thư mục cấu hình tại /config.
• Bạn có thể tạo một khóa API của chủ sở hữu trong Settings > API > API keys (Cài đặt > API > Khóa API).

Nhập tệp

1. Sao chép holyarrs-secrets.template.yaml thành holyarrs-secrets.yaml.

2. Điền những gì bạn dùng. Để trống phần còn lại; trống nghĩa là bỏ qua.

3. Đặt quyền để chỉ mình bạn đọc được:

   chmod 600 holyarrs-secrets.yaml

4. Mount (gắn) nó vào container ở chế độ chỉ đọc:

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

5. Tạo một khóa API của chủ sở hữu với phạm vi admin trong Settings > API > API keys. Đặt nó vào khối holyarrs của tệp cùng địa chỉ http://127.0.0.1:6262.

6. Chạy thử. Nó không thay đổi gì:

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

   Bạn sẽ thấy một dòng would set cho mỗi mục.

7. Chạy thật (cùng lệnh nhưng không có -dry-run). Bạn sẽ thấy các dòng set và mã thoát 0.

8. Kiểm tra các Nguồn và trình tải xuống mới, rồi tiếp tục chúng. Kiểm tra các máy chủ media và Cảnh báo mới, rồi bật chúng.

9. Xóa tệp trên máy host (xem Xóa tệp). Xóa cả khóa API nếu bạn không cần nữa.

Chú ý

Tệp chứa mọi bí mật ở dạng văn bản thường cho đến khi bạn xóa nó. Hãy xóa nó trên máy host ngay khi lần chạy thành công.

Mỗi khối trở thành gì

Trong tệp	Trở thành
trakt.client_id	Khóa ứng dụng Trakt (Settings > Outside lists, Cài đặt > Danh sách ngoài).
tmdb, tvdb	Được chấp nhận từ các tệp cũ. Metadata không cần khóa nào.
opensubtitles, subdl	Một trang phụ đề với tài khoản của bạn.
addic7ed	Một trang phụ đề Addic7ed, chỉ cho phim bộ.
indexers	Một Nguồn cho mỗi mục, ở trạng thái paused (tạm dừng).
jackett, prowlarr	Khóa của chúng điền vào mọi mục indexers cùng địa chỉ mà chưa có khóa.
qbittorrent, sabnzbd	Một trình tải xuống, ở trạng thái paused.
nzbget, transmission, deluge	Bị bỏ qua. Lượt nhập chưa thiết lập được các mục này; hãy thêm chúng trong Settings > Downloaders (Cài đặt > Trình tải xuống).
jellyfin, emby, plex	Một máy chủ media, ở trạng thái off (tắt) cho đến khi bạn kiểm tra nó.
smtp, discord, webhook	Các Cảnh báo “Email”, “Discord” và “Webhook”, ở trạng thái off cho đến khi bạn kiểm tra chúng.
radarr, sonarr, lidarr, prowlarr, bazarr, seerr	Một khóa được lưu cho Import from other apps (nhập từ các ứng dụng khác).
holyarrs	Chỉ dùng để truy cập HolyArrs khi nó đang chạy. Không bao giờ được lưu.

Mọi khóa đều đi vào kho mã hóa, giống như khóa bạn nhập trong Settings.

Lựa chọn

Công tắc mạng nội bộ

Mỗi khối có địa chỉ có thể nhận allow_local_network: true. Nó cho phép mục đó truy cập máy này hoặc mạng ở nhà của bạn (192.168.x.x, 10.x.x.x, tên container). Không có nó, mục đó chỉ truy cập được internet, nên một trình tải xuống ở nhà sẽ không phản hồi. HolyArrs không bao giờ đoán điều này từ địa chỉ. Đó là cùng công tắc với May reach the local network (được phép truy cập mạng nội bộ) trong Settings.

Khi HolyArrs đang dừng

Chạy một container dùng một lần trên cùng thư mục cấu hình. Nó lưu thẳng vào thư mục cấu hình và không cần khối 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

Dùng cùng PUID và PGID với ứng dụng, nếu không thư mục cấu hình sẽ bị chuyển sang 1000:1000. Người dùng PUID phải đọc được tệp. Nếu bạn dùng HOLYARRS_MASTER_KEY_FILE, hãy cho container dùng một lần cùng biến đó và cùng mount.

Chạy lại

Chạy lại là an toàn. Các mục khớp sẽ báo unchanged; chỉ các mục đã đổi mới được lưu.

Mục	Khớp theo
Nguồn	tên
Trình tải xuống, máy chủ media	loại và địa chỉ
Cảnh báo	tên và loại
Trang phụ đề, các ứng dụng cũ	loại

Một Nguồn hoặc trình tải xuống có địa chỉ hoặc khóa bị đổi sẽ bị tạm dừng lại. Khi bạn đã tự tiếp tục một mục, lần chạy lại sẽ để nó tiếp tục chạy. Một api_key trống trong mục indexers giữ khóa đã lưu; thêm clear_key: true để xóa nó.

Xóa tệp

Với -delete, lệnh ghi đè tệp bằng số không rồi xóa nó, chỉ sau một lần chạy không có gì thất bại. Một mount chỉ đọc không thể xóa từ bên trong container, nên hãy xóa nó trên máy host:

Hệ thống	Lệnh
Linux	shred -u holyarrs-secrets.yaml
macOS	rm -P holyarrs-secrets.yaml
Windows	Remove-Item holyarrs-secrets.yaml, rồi dọn Thùng rác.

Trên ổ SSD và hệ thống tệp copy-on-write, các block cũ có thể vẫn còn trên ổ đĩa. Bản thân các khóa giờ nằm trong kho mã hóa.

Nếu không hoạt động

Triệu chứng	Nguyên nhân	Cách khắc phục
Tệp đọc được bởi những người dùng khác	Quyền quá rộng.	Chạy chmod 600. Trên Windows, hãy để nó trong một thư mục chỉ mình bạn mở được.
Một khóa không xác định làm dừng lượt nhập	Gõ sai hoặc có dấu tab ở dòng được nêu.	Sửa dòng đó. Chưa có gì được lưu.
Plain http bị từ chối	Địa chỉ holyarrs không nằm trên máy này.	Chạy bên trong container với http://127.0.0.1:6262, hoặc dùng https.
Một trình tải xuống ở nhà không phản hồi	Chưa có quyền truy cập mạng nội bộ.	Đặt allow_local_network: true trên khối đó.
Container dùng một lần đã đổi chủ sở hữu thư mục	PUID/PGID khác.	Dùng PUID và PGID của ứng dụng.
-delete không làm gì	Có gì đó thất bại, hoặc mount là chỉ đọc.	Xóa nó trên máy host.

Dành cho người dùng nâng cao

Cờ và mã thoát

Cờ	Tác dụng	Mặc định
-file <path>	Tệp bí mật.	không có
-dry-run	Chỉ nói những gì sẽ được đặt.	tắt
-config <folder>	Thư mục cấu hình.	/config
-delete	Sau một lần chạy không có thất bại, ghi đè tệp bằng số không và xóa nó.	tắt
-forget-move-credentials	Xóa mọi khóa ứng dụng cũ đã lưu, rồi dừng.	tắt
-allow-http-lan	Cho phép http:// thường tới một địa chỉ mạng ở nhà. In ra một lưu ý.	tắt
-allow-readable-file	Chấp nhận một tệp mà người dùng khác có thể đọc. Docker Desktop trên Windows hiện mọi tệp là đọc được.	tắt

Địa chỉ holyarrs phải là https://, hoặc http:// thường chỉ tới máy này (127.0.0.1, ::1, localhost). Qua http thường, khóa chủ sở hữu và cả tệp của bạn đi qua mà không được mã hóa.

Mã thoát	Ý nghĩa
0	Mọi mục đều ổn.
1	Một mục thất bại. Sửa tệp và chạy lại.
2	Dòng lệnh hoặc tệp không hợp lệ.

Kết quả hiển thị

Một dòng cho mỗi mục: set (hoặc would set khi chạy thử, đôi khi kèm ghi chú), unchanged, skipped (empty), skipped (why) hoặc failed: why. Nó không bao giờ in khóa, mật khẩu, token hay địa chỉ. Lịch sử nhận một sự kiện chỉ có số đếm. Một lỗi có thể hiện giá trị từ tệp của bạn sẽ hiện [hidden] thay vào đó.

Định dạng tệp

Một phần nhỏ và chặt chẽ của YAML:

• các khối theo thụt lề bằng dấu cách, không bao giờ dùng tab; danh sách bắt đầu bằng - ,
• giá trị để trần, trong "double quotes" hoặc 'single quotes' (viết ' hai lần bên trong dấu nháy đơn),
• # bắt đầu một ghi chú ở đầu dòng hoặc sau một dấu cách ngoài dấu nháy, nên hãy đặt trong dấu nháy một mật khẩu có chứa #,
• đặt trong dấu nháy một giá trị bắt đầu bằng &, *, !, |, >, [, {, %, @ hoặc một dấu huyền, hoặc có chứa : .

Một khóa không xác định hoặc tệp lớn hơn 256 KB sẽ dừng toàn bộ lượt nhập trước khi có gì được lưu; thông báo nêu tên khóa và dòng. Một liên kết tới tệp sẽ bị từ chối.

Các trường đặc biệt

Trường	Quy tắc
SABnzbd	Cần api_key đầy đủ. Một nzb_key, tên người dùng hoặc mật khẩu bị bỏ qua và không bao giờ được lưu.
tvdb.api_key, tvdb.unique_user_key, trakt.redirect_urls	Được chấp nhận và bỏ qua.
smtp.host	Chỉ tên máy chủ, không có scheme hay cổng.
smtp.port	1 đến 65535. Mặc định 587.
smtp.from	Một địa chỉ email thường.
Các khối ứng dụng cũ	Dùng trong Import from other apps với Use the saved key (dùng khóa đã lưu). Không bao giờ hiện, chỉ chủ sở hữu, bị xóa sau một lần đọc thành công.

Liên quan

• Đọc các ứng dụng cũ của bạn
• Biến môi trường