متغيرات البيئة
يقرأ Excubius إعدادات التثبيت من ملف .env في دليل التثبيت، وهو /opt/excubius/.env افتراضيًا، بصلاحيات الوصول 0600، ومملوك لحساب الخدمة. يكتبه المثبّت من إجاباتك، ويُنشئ الأسرار مرة واحدة. يسرد هذا المرجع المفاتيح التي يمكنك ضبطها، مقسّمة إلى أقسام كما في الملف.
تقع معظم الإعدادات في وحدة التحكم لا هنا: العلامة التجارية ومفاتيح الميزات في Settings › Instance، والأسماء والشهادات في Settings › Server، والمصادر في Settings › Sources، وبيانات اعتماد المراقبة في Settings › Credentials. بعد تغيير الملف، أعد تشغيل المنصة بحساب الخدمة بالأمر systemctl --user restart excubius.
احتفظ بنسخة احتياطية من ملف .env، ومعه EXCUBIUS_DATA_KEY. بدون هذا المفتاح لا يمكن فك تشفير الأسرار المخزنة في قاعدة البيانات.
التثبيت
| المفتاح | القيمة الافتراضية | المعنى |
|---|---|---|
EXCUBIUS_HOME | /opt/excubius | دليل التثبيت. يكتبه المثبّت |
SERVER_NAME | — | الاسم الأساسي: مضيف عنوان URL العام |
REGISTRY | ghcr.io/custorius-labs/excubius | بادئة السجل والمستودع للصور |
PROXY_MODE | http | http أو https. يسري فقط إلى أن تتولى خدمة الشهادات الأمر؛ وبعد ذلك تحدد Settings › Server القيمة |
COOKIE_SECURE | فارغ | فارغ: تكون ملفات تعريف ارتباط الجلسة Secure متى وصل الطلب عبر HTTPS. وتفرض القيمتان true وfalse السلوك. اترك الحقل فارغًا |
الأسماء وTLS
تُستخدم هذه المفاتيح لتهيئة إعدادات TLS عند أول تشغيل فقط، عندما لا يكون للمنصة أي إعدادات بعد. ومنذ ذلك الحين تُدار الأسماء والشهادات في Settings › Server دون إعادة تشغيل. يزيل المثبّت بيانات اعتماد DNS والمفتاح الخاص من الملف بمجرد أن تخزنها المنصة.
| المفتاح | القيمة الافتراضية | المعنى |
|---|---|---|
TLS_MODE | فارغ | letsencrypt_http أو letsencrypt_dns أو selfsigned أو custom أو gateway أو http. وتُقبل أيضًا أسماء المثبّت letsencrypt وletsencrypt-dns وlater |
TLS_ALIASES | فارغ | أسماء أخرى يمكن للمستخدمين فتحها، تفصل بينها مسافات |
TLS_CERT_NAMES | فارغ | الأسماء التي تُدرج في الشهادة، تفصل بينها مسافات. فارغ: كل الأسماء |
TLS_EMAIL | فارغ | البريد الإلكتروني لحساب Let's Encrypt |
TLS_ACME_SERVER | production | staging للتجربة بشهادات اختبار لا تثق بها المتصفحات |
TLS_DNS_PROVIDER | فارغ | معرّف dnsapi في acme.sh لمزوّد DNS، مثل dns_cf أو dns_azure |
TLS_DNS_CREDENTIALS | فارغ | أزواج KEY=VALUE تفصل بينها أسطر جديدة أو ;، أو base64:<…> |
TLS_CERT_FILE، TLS_KEY_FILE | فارغ | base64:<PEM contents> لسلسلة الشهادات والمفتاح الخاص الخاصين بك |
TLS_ACME_DNSSLEEP | 0 | عدد الثواني للانتظار حتى انتشار DNS بدلًا من التحقق منه عبر محللات DNS-over-HTTPS العامة. استخدمه في الشبكات التي لا تصل إلى تلك المحللات |
المنتج
| المفتاح | القيمة الافتراضية | المعنى |
|---|---|---|
PRODUCT_NAME | Excubius | قيمة احتياطية فقط. يأتي اسم المنتج من العلامة التجارية في Settings › Instance |
DEFAULT_LOCALE | en | اللغة الافتراضية |
BASE_URL | — | عنوان URL العام، مثل https://monitoring.example.com. تستخدمه الروابط في الرسائل |
EXCUBIUS_DEFAULT_PRESET | enterprise | الإعداد المسبق الذي يبدأ منه المثيل: enterprise أو databases أو core |
EXCUBIUS_FEATURES_ENFORCE_API | false | true: ترفض واجهة API أيضًا الميزات المعطلة. الافتراضي: تُخفى في الواجهة فقط |
قاعدة البيانات والأسرار
| المفتاح | القيمة الافتراضية | المعنى |
|---|---|---|
POSTGRES_USER | excubius | مستخدم قاعدة البيانات |
POSTGRES_PASSWORD | يُنشأ تلقائيًا | أحرف وأرقام فقط، لأنها تُضمَّن في عنوان URL للاتصال |
POSTGRES_DB | excubius | اسم قاعدة البيانات |
DATABASE_URL | يُبنى من المفاتيح الثلاثة أعلاه | عنوان URL للاتصال. تتلقاه الحاويات مبنيًا من المفاتيح الثلاثة أعلاه |
EXCUBIUS_DATA_KEY | يُنشأ تلقائيًا | المفتاح الذي يشفّر الأسرار المخزنة في قاعدة البيانات: بيانات الاعتماد وأسرار المصادر ومفاتيح DNS API. 32 بايتًا عشوائيًا بترميز base64 آمن للاستخدام في عناوين URL. لا تغيّره أبدًا في تثبيت قيد التشغيل |
EXCUBIUS_COLLECTOR_TOKEN | يُنشأ تلقائيًا | سر مشترك بين المُجمِّع وواجهة API. فارغ: يبقى المُجمِّع خاملًا وتُعطَّل نقاط نهاية المُجمِّع |
تسجيل الدخول
| المفتاح | القيمة الافتراضية | المعنى |
|---|---|---|
JWT_SECRET | يُنشأ تلقائيًا | يوقّع رموز الجلسة. 64 حرفًا عشوائيًا |
ACCESS_TOKEN_MINUTES | 15 | مدة صلاحية رمز الوصول |
REFRESH_TOKEN_DAYS | 14 | مدة صلاحية الجلسة |
ENTRA_TENANT_ID، ENTRA_CLIENT_ID، ENTRA_CLIENT_SECRET | فارغ | تسجيل الدخول عبر Microsoft Entra ID لمستأجر واحد: معرّف الدليل، وليس common أو organizations. يُعرض الخيار بمجرد ضبط المفاتيح الثلاثة. عنوان إعادة التوجيه (Redirect URI): <BASE_URL>/api/v1/auth/entra/callback |
GOOGLE_CLIENT_ID، GOOGLE_CLIENT_SECRET | فارغ | تسجيل الدخول عبر Google. عنوان إعادة التوجيه (Redirect URI): <BASE_URL>/api/v1/auth/google/callback |
ALLOWED_SIGNUP_DOMAINS | فارغ | نطاقات البريد الإلكتروني، تفصل بينها فواصل، التي يحصل أصحابها عند أول تسجيل دخول على حساب بدور العارض على الجذر. يسري فقط إلى أن يُحفظ وضع للتسجيل على الكيان الجذر. فارغ: بالدعوة فقط |
لا تُخزَّن أسرار العميل في قاعدة البيانات ولا تُكتب في السجلات أبدًا.
نواة المراقبة
| المفتاح | القيمة الافتراضية | المعنى |
|---|---|---|
EXCUBIUS_UNREACHABLE_AFTER | 3 | عدد حالات فشل الاتصال أو تسجيل الدخول أو انتهاء المهلة المتتالية قبل أن يتلقى المورد تنبيه Cannot reach |
EXCUBIUS_NOTIFY_QUIET_MINUTES | 10 | الحد الأدنى للدقائق بين رسالتين للحالة نفسها. وتُرسل الرسالة دائمًا عند ارتفاع الخطورة |
EXCUBIUS_COLLECTOR_VIA_PROXY | false | true فقط لمُجمِّع خارج الخادم يصل إلى واجهة API عبر العنوان العام |
المُجمِّع
تتلقى حاوية المُجمِّع هذه المفاتيح فقط، ولا تتلقى الملف كاملًا أبدًا.
| المفتاح | القيمة الافتراضية | المعنى |
|---|---|---|
EXCUBIUS_COLLECTOR_TOKEN | يُنشأ تلقائيًا | راجع قاعدة البيانات والأسرار |
EXCUBIUS_COLLECTOR_TRANSPORTS | كل وسائل النقل الموجودة | مجموعة فرعية تفصل بين عناصرها فواصل لتعرضها، مثل tsql,http,dns. القيم: tsql وhttp وdns وwinrm وssh وazure_graph وdefender وentra وwazuh |
EXCUBIUS_COLLECTOR_CONCURRENCY | 32 | عدد الفحوص التي تعمل في وقت واحد |
EXCUBIUS_TSQL_THREADS | 16 | عدد الخيوط (threads) لاتصالات SQL Server |
EXCUBIUS_SQL_APP_NAME | monitoring-collector | اسم التطبيق لجلسات SQL Server الخاصة بالمُجمِّع |
EXCUBIUS_ODBC_DRIVER | ODBC Driver 18 for SQL Server | اسم برنامج تشغيل ODBC |
AZURE_SUBSCRIPTION_IDS | فارغ | الاشتراكات، تفصل بينها فواصل، لفحوص Resource Graph الأصلية (أمان السحابة، Azure Update Manager) عندما لا تحدد بيانات الاعتماد أيًّا منها. فارغ: كل اشتراك يمكن للهوية قراءته. ولمصدر Azure Monitor قائمته الخاصة |
AZURE_TENANT_ID، AZURE_CLIENT_ID، AZURE_CLIENT_SECRET | فارغ | فارغ: الهوية المُدارة للخادم. يحدد AZURE_CLIENT_ID وحده هوية مُدارة يعيّنها المستخدم (user-assigned). المفاتيح الثلاثة كلها: يُستخدم كيان الخدمة (service principal) ذاك بدلًا منها |
للمُجمِّع أيضًا إعدادات لفواصل الاستطلاع وأحجام الدفعات والمخازن المؤقتة واسم المضيف، لكن المنصة المثبّتة لا تمررها إلى حاويته، لذلك تسري قيمها الافتراضية: التكليفات كل 30 ثانية، والمهام كل 10 ثوانٍ، وإشارة نبض كل 60 ثانية، و200 نتيجة في كل دفعة، والاحتفاظ بـ 10,000 نتيجة أثناء تعذر الوصول إلى واجهة API.
الإشعارات والتذاكر
| المفتاح | القيمة الافتراضية | المعنى |
|---|---|---|
SLACK_BOT_TOKEN | فارغ | رمز البوت لتطبيق Slack، بالنطاق chat:write. فارغ: لا يُرسل شيء إلى Slack |
SLACK_DEFAULT_CHANNEL | #alerts | تتلقى التحذيرات والتنبيهات الحرجة عندما لا يكون لأي كيان على المسار قناة |
JIRA_BASE_URL | فارغ | https://<site>.atlassian.net |
JIRA_AUTH | token | token (البريد الإلكتروني ورمز API)، أو oauth (بيانات اعتماد العميل لحساب خدمة Atlassian)، أو bearer |
JIRA_EMAIL، JIRA_API_TOKEN | فارغ | بيانات الاعتماد للنمط token |
JIRA_OAUTH_CLIENT_ID، JIRA_OAUTH_CLIENT_SECRET | فارغ | بيانات الاعتماد للنمط oauth |
JIRA_CLOUD_ID | فارغ | oauth فقط: معرّف السحابة (cloud ID) للموقع |
JIRA_OAUTH_TOKEN_URL | https://auth.atlassian.com/oauth/token | عنوان URL للرمز للنمط oauth |
JIRA_DEFAULT_PROJECT | فارغ | مفتاح المشروع للتذاكر (issues) الجديدة |
JIRA_ISSUE_TYPE | Task | اسم نوع التذكرة في ذلك المشروع |
JIRA_SYNC_MINUTES | 10 | عدد الدقائق بين كل قراءتين لحالة التذاكر المفتوحة |
WEB_PUSH_VAPID_PUBLIC، WEB_PUSH_VAPID_PRIVATE | فارغ | محجوزان لإشعارات web push، وغير متاحين في هذا الإصدار. اتركهما فارغين |
مفاتيح Jira قيم افتراضية: يمكن لكل كيان تجاوزها في إعدادات Jira الخاصة به. راجع إنشاء تذاكر Jira من التنبيهات.
التحديثات وعامل الأمان
| المفتاح | القيمة الافتراضية | المعنى |
|---|---|---|
EXCUBIUS_SECURITY_WORKER | true | العامل الخلفي لواجهة API: خلاصات المزوّدين، وانتهاء قبول المخاطر، والفحوص التي تشغّلها واجهة API، ولقطات درجة الأمان، وحالة Jira. اضبطه على false على نسخ API الإضافية فقط |
EXCUBIUS_FEEDS_ENABLED | true | false: لا تجلب خلاصات المزوّدين أبدًا، للتثبيتات المعزولة عن الإنترنت (air-gapped). وتُستخدم النسخ المرفقة مع الإصدار |
EXCUBIUS_FEED_TIMEOUT_SECONDS | 60 | مهلة كل طلب خلاصة |
EXCUBIUS_FEED_SQLSERVER_BUILDS_URLS | موقع dbatools ثم GitHub | عناوين URL لقائمة builds الخاصة بـ SQL Server، تفصل بينها مسافات، وتُجرَّب بالترتيب. ضع نسخة مرآة داخلية أولًا |
EXCUBIUS_FEED_ENDOFLIFE_URL | https://endoflife.date/api | عنوان URL الأساسي لخلاصة نهاية الدعم |
EXCUBIUS_FEED_MSRC_URL | https://api.msrc.microsoft.com/cvrf/v3.0 | عنوان URL الأساسي للإشعارات الاستشارية الأمنية من Microsoft |
EXCUBIUS_FEED_MSRC_MONTHS | 3 | عدد الإصدارات الشهرية التي تُبقى محدّثة، من 1 إلى 24 |
HTTPS_PROXY | فارغ | وكيل لطلبات الخلاصات |
المفاتيح التي لا يقرؤها هذا الإصدار
لا يزال الملف .env.example المرفق يسرد NEWRELIC_API_KEY وNEWRELIC_ACCOUNT_ID وNEWRELIC_WEBHOOK_SECRET وNINJAONE_CLIENT_ID وNINJAONE_CLIENT_SECRET وNINJAONE_REGION وWAZUH_API_URL وWAZUH_API_USER وWAZUH_API_PASSWORD. يتجاهلها هذا الإصدار. اضبط New Relic وNinjaOne في Settings › Sources، واضبط Wazuh ببيانات اعتماد ومعاملات الفحص؛ راجع المصادر وأمان السحابة.