تخطَّ إلى المحتوى

استيراد المفاتيح من ملف

الإعداد

املأ ملفًا واحدًا بمصادرك وبرامج التنزيل وخوادم الوسائط ومواقع الترجمات والبريد، ثم استورده، ولن تحتاج إلى كتابة كل مفتاح في الإعدادات.

  • يعمل HolyArrs في Docker وإعداداته في /config.
  • تستطيع إنشاء مفتاح API للمالك من Settings > API > API keys (الإعدادات > API > مفاتيح API).
  1. انسخ holyarrs-secrets.template.yaml إلى holyarrs-secrets.yaml.

  2. املأ ما تستخدمه. اترك الباقي فارغًا؛ الفارغ يعني التخطي.

  3. اجعله مقروءًا لك وحدك:

    Terminal window
    chmod 600 holyarrs-secrets.yaml
  4. ركّبه في الحاوية للقراءة فقط:

    volumes:
    - /srv/holyarrs/config:/config
    - /srv/holyarrs/holyarrs-secrets.yaml:/run/secrets/holyarrs.yaml:ro
  5. أنشئ مفتاح API للمالك بالنطاق admin (المشرف) من Settings > API > API keys. ضعه في القسم holyarrs من الملف مع العنوان http://127.0.0.1:6262.

  6. جرّب تشغيلًا تجريبيًا. لا يغيّر شيئًا:

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

    سترى سطر would set واحدًا لكل عنصر.

  7. شغّله فعليًا (الأمر نفسه دون -dry-run). سترى سطور set ورمز الخروج 0.

  8. تحقق من المصادر وبرامج التنزيل الجديدة، ثم استأنفها. اختبر خوادم الوسائط والتنبيهات الجديدة، ثم شغّلها.

  9. احذف الملف من الجهاز المضيف (انظر احذف الملف). واحذف مفتاح 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:

Terminal window
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 وأنظمة الملفات التي تنسخ عند الكتابة، قد تبقى الكتل القديمة على القرص. أما المفاتيح نفسها فصارت في الخزنة المشفّرة.

العَرَض السبب الحل
الملف مقروء لمستخدمين آخرين الأذونات مفتوحة أكثر من اللازم. شغّل 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' (اكتب ' مرتين داخل علامتي الاقتباس المفردتين)،
  • # تبدأ تعليقًا في أول السطر أو بعد مسافة خارج علامات الاقتباس، لذلك ضع كلمة المرور التي فيها # بين علامتي اقتباس،
  • ضع بين علامتي اقتباس كل قيمة تبدأ بـ & أو * أو ! أو | أو > أو [ أو { أو % أو @ أو علامة اقتباس خلفية، أو فيها : .

مفتاح غير معروف أو ملف أكبر من 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 (استخدم المفتاح المحفوظ). لا تُعرض أبدًا، للمالك وحده، وتُحذف بعد قراءة ناجحة واحدة.

HolyArrs مجاني. إذا وفّر عليك وقتًا، امنحه نجمة على GitHub أو ادعمه ماليًا أو ادعُني إلى فنجان قهوة.