متغیرهای محیطی

حرفه‌ای

همهٔ متغیرهایی که کانتینر HolyArrs می‌خواند. بیشتر نصب‌ها فقط PUID، PGID و TZ را تنظیم می‌کنند.

رایج

متغیر	کار آن	پیش‌فرض	نمونه
`PUID`, `PGID`	کاربر و گروهی که HolyArrs با آن‌ها اجرا می‌شود. باید صاحب `/config` و پوشه‌های رسانهٔ شما باشند.	`1000`, `1000`	`PUID=1000`
`TZ`	منطقهٔ زمانی برای زمان‌بندی‌ها و لاگ‌ها.	`Etc/UTC`	`TZ=Europe/Amsterdam`
`UMASK`	بیت‌های دسترسی که از فایل‌های جدید حذف می‌شوند. فقط روی فایل‌های جدید اثر می‌گذارد.	`022`	`UMASK=002`
`HOLYARRS_SAVE_PATH`	پوشهٔ ذخیرهٔ دانلودر، همان‌طور که خود دانلودر آن را می‌بیند. با هر دانلود فرستاده می‌شود.	ندارد	`/data/downloads`
`HOLYARRS_URL_BASE`	HolyArrs را پشت ریورس پراکسی زیر یک مسیر اجرا می‌کند. `/` مسیری را که در تنظیمات ذخیره شده نادیده می‌گیرد.	ندارد	`/holyarrs`
`HOLYARRS_ALLOWED_HOSTS`	نام‌های میزبان اضافه‌ای که مردم با آن‌ها به HolyArrs می‌رسند، با کاما جدا می‌شوند.	IPها و `localhost`	`holyarrs.example.com`
`HOLYARRS_TRUSTED_PROXIES`	نشانی یا شبکهٔ ریورس پراکسی شما، با کاما جدا می‌شوند. برای دیدن نشانی واقعی کلاینت‌ها لازم است.	ندارد	`172.18.0.0/16`
`HOLYARRS_MASTER_KEY_FILE`	کلید اصلی خزانه را از فایل جداگانهٔ خودش می‌خواند. کاربر `PUID` باید بتواند آن را بخواند.	`/config/holyarrs.key`	`/keys/holyarrs.key`

مقدار از فایل

جلوی هر متغیر FILE__ بگذارید تا مقدارش از یک فایل خوانده شود، مثلاً از یک Docker secret.

environment:
  - FILE__HOLYARRS_ALLOWED_HOSTS=/run/secrets/holyarrs_hosts

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

بازیابی و عیب‌یابی

متغیر	کار آن	پیش‌فرض	نمونه
`HOLYARRS_SAFE_MODE`	فقط هسته را راه می‌اندازد: ورود، کتابخانه، تنظیمات، بکاپ‌ها و سلامت. بعد از رفع مشکل آن را بردارید.	خاموش	`1`
`HOLYARRS_LOW_MEMORY`	`1` حالت کم‌حافظه را اجباراً روشن و `0` اجباراً خاموش می‌کند. اگر تنظیم نشود، در حدود 2.5 GiB حافظهٔ RAM یا کمتر روشن می‌شود.	بر اساس اندازهٔ رایانه	`1`
`HOLYARRS_FOLLOW_LINKS`	`1` اجازه می‌دهد اسکن کتابخانه و وارد کردن‌ها از فایل‌های ویدیو و موسیقی که symlink هستند استفاده کنند (کتابخانه‌هایی که از پیوند به یک درایو متصل ساخته شده‌اند). دانلودی که پیوند است، در کتابخانه هم به‌صورت پیوند قرار می‌گیرد.	خاموش	`1`
`GOMEMLIMIT`	هدف حافظه‌ای را که HolyArrs برای خودش تعیین می‌کند، تغییر می‌دهد.	HolyArrs تعیین می‌کند	`1GiB`
`HOLYARRS_SKIP_SPACE_CHECK`	بررسی فضای خالی را پیش از به‌روزرسانی پایگاه داده رد می‌کند.	خاموش	`yes`
`HOLYARRS_CONFIG_IN_MEMORY`	اجازه می‌دهد `/config` روی پوشه‌ای در حافظه باشد. برای رایانه‌های آزمایشی؛ با راه‌اندازی مجدد داده‌ها از بین می‌روند.	خاموش	`yes`
`HOLYARRS_ALLOW_DESKTOP_FOLDER`	با `/config` در یک پوشهٔ اشتراکی Docker Desktop روی مک شروع می‌کند، پس از آنکه خودتان بررسی کردید قفل فایل‌ها آنجا کار می‌کنند. HolyArrs در هر شروع هشدار می‌دهد.	خاموش	`1`
`HOLYARRS_READONLY_DOWNLOADERS`	دانلودرهایی که HolyArrs هرگز نباید تغییرشان دهد، با شناسه یا نشانی، با کاما جدا می‌شوند.	ندارد	`3,http://qbit:8080`
`HOLYARRS_HEALTH_URL`	نشانی‌ای که بررسی سلامت کانتینر صدا می‌زند.	`http://127.0.0.1:6262`	`http://127.0.0.1:6262/holyarrs`

متغیرهای روشن/خاموش مقدار 1، true، yes یا on را قبول می‌کنند.

ورود یکپارچه (Single sign-on)

این‌ها را پیش از شروع تنظیم کنید. اگر HOLYARRS_OIDC_ENABLED اصلاً وجود داشته باشد، حتی با مقدار false، ورود یکپارچه در اختیار محیط است و تنظیمات فقط آن را نشان می‌دهد. متغیرهای روشن/خاموش این بخش فقط true یا false را قبول می‌کنند؛ هر چیز دیگر جلوی شروع را می‌گیرد.

متغیر	کار آن	پیش‌فرض
`HOLYARRS_OIDC_ENABLED`	ورود یکپارچه را روشن می‌کند.	`false`
`HOLYARRS_OIDC_ISSUER`	issuer دقیق HTTPS ارائه‌دهنده.	ندارد
`HOLYARRS_OIDC_CLIENT_ID`	شناسهٔ کلاینتِ ثبت‌شده.	ندارد
`HOLYARRS_OIDC_CLIENT_SECRET_FILE`	فایلی که رمز کلاینت در آن است، حداکثر 4096 بایت. برای کلاینت عمومی خالی بگذارید.	ندارد
`HOLYARRS_OIDC_REDIRECT_URL`	callback دقیق: نشانی شما، URL base اگر دارید، و بعد `/api/v1/auth/oidc/callback`.	ندارد
`HOLYARRS_OIDC_ALLOW_JOIN`	افراد تازه به‌عنوان عضو می‌پیوندند و فقط می‌توانند درخواست بدهند.	`false`
`HOLYARRS_OIDC_ALLOW_LOCAL_NETWORK`	اجازه می‌دهد ارائه‌دهنده در شبکهٔ خصوصی شما باشد.	`false`
`HOLYARRS_OIDC_ALLOW_LOOPBACK_HTTP`	برای آزمایش، HTTP ساده را روی همین رایانه اجازه می‌دهد.	`false`
`HOLYARRS_FORWARD_AUTH_ENABLED`	ورود از طریق پراکسی مورد اعتماد را روشن می‌کند.	`false`
`HOLYARRS_FORWARD_AUTH_ISSUER`	نام HTTPS ثابت برای پراکسی.	ندارد
`HOLYARRS_FORWARD_AUTH_TRUSTED_PEERS`	نشانی‌ها یا بازه‌های پراکسی که اجازه دارند سرآیند هویت بفرستند، با کاما جدا می‌شوند.	ندارد
`HOLYARRS_FORWARD_AUTH_ALLOW_JOIN`	نام‌های تازهٔ پراکسی به‌عنوان عضو می‌پیوندند و فقط می‌توانند درخواست بدهند.	`false`

تنظیم نادرست جلوی شروع HolyArrs را می‌گیرد. مراحل در ورود و گذرواژه‌ها آمده است.

برای حرفه‌ای‌ها

فراداده

متغیر	کار آن	پیش‌فرض
`HOLYARRS_METADATA_URL`	نشانی سرور فراداده.	`https://api.holyarrs.com`
`HOLYARRS_TMDB_KEY`	توکن دسترسی خواندنِ TMDB خودتان. اگر تنظیم شود، خواندن از TMDB مستقیم به TMDB می‌رود، نه به سرور فراداده.	ندارد
`HOLYARRS_METADATA_SERVICE_TOKEN_FILE`	فایلی که اعتبارنامهٔ این نصب برای سرور فراداده در آن است و در هر فراخوانی خوانده می‌شود. اگر تنظیم نشود، اعتبارنامه در خزانه می‌ماند.	ندارد

آنچه با کلید TMDB خودتان باز هم از سرور فراداده می‌گذرد، و هر نشانی بیرونی دیگر، در نشانی‌های بیرونی آمده است.

میان‌برهای اولین شروع

هر کدام هنگام شروع یک مورد اضافه می‌کند. برای نمایش و آزمایش به کار می‌روند؛ ویزارد اولین اجرا هم همین کار را می‌کند.

متغیر	چه چیزی اضافه می‌کند
`HOLYARRS_MOVIES`	یک پوشهٔ کتابخانهٔ فیلم.
`HOLYARRS_QBITTORRENT_URL`	یک دانلودر qBittorrent.
`HOLYARRS_SOURCE_URL`	یک منبع Torznab بدون کلید.

متغیرهای توسعه و آزمایش

این‌ها HolyArrs را به جایگزین‌های آزمایشی وصل می‌کنند. در نصب واقعی تنظیم‌نشده بگذارید.

متغیر	کار آن
`HOLYARRS_FLAGS`	کلیدهای جداشده با کاما برای قابلیت‌هایی که در این نسخه به‌طور پیش‌فرض خاموش‌اند. به‌روزرسانی‌ها را ببینید.
`HOLYARRS_DIRECT_SOURCES`	`1` اجازه می‌دهد این نصب خودش از منبع‌های موسیقی و تلویزیون بپرسد، به‌جای سرور فراداده.
`HOLYARRS_METADATA_SERVICE_ALLOW_LOCAL`	اجازه می‌دهد سرور فراداده در شبکهٔ محلی باشد.
`HOLYARRS_METADATA_COUNT`	درخواست‌های فراداده را می‌شمارد و ثبت می‌کند.
`HOLYARRS_TMDB_TOKEN_FILE`, `HOLYARRS_TMDB_URL`	فایل توکن آزمایشی TMDB و نشانی جایگزین.
`HOLYARRS_TVMAZE_URL`, `HOLYARRS_MUSICBRAINZ_URL`, `HOLYARRS_DEEZER_URL`, `HOLYARRS_TRAKT_URL`, `HOLYARRS_PLEX_URL`, `HOLYARRS_PLEX_APP_URL`, `HOLYARRS_PLEX_DISCOVER_URL`, `HOLYARRS_PUSHOVER_URL`, `HOLYARRS_TELEGRAM_URL`, `HOLYARRS_YOUTUBE_URL`, `HOLYARRS_RELEASE_FEED`	نشانی‌های جایگزین برای سرویس‌های بیرونی.
`HOLYARRS_TRAILER_PASS_FIRST`, `HOLYARRS_TRAILER_PASS_EVERY`	زمان‌بندی گذر تریلر به‌صورت مدت، مثل `2s`.

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

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