وارد کردن کلیدها از یک فایل

راه‌اندازی

یک فایل را با منبع‌ها، دانلودرها، سرورهای رسانه، سایت‌های زیرنویس و ایمیل خود پر کنید، آن را وارد کنید، و از تایپ تک‌تک کلیدها در تنظیمات خلاص شوید.

پیش از شروع

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 یک کلید API مالک با دامنهٔ admin بسازید. آن را در بلوک holyarrs فایل، همراه با نشانی http://127.0.0.1:6262 بگذارید.
یک اجرای آزمایشی امتحان کنید. چیزی را تغییر نمی‌دهد:
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`	برای هر ورودی یک منبع، 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' (یک ' داخل single quotes را دو بار بنویسید)،
# یک توضیح را در ابتدای خط یا بعد از یک فاصله خارج از نقل‌قول شروع می‌کند، پس گذرواژه‌ای را که # دارد در نقل‌قول بگذارید،
مقداری را که با &، *، !، |، >، [، {، %، @ یا یک بک‌کوت شروع می‌شود، یا : دارد، در نقل‌قول بگذارید.

یک کلید ناشناخته یا فایلی بزرگ‌تر از 256 KB کل وارد کردن را پیش از ذخیرهٔ هر چیزی متوقف می‌کند؛ پیام نام کلید و شمارهٔ خط را می‌گوید. پیوند به فایل رد می‌شود.

فیلدهای خاص

فیلد	قاعده
SABnzbd	`api_key` کامل لازم دارد. `nzb_key`، نام کاربری یا گذرواژه رد می‌شود و هرگز ذخیره نمی‌شود.
`tvdb.api_key`، `tvdb.unique_user_key`، `trakt.redirect_urls`	پذیرفته و رد می‌شوند.
`smtp.host`	فقط نام سرور، بدون scheme یا پورت.
`smtp.port`	1 تا 65535. پیش‌فرض `587`.
`smtp.from`	یک نشانی ایمیل ساده.
بلوک‌های برنامه‌های قبلی	در Import from other apps با Use the saved key (استفاده از کلید ذخیره‌شده) به کار می‌روند. هرگز نشان داده نمی‌شوند، فقط برای مالک، بعد از یک خواندن موفق پاک می‌شوند.

صفحه‌های مرتبط

HolyArrs رایگان است. اگر در وقتتان صرفه‌جویی کرد، در GitHub به آن ستاره بدهید، حمایت مالی کنید یا برای من یک قهوه بخرید.