مرجع الإعدادات

يُضبط EntityFlow بالكامل عبر متغيرات البيئة. تقبل المتغيرات المنطقية القيم 1 أو true أو yes أو on (دون تمييز بين الأحرف الكبيرة والصغيرة)؛ وأي قيمة أخرى تُعامَل على أنها خطأ.

النشر والترخيص

المتغير	القيمة الافتراضية	الغرض
`EF_DEPLOYMENT`	`self-host`	وضع النشر: `saas` أو `self-host`.
`EF_LICENSE_KEY`	—	مفتاح ترخيص موقَّع يعمل دون اتصال ويفتح إضافات الاستضافة الذاتية. تُصدِره SYILAB؛ انسخه من التراخيص في EntityFlow Hub الخاص بك.
`EF_LICENSE_CHECKIN_ENABLED`	`false`	تفعيل التحقق من الترخيص عبر الإنترنت اختياريًا.

EntityFlow Hub

المتغير	القيمة الافتراضية	الغرض
`EF_HUB_URL`	`https://hub.entityflow.dev`	الوجهة التي ترسل إليها قائمة الحساب (إدارة الحساب) ومطالبات الترقية الأشخاصَ — EntityFlow Hub الخاص بك.
`EF_OFFICE_KEY`	—	اختياري، من 24 حرفًا أو أكثر. يفعّل واجهة API الخاصة بالمنصّة التي يستخدمها EntityFlow Office وEntityFlow Hub لإدارة هذه النسخة. عند عدم ضبطه، لا توجد هذه الواجهة (إذ تُرجع `404`).

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

المتغير	القيمة الافتراضية	الغرض
`EF_DIAGRAM_DB_URL`	— (مطلوب)	سلسلة الاتصال الخاصة بطبقة المخططات.
`DATABASE_URL`	—	اسم بديل لـ `EF_DIAGRAM_DB_URL`.
`EF_CONTROL_DB_URL`	—	طبقة التحكم في PostgreSQL؛ مطلوبة عندما لا تكون قاعدة بيانات المخططات هي Postgres.
`EF_DB_POOL_MAX`	`10`	الحد الأقصى لاتصالات تجمّع قاعدة البيانات.
`EF_DB_MIGRATE_ON_BOOT`	`true`	تشغيل عمليات الترحيل تلقائيًا عند بدء التشغيل.

الشبكة

المتغير	القيمة الافتراضية	الغرض
`EF_PORT`	`8787`	منفذ HTTP (tRPC + REST).
`EF_WS_PORT`	`8788`	منفذ websocket الخاص بـ Hocuspocus.
`EF_AUTH_BASE_URL`	`http://localhost:8787`	عنوان URL الأساسي العام المستخدَم لعمليات استدعاء المصادقة.
`EF_WEB_ORIGIN`	`http://localhost:5173`	أصل الويب المسموح به (CORS).

المصادقة وتعدد المستأجرين

المتغير	القيمة الافتراضية	الغرض
`EF_AUTH_SECRET`	—	مطلوب في بيئة الإنتاج؛ سر جلسة من 32 حرفًا أو أكثر.
`EF_AUTH_RP_ID`	`localhost`	معرّف الطرف المعتمِد لمفاتيح المرور/WebAuthn.
`EF_PG_RLS`	`false`	تفعيل الأمان على مستوى الصف في PostgreSQL.

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

يتم تسجيل الدخول دون كلمة مرور: يرسل EntityFlow رمزًا لمرة واحدة عبر البريد الإلكتروني إلى كل من يسجّل الدخول. لذلك تحتاج النسخة ذاتية الاستضافة إلى وسيلة لإرسال البريد الإلكتروني قبل أن يتمكّن الأشخاص من تسجيل الدخول.

المتغير	القيمة الافتراضية	الغرض
`EF_MAIL_PROVIDER`	—	`smtp` أو `resend` أو `mailjet` أو `log`. عند عدم ضبطه، تُستخدم أول وسيلة إرسال مُهيَّأة.
`EF_MAIL_FROM`	—	عنوان المُرسِل.
`EF_MAIL_FROM_NAME`	—	اسم العرض للمُرسِل.
`EF_SMTP_HOST`	—	مضيف خادم SMTP.
`EF_SMTP_PORT`	`587`	منفذ خادم SMTP.
`EF_SMTP_USER`	—	اسم مستخدم SMTP.
`EF_SMTP_PASSWORD`	—	كلمة مرور SMTP.
`EF_SMTP_SECURE`	`false`	`true` لاستخدام TLS الضمني (المنفذ 465)؛ وإلا فيُستخدم STARTTLS.
`EF_RESEND_API_KEY`	—	مفتاح API الخاص بـ Resend.
`EF_MAILJET_API_KEY`	—	مفتاح API الخاص بـ Mailjet.
`EF_MAILJET_SECRET_KEY`	—	المفتاح السري الخاص بـ Mailjet.

export EF_MAIL_PROVIDER=smtp
export EF_MAIL_FROM="entityflow@acme.com"
export EF_MAIL_FROM_NAME="EntityFlow"
export EF_SMTP_HOST="smtp.acme.com"
export EF_SMTP_PORT=587
export EF_SMTP_USER="entityflow"
export EF_SMTP_PASSWORD="<smtp-password>"

:::info الإعدادات المحفوظة لها الأولوية تتقدّم إعدادات البريد الإلكتروني المحفوظة في قاعدة البيانات (بواسطة EntityFlow Office) على هذه المتغيرات. :::

:::warning log مخصّص للتطوير فقط مع EF_MAIL_PROVIDER=log، لا يُرسَل أي شيء: تُكتب رسائل البريد الإلكتروني — بما فيها رموز تسجيل الدخول — في سجل الخادم. لا تستخدمه إلا على جهاز تطوير. :::

الوقت الفعلي

المتغير	القيمة الافتراضية	الغرض
`EF_COLLAB_DEBOUNCE_MS`	`2000`	نافذة منع الارتداد لحفظ تحديثات CRDT.
`EF_COLLAB_MAX_DEBOUNCE_MS`	`10000`	الحد الأقصى لمنع الارتداد قبل التفريغ القسري.
`EF_COLLAB_ALLOW_ANONYMOUS`	`false`	السماح بالتعاون دون مصادقة (للعرض التوضيحي فقط).
`EF_REALTIME_REDIS_ENABLED`	`false`	تفعيل توزيع Redis للعقد المتعددة.
`EF_REALTIME_REDIS_URL`	—	سلسلة اتصال Redis.
`EF_REALTIME_REDIS_PREFIX`	`ef`	بادئة المفتاح لقنوات Redis.

القابلية للملاحظة

المتغير	القيمة الافتراضية	الغرض
`EF_OTEL_ENABLED`	`false`	تفعيل التتبع عبر OpenTelemetry.
`EF_OTEL_EXPORTER_OTLP_ENDPOINT`	—	نقطة نهاية مجمِّع OTLP.
`EF_OTEL_SERVICE_NAME`	`ef-server`	اسم الخدمة المُبلَّغ عنه في عمليات التتبع.
`EF_SENTRY_DSN`	—	معرّف DSN الخاص بـ Sentry للإبلاغ عن الأخطاء.
`EF_LOG_LEVEL`	`info`	مستوى السجل (`fatal`–`trace`، أو `silent`).

دورة الحياة وخطافات الويب

المتغير	القيمة الافتراضية	الغرض
`EF_TRIAL_DAYS`	`14`	مدة الفترة التجريبية بالأيام.
`EF_RETENTION_DAYS`	`30`	نافذة الاحتفاظ بالبيانات المحذوفة حذفًا مؤقتًا.
`EF_SUSPENDED_READONLY`	`true`	يصبح المستأجرون المُعلَّقون للقراءة فقط بدلًا من حظرهم.
`EF_WEBHOOK_ALLOW_HTTP`	`false`	السماح بوجهات خطاف ويب عبر HTTP غير المشفَّر.

أداة الاستيراد

المتغير	القيمة الافتراضية	الغرض
`EF_DB_CONNECT_BLOCK_PRIVATE`	`false`	منع أداة الاستيراد من الاتصال بالمضيفين الخاصين/مضيفي الاسترجاع المحلي.
`EF_CONNECTION_ENC_KEY`	—	مفتاح AES-256 بترميز Base64 يُفعِّل خزنة الاتصالات المحفوظة.

warning

في بيئة الإنتاج، يجب ضبط EF_AUTH_SECRET، ويجب إعداد وسيلة لإرسال البريد الإلكتروني حتى يتمكّن الأشخاص من تسجيل الدخول.

راجع استخدم قاعدة بياناتك الخاصة واستخدم مزوّد الهوية الخاص بك للإعداد الخاص بالمحرك والمصادقة.

النشر والترخيص​

EntityFlow Hub​

قاعدة البيانات​

الشبكة​

المصادقة وتعدد المستأجرين​

البريد الإلكتروني​

الوقت الفعلي​

القابلية للملاحظة​

دورة الحياة وخطافات الويب​

أداة الاستيراد​