Skip to content

مرجع أوامر CLI

يوفر SirrChat أداة سطر أوامر كاملة الميزات لإدارة وصيانة خادم البريد.

الأوامر الأساسية

sirrchatd

أمر البرنامج الرئيسي.

bash
sirrchatd [command] [flags]

الخيارات العامة

bash
--config string      مسار ملف التكوين (افتراضي "~/.sirrchatd/config.toml")
--debug              تمكين وضع التصحيح
--help, -h           إظهار معلومات المساعدة
--version, -v        إظهار معلومات الإصدار

إدارة الخدمة

run

بدء خادم البريد.

bash
sirrchatd run [flags]

الخيارات:

bash
--daemon             التشغيل في الخلفية
--pid-file string    مسار ملف PID

مثال:

bash
sirrchatd run --config /etc/sirrchatd/config.toml

stop

إيقاف الخادم قيد التشغيل.

bash
sirrchatd stop

restart

إعادة تشغيل الخادم.

bash
sirrchatd restart

status

عرض حالة الخادم.

bash
sirrchatd status

الإخراج:

الحالة: قيد التشغيل
PID: 12345
وقت التشغيل: 2d 5h 32m
الاتصالات: 42
الرسائل المعالجة: 15,234

إدارة المستخدمين

user create

إنشاء مستخدم جديد.

bash
sirrchatd user create [flags]

الخيارات:

bash
--username string    اسم المستخدم (عنوان البريد الإلكتروني)
--password string    كلمة المرور
--quota string       حصة التخزين (مثل "5GB")
--blockchain string  عنوان محفظة البلوكشين

مثال:

bash
sirrchatd user create \
  --username [email protected] \
  --password secretpass \
  --quota 5GB

user delete

حذف مستخدم.

bash
sirrchatd user delete --username [email protected]

user list

قائمة جميع المستخدمين.

bash
sirrchatd user list [flags]

الخيارات:

bash
--domain string      تصفية حسب النطاق
--format string      تنسيق الإخراج (table|json|csv)

user modify

تعديل معلومات المستخدم.

bash
sirrchatd user modify \
  --username [email protected] \
  --quota 10GB

user password

تغيير كلمة مرور المستخدم.

bash
sirrchatd user password \
  --username [email protected] \
  --new-password newpass

إدارة النطاقات

domain add

إضافة نطاق جديد.

bash
sirrchatd domain add --name example.com

domain delete

حذف نطاق.

bash
sirrchatd domain delete --name example.com

domain list

قائمة جميع النطاقات.

bash
sirrchatd domain list

إدارة التكوين

config init

إنشاء ملف تكوين افتراضي.

bash
sirrchatd config init > config.toml

config verify

التحقق من ملف التكوين.

bash
sirrchatd config verify

config get

الحصول على عنصر تكوين.

bash
sirrchatd config get server.hostname

config set

تعيين عنصر تكوين.

bash
sirrchatd config set server.hostname mail.example.com

إدارة DKIM

dkim generate

إنشاء زوج مفاتيح DKIM.

bash
sirrchatd dkim generate \
  --domain example.com \
  --selector default \
  --bits 2048

dkim show

عرض سجل المفتاح العام DKIM.

bash
sirrchatd dkim show --domain example.com

الإخراج:

أضف سجل TXT هذا إلى DNS الخاص بك:

default._domainkey.example.com. IN TXT "v=DKIM1; k=rsa; p=MIIBIjANBg..."

إدارة الحصص

quota get

عرض حصة المستخدم.

bash
sirrchatd quota get --user [email protected]

الإخراج:

المستخدم: [email protected]
الحصة: 5 GB
المستخدم: 1.23 GB (24.6%)
المتاح: 3.77 GB

quota set

تعيين حصة المستخدم.

bash
sirrchatd quota set \
  --user [email protected] \
  --quota 10GB

quota list

قائمة استخدام حصة جميع المستخدمين.

bash
sirrchatd quota list --sort-by used

النسخ الاحتياطي والاسترداد

backup create

إنشاء نسخة احتياطية.

bash
sirrchatd backup create \
  --output /backups/sirrchat-$(date +%Y%m%d).tar.gz \
  --compress

الخيارات:

bash
--user string        نسخ احتياطي لمستخدم محدد فقط
--domain string      نسخ احتياطي لنطاق محدد فقط
--exclude-attachments  استبعاد المرفقات

backup restore

استعادة نسخة احتياطية.

bash
sirrchatd backup restore \
  --input /backups/sirrchat-20250115.tar.gz

backup list

قائمة النسخ الاحتياطية المتاحة.

bash
sirrchatd backup list --path /backups

إدارة قاعدة البيانات

db migrate

تشغيل ترحيلات قاعدة البيانات.

bash
sirrchatd db migrate

db ping

اختبار اتصال قاعدة البيانات.

bash
sirrchatd db ping

db vacuum

تحسين قاعدة البيانات.

bash
sirrchatd db vacuum

إدارة التخزين

storage stats

عرض إحصائيات التخزين.

bash
sirrchatd storage stats

storage test

اختبار اتصال التخزين.

bash
sirrchatd storage test --type s3

storage migrate

ترحيل خلفية التخزين.

bash
sirrchatd storage migrate \
  --from local \
  --to s3

storage cleanup

تنظيف البيانات منتهية الصلاحية.

bash
sirrchatd storage cleanup \
  --older-than 2y \
  --dry-run

إدارة الوحدات

module list

قائمة جميع الوحدات.

bash
sirrchatd module list

module enable

تمكين وحدة.

bash
sirrchatd module enable spam-filter

module disable

تعطيل وحدة.

bash
sirrchatd module disable spam-filter

module reload

إعادة تحميل وحدة.

bash
sirrchatd module reload --name spam-filter

إدارة السجلات

logs view

عرض السجلات.

bash
sirrchatd logs view [flags]

الخيارات:

bash
--lines int          عدد الأسطر (افتراضي 100)
--follow, -f         متابعة السجلات في الوقت الفعلي
--level string       تصفية حسب مستوى السجل
--grep string        تصفية حسب الكلمة الرئيسية

أمثلة:

bash
sirrchatd logs view --lines 50 --level error
sirrchatd logs view --follow --grep "[email protected]"

أوامر المراقبة

stats

عرض إحصائيات الخادم.

bash
sirrchatd stats

الإخراج:

إحصائيات الخادم
-----------------
وقت التشغيل: 2d 5h 32m
إجمالي المستخدمين: 1,234
الجلسات النشطة: 42
الرسائل اليوم: 5,678
التخزين المستخدم: 125.5 GB

إحصائيات SMTP
---------------
المرسل: 2,345
المستلم: 3,333
المرفوض: 12

إحصائيات IMAP
---------------
الاتصالات النشطة: 42
الأوامر: 12,345

health

فحص الصحة.

bash
sirrchatd health

الإخراج:

✓ قاعدة البيانات: OK
✓ SMTP: OK
✓ IMAP: OK
✓ التخزين: OK
✓ الذاكرة: OK (45% مستخدم)
✓ القرص: OK (32% مستخدم)

أدوات التشخيص

diagnose

تشغيل فحوصات التشخيص.

bash
sirrchatd diagnose

test-smtp

اختبار وظائف SMTP.

bash
sirrchatd test-smtp \
  --from [email protected] \
  --to [email protected] \
  --subject "Test Email"

test-imap

اختبار وظائف IMAP.

bash
sirrchatd test-imap \
  --user [email protected] \
  --password pass

إكمال Shell

إنشاء نصوص إكمال shell.

Bash

bash
sirrchatd completion bash > /etc/bash_completion.d/sirrchatd

Zsh

bash
sirrchatd completion zsh > "${fpath[1]}/_sirrchatd"

Fish

bash
sirrchatd completion fish > ~/.config/fish/completions/sirrchatd.fish

متغيرات البيئة

bash
SIRRCHAT_CONFIG      مسار ملف التكوين
SIRRCHAT_DEBUG       تمكين وضع التصحيح
SIRRCHAT_LOG_LEVEL   مستوى السجل
SIRRCHAT_DATA_DIR    دليل البيانات

مزيد من المعلومات:

Released under the GPL 3.0 License.