مرجع المثبّت
يقوم المثبّت install.sh بتثبيت Excubius وترقيته وإعادة تثبيته وإلغاء تثبيته على خادم واحد. يعمل بصلاحيات root من حزمة المثبّت بعد فك ضغطها. يسرد هذا المرجع خياراته وفحوصه المسبقة والأسئلة التي يطرحها وما يتركه على الخادم. لمعرفة خطوات التثبيت، راجع تثبيت Excubius.
sudo ./install.sh [options]
الخيارات
| الخيار | التأثير |
|---|---|
| (بدون) | تثبيت. على خادم مثبّت عليه Excubius، يعرض Upgrade (الافتراضي: يحتفظ بالبيانات والإعدادات ولا يطرح إلا الأسئلة الجديدة في هذا الإصدار)، أو Reinstall، أو Purge، أو Cancel |
--check-only | يشغّل الفحوص المسبقة فقط. لا يغيّر شيئًا |
--images FILE | التثبيت من أرشيف صور، دون الوصول إلى السجل. يُستخدم تلقائيًا أرشيف موجود في images/ بجانب البرنامج النصي، كما في الحزمة غير المتصلة بالإنترنت |
--answers FILE | وضع غير تفاعلي: أسطر key=value تشمل الأسرار. راجع ملف الإجابات |
--reconfigure | عند الترقية، يطرح كل الأسئلة مجددًا. تُطبَّق إجابات TLS المقدمة حينها على المنصة العاملة |
--reinstall | يزيل البرنامج المثبّت مع الإبقاء على قاعدة البيانات، ثم يثبّته ويطرح كل الأسئلة |
--purge | يحذف كل شيء بما فيه قاعدة البيانات، ثم يثبّت من جديد |
--uninstall | يزيل البرنامج. يكتب أولًا نسخة نهائية من قاعدة البيانات (dump) في <dir>/backups/، ثم يزيل وحدات systemd الخاصة بالمستخدم والحاويات والصور و<dir>/releases و<dir>/current و/etc/excubius وإعداد المنافذ دون صلاحيات root. ويُبقي على مجلدات (volumes) قاعدة البيانات والشهادات و<dir>/backups و<dir>/.env وحساب الخدمة، فيجد التثبيت اللاحق البيانات |
--uninstall --purge | يحذف أيضًا كل المجلدات (volumes) ودليل التثبيت كاملًا مع نسخه الاحتياطية وحساب الخدمة الذي أنشأه المثبّت مع تخزين الحاويات الخاص به وخدمات جدار الحماية التي أضافها التثبيت. ويطلب منك كتابة purge |
--no-backup | دون نسخة نهائية من قاعدة البيانات عند استخدام --uninstall أو --reinstall |
--yes، -y | يقبل كل قيمة افتراضية موجودة؛ ولا بد أن تأتي الإجابات المطلوبة من --answers أو من لوحة المفاتيح. ويعني Upgrade على خادم مثبّت عليه Excubius، ويؤكد عملية purge |
--dry-run | يطبع ما سيُنفَّذ دون تغيير أي شيء. ولا يزال التثبيت يكتب ملفات الإعداد للمراجعة؛ بجانب ملف .env موجود، باسم .env.dry-run |
--skip-checks | يواصل حتى عند فشل الفحوص المسبقة، على أنظمة غير مدعومة، على مسؤوليتك |
--help، -h | يطبع الخيارات |
تُرفض هذه التركيبات: --uninstall مع --reinstall أو --reconfigure؛ و--purge مع --reinstall؛ و--check-only مع --uninstall أو --purge أو --reinstall؛ و--reconfigure مع --purge أو --reinstall.
لا يُزال إلا دليل التثبيت المسجّل، ولا يُزال أبدًا مسار نظام أو دليل رئيسي (home).
الفحوص المسبقة
| الفحص | المتطلب | عند عدم الاستيفاء |
|---|---|---|
| نظام التشغيل | Rocky Linux أو نظام آخر من عائلة RHEL | يفشل |
| الإصدار الرئيسي | 9 أو 10 | يحذّر |
| البنية | x86-64 | يفشل |
| نظام التهيئة (init) | systemd | يفشل |
| مدير الحزم | dnf | يفشل |
| الذاكرة | 4 GiB | يحذّر |
| المعالجات | 2 vCPU | يحذّر |
| القرص | 20 GiB خالية تحت /home، حيث يحتفظ حساب الخدمة بالصور وقاعدة البيانات | يحذّر |
| المنافذ | المنفذان 80 و443 متاحان، في التثبيت الجديد | يفشل |
| SELinux | يُبلَّغ عنه | — |
| السجلات | يمكن الوصول إلى ghcr.io وdocker.io عبر HTTPS، أو يوجد أرشيف صور مقروء | يفشل |
| الساعة | متزامنة | يحذّر؛ ويُفعَّل chrony |
الأسئلة
اضغط Enter لقبول القيمة الموجودة بين قوسين. عند الترقية، لا تُطرح إلا الأسئلة التي استُحدثت بعد الإصدار الذي كتب إجاباتك؛ ويوضح العمود منذ الإصدار الذي استحدث كل سؤال.
| المفتاح | السؤال | القيمة الافتراضية | يُطرح عندما | منذ |
|---|---|---|---|---|
install_dir | دليل التثبيت | /opt/excubius | دائمًا؛ مسار مطلق | 0.2.0 |
service_user | حساب الخدمة الذي يشغّل المنصة | excubius | دائمًا؛ يُنشأ إن لم يكن موجودًا، ويشغّل الحاويات دون صلاحيات root (rootless) | 0.2.0 |
public_url | عنوان URL العام الذي سيفتحه المستخدمون | https://monitoring.example.com | دائمًا؛ مضيفه هو الاسم الأساسي للخادم | 0.2.0 |
server_aliases | أسماء أخرى لهذا الخادم | بلا | دائمًا؛ تفصل بينها مسافات، وEnter لعدم إدخال أي اسم | 0.3.0 |
tls_mode | كيفية توفير HTTPS | letsencrypt | دائمًا: letsencrypt أو letsencrypt-dns أو selfsigned أو custom أو gateway أو later | 0.2.0 |
tls_cert_names | الأسماء التي تُدرج في الشهادة | all | توجد أسماء بديلة (aliases) ويُنشئ الوضع شهادة | 0.3.0 |
tls_email | البريد الإلكتروني لحساب Let's Encrypt | — | letsencrypt أو letsencrypt-dns | 0.2.0 |
tls_dns_provider | مزوّد DNS لنطاق (zone) الأسماء | — | letsencrypt-dns؛ معرّف dnsapi في acme.sh مثل dns_cf أو dns_dreamhost أو dns_azure | 0.3.0 |
tls_dns_credentials | بيانات اعتماد DNS API | — | letsencrypt-dns؛ تُدخل واحدة تلو الأخرى دون إظهار ما تكتبه | 0.3.0 |
tls_cert_file | ملف سلسلة الشهادات | — | custom؛ بصيغة PEM، مع شهادة الخادم أولًا | 0.3.0 |
tls_key_file | ملف المفتاح الخاص | — | custom؛ بصيغة PEM، دون عبارة مرور، ويطابق الشهادة | 0.3.0 |
default_preset | الإعداد المسبق الأساسي | enterprise | دائمًا: enterprise أو databases أو core | 0.2.0 |
registry_user، registry_token | مستخدم السجل ورمز للقراءة فقط للصور | — | دون أرشيف صور | 0.2.0 |
slack_bot_token | رمز بوت Slack | — | دائمًا؛ اختياري | 0.2.0 |
slack_default_channel | قناة Slack للتنبيهات | #alerts | دائمًا | 0.2.0 |
entra_tenant_id | معرّف مستأجر Entra ID لتسجيل الدخول | — | دائمًا؛ اختياري | 0.2.0 |
entra_client_id، entra_client_secret | معرّف تطبيق Entra ID وسر العميل | — | عند إدخال معرّف المستأجر | 0.2.0 |
أوضاع TLS:
| الوضع | استخدمه عندما |
|---|---|
letsencrypt | كل الأسماء موجودة في DNS العام وتشير إلى الخادم، والمنفذ 80 متاح من الإنترنت |
letsencrypt-dns | لديك بيانات اعتماد API لنطاق DNS الخاص بالأسماء. ولا يلزم أن يكون الخادم متاحًا من الإنترنت |
selfsigned | في أي مكان. تعرض المتصفحات تحذيرًا إلى أن يثق المستخدمون بالشهادة |
custom | تصدر مؤسستك الشهادة |
gateway | ينتهي TLS عند موازن تحميل أو وكيل عكسي (reverse proxy) أمام الخادم |
later | HTTP عادي في الوقت الحالي |
مع أحد أوضاع Let's Encrypt، يتحقق المثبّت من الأسماء في DNS العام، ومن أنها تشير إلى هذا الخادم عبر HTTP. ويشرح البدائل عندما لا تشير إليه، ولا يتوقف بسبب ذلك. تقتصر إجابات TLS على تهيئة إعدادات المنصة؛ وبعد ذلك تُدار في Settings › Server.
القيم المُنشأة
ينشئ المثبّت هذه القيم مرة واحدة ولا يستبدلها أبدًا: كلمة مرور قاعدة البيانات (POSTGRES_PASSWORD)، وسر توقيع الجلسات (JWT_SECRET)، والمفتاح الذي يشفّر الأسرار المخزنة (EXCUBIUS_DATA_KEY)، ورمز المُجمِّع (EXCUBIUS_COLLECTOR_TOKEN). راجع متغيرات البيئة.
ملف الإجابات
للتثبيت دون تدخل، مرّر --answers FILE مع سطر key=value واحد لكل سؤال. يتضمن هذا الملف الأسرار؛ فاحمه واحذفه بعد الاستخدام. تُكتب بيانات اعتماد DNS في سطر واحد، تفصل بينها ;. تأخذ الإجابة المفقودة القيمة الافتراضية؛ أما الإجابة المطلوبة المفقودة أو غير الصالحة فتوقف المثبّت مع ذكر اسم المفتاح، لتتمكن من استكمال الملف وتشغيله مجددًا.
مقتطف:
install_dir=/opt/excubius
service_user=excubius
public_url=https://monitoring.areito.example
server_aliases=
tls_mode=letsencrypt-dns
tls_email=ops@areito.example
tls_dns_provider=dns_cf
tls_dns_credentials=CF_Token=<token>
default_preset=enterprise
registry_user=<registry user>
registry_token=<read-only token>
slack_bot_token=<bot token>
slack_default_channel=#areito-alerts
sudo ./install.sh --answers ./answers.conf --yes
الترقيات والإجابات المرتبطة بالإصدارات
يسجّل المثبّت إجاباتك غير السرية في <dir>/install.answers، مع إصدار المثبّت الذي كتبها وما إذا كان ذلك التشغيل قد اكتمل. وعند الترقية لا يطرح إلا الأسئلة المستحدثة منذ ذلك الإصدار. ويُعامل التشغيل الذي لم يكتمل على أنه تثبيت جديد: تُطرح كل الأسئلة مجددًا، مع الإجابات السابقة قيمًا افتراضية. ولا تُكتب الأسرار في install.answers أبدًا.
على الخادم
| المسار | المحتوى |
|---|---|
<dir>/.env | الإعدادات والأسرار؛ بصلاحيات 0600، ومملوك لحساب الخدمة |
<dir>/install.answers | إجاباتك غير السرية، والإصدار الذي كتبها، وما إذا كان ذلك التشغيل قد اكتمل |
<dir>/current | الإصدار المثبّت، وهو رابط إلى <dir>/releases/ |
<dir>/backups | نسخ قاعدة البيانات اليومية، ويُحتفظ بآخر 14 منها، إضافةً إلى النسخة النهائية عند إلغاء التثبيت |
~<service account>/.config/systemd/user/ | excubius.service ومؤقّت النسخ الاحتياطي |
/var/log/excubius-install.log | سجل المثبّت، بدون أسرار |
بحساب الخدمة:
sudo -iu excubius
export XDG_RUNTIME_DIR=/run/user/$(id -u) # once per shell, for systemctl --user
systemctl --user status excubius # the platform
<dir>/current/scripts/compose.sh ps # the containers
<dir>/current/scripts/compose.sh logs -f backend # the API's log
<dir>/current/scripts/backup-db.sh # a database backup now
<dir>/current/scripts/enable-tls.sh --status # TLS without the console
<dir>/current/scripts/rollback.sh # back to the previous release