2. تعرّف على الـ Toolkit

​

جولة استكشافية

الآن بعد أن أصبحت لديك نسخة محلية من الـ Toolkit، لنلقِ نظرة على بنية المستودع باستخدام الأمر ls.

Run this

ls -l

يعرض الأمر ls -l قائمة مفصّلة طويلة بمحتويات المجلد، مع معلومات إضافية عن الملفات مثل الأذونات والملكية والحجم.

إذا تم الاستنساخ بنجاح، فيجب أن ترى شيئًا مشابهًا لما يلي:

drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 bin
-rw-r--r-- 1 fry fry  6465 Aug 30 14:16 CHANGELOG.md
drwxr-xr-x 2 fry fry  4096 Sep  6 12:43 config
drwxr-xr-x 5 fry fry  4096 Aug 30 14:22 data
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 doc
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 lib
-rw-r--r-- 1 fry fry 34520 Aug 30 14:16 LICENSE
-rw-r--r-- 1 fry fry  1178 Aug 30 14:16 README.md

توجد جميع ملفات الإعداد المملوكة للمستخدم في المجلد config/. هذا المجلد مستثنى من نظام التحكم في المراجعات git، لذا لن يتغير عند تحديث الـ Toolkit.

​

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

الاسم	الوصف
bin	يحتوي هذا المجلد على مجموعة من السكربتات التي تساعدك على إدارة نسخة خادم Overleaf الخاصة بك. يمكنك قراءة المزيد عن هذه السكربتات في قسم الأوامر أدناه.
config	يحتوي هذا المجلد على ملفات الإعداد المحلية الخاصة بك.
lib	يحتوي هذا المجلد على ملفات الإعداد الأساسية التي يستخدمها الـ Toolkit.
data	افتراضيًا، يحتوي هذا المجلد على موقع التخزين الخاص بـ MongoDb وRedis وOverleaf. لمزيد من المعلومات، راجع قسم البيانات الدائمة أدناه.

نوصي بعدم تعديل الملفات الموجودة خارج المجلد /config مباشرةً. بدلًا من ذلك، إذا احتجت إلى إجراء تغييرات، فيمكن تنفيذها عبر متغيرات البيئة المعيّنة في config/variables.env أو config/overleaf.rc.
على سبيل المثال، لتعيين صورة خدمة mongo، بدلًا من تحرير lib/docker-compose.mongo.yml مباشرةً، عيّن الصورة باستخدام متغير البيئة MONGO_IMAGE في config/overleaf.rc. لمزيد من المعلومات، راجع صفحة إعدادات الـ Toolkit.

لن يغيّر الـ Toolkit أي بيانات في المجلد config/ دون إذنك.

​

الأوامر

شغّل هذه السكربتات من مجلد Toolkit. يطبع كل منها خياراته باستخدام --help.

الأمر	ما يفعله
bin/init	ينشئ ملفات الإعدادات في config/ في المرة الأولى. يضيف bin/init --tls إعدادات وكيل NGINX TLS.
bin/up	ينشئ الحاويات ويشغّلها (bin/docker-compose up). أضف -d للتشغيل في الخلفية بدلًا من متابعة السجلات. شغّله بعد كل تغيير في config/: إذ يعيد إنشاء الحاويات التي تغيّرت إعداداتها.
bin/start	يعيد تشغيل الحاويات الموجودة (bin/docker-compose start). لا يطبّق تغييرات الإعدادات.
bin/stop	يوقف الحاويات ويحتفظ بها (bin/docker-compose stop).
bin/docker-compose	يشغّل docker compose باستخدام ملفات Toolkit، على سبيل المثال bin/docker-compose ps أو bin/docker-compose restart sharelatex.
bin/logs	يعرض سجلات خدمة واحدة أو أكثر أو يتابعها، على سبيل المثال bin/logs -f web.
bin/error-logs	مثل bin/logs، لكنه يعرض الأخطاء فقط.
bin/shell	يفتح صدفة (shell) داخل الحاوية sharelatex.
bin/mongo	يفتح صدفة MongoDB على قاعدة البيانات sharelatex.
bin/run-script	يشغّل سكربتًا مضمّنًا داخل الحاوية sharelatex.
bin/doctor	يفحص المضيف والإعدادات، ويطبع تقريرًا لمشاركته عند طلب المساعدة.
bin/images	يسرد صور Docker الخاصة بـ Overleaf على المضيف.
bin/backup-config	ينسخ المجلد config/ إلى موقع نسخ احتياطي (نسخ أو zip أو tar).
bin/upgrade	يحدّث Toolkit وصورة Overleaf خطوة بخطوة، راجع ترقية النشر.
bin/rename-env-vars-5-0، bin/rename-rc-vars	عمليات ترحيل لمرة واحدة لأسماء المتغيرات القديمة SHARELATEX_* إلى OVERLEAF_*.

عندما يعيد bin/up إنشاء حاوية، يُفقد كل ما تغيّر داخلها، على سبيل المثال الحزم المثبتة أو الملفات المعدّلة عبر bin/shell. لا يُحتفظ إلا بمجلدات البيانات (data/ افتراضيًا) وconfig/. أجرِ التغييرات الدائمة عبر config/variables.env أو config/overleaf.rc أو config/docker-compose.override.yml بدلًا من ذلك.

إذا كان كل تشغيل لـ bin/up يؤدي إلى تسجيل خروج جميع المستخدمين، فاضبط OVERLEAF_SESSION_SECRET. بدونه تُوقَّع ملفات تعريف ارتباط الجلسة بسر يُولَّد من جديد كلما أُعيد إنشاء الحاوية، راجع قسم الأسئلة والأجوبة في متغيرات البيئة.