> For the complete documentation index, see [llms.txt](https://overleaf-pro.ayaka.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://overleaf-pro.ayaka.space/on-premises/ar/albda/what-is-the-overleaf-toolkit.md).

# ما هي مجموعة أدوات Overleaf؟

تُعدّ Overleaf Toolkit طريقة النشر الموصى بها لعمليات التثبيت المحلية لـ Community Edition أو Server Pro أو Overleaf Pro، وقد صُمِّمت للعمل مع البيئة الأكثر شيوعًا: خادم مادي واحد أو آلة افتراضية واحدة. يستخدم Toolkit `docker compose` لإدارة حاويات Docker الخاصة بخادمك، ويوفّر مجموعة من البرامج النصية التي تُغلف `docker` الأوامر للمساعدة في الجانب الأكثر تقنيةً من إدارة إصدار محلي من Overleaf.

#### الـ `bin/docker-compose` غلاف

الـ `bin/docker-compose` البرنامج النصي هو غلاف حول `docker compose`. وهو يحمّل الإعدادات من `config/` الدليل، قبل استدعاء `docker compose` مع أي وسائط تم تمريرها إلى البرنامج النصي.

يمكنك اعتبار `bin/docker-compose` غلافًا شفافًا لـ `docker compose` البرنامج المثبّت على جهازك.

مثال:

{% code title="التحقق من الحاويات قيد التشغيل" %}

```bash
$ bin/docker-compose ps
```

{% endcode %}

#### أدوات مساعدة لتسهيل الاستخدام

بالإضافة إلى `bin/docker-compose`، يوفّر Toolkit برامج نصية مريحة للمساعدة في المهام الشائعة:

* `bin/up`: اختصار لـ `bin/docker-compose up`
* `bin/start`: اختصار لـ `bin/docker-compose start`
* `bin/stop`: اختصار لـ `bin/docker-compose stop`
* `bin/shell`: يفتح غلافًا داخل **sharelatex** الحاوية
* `bin/doctor`: برنامج نصي يُستخدم لجمع معلومات التثبيت والنشر. راجع قسم "التحقق من خادمك" أدناه
* `bin/mongo`: يفتح غلافًا داخل **mongo** الحاوية ويتحوّل إلى قاعدة البيانات الصحيحة (**sharelatex**)
* `bin/backup-config`: أنشئ نسخة (zip أو tar) من إعداداتك الحالية واحفظها في دليل وجهة من اختيارك
* `bin/logs`: عرض/تتبّع سجلات الخدمة
* `bin/error-logs`: عرض/تتبّع سجلات أخطاء الخدمة
* `bin/rename-env-vars-5-0`: برنامج ترحيل لتحديث متغيرات البيئة في **config/variables.env** (إعادة العلامة التجارية من ShareLaTeX إلى Overleaf)
* `bin/rename-rc-vars`: برنامج ترحيل لتحديث متغيرات البيئة في **config/overleaf.rc** (إعادة العلامة التجارية من ShareLaTeX إلى Overleaf)
* `bin/run-script`: أداة مساعدة لتبسيط تشغيل البرامج النصية المخزّنة داخل **sharelatex** الحاوية
* `bin/upgrade`: يساعد في ترقيات المثيل. سيتحقق البرنامج النصي من تحديثات Toolkit (عبر git) ويعرض سحب التغييرات، ويتحقق من أحدث إصدار لصورة Docker ويعرض تحديثها. يوفّر تأكيدًا خطوة بخطوة، وخيار نسخ الإعدادات الحالية احتياطيًا، ويتعامل مع إيقاف/بدء خدمات Docker. راجع ترقية النشر لديك لمزيد من المعلومات: <https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment>

{% hint style="info" %}
إذا كنت تفضّل تشغيل مثيلك دون الارتباط بسجلات Docker يمكنك تشغيل `bin/up -d` للعمل في الوضع المنفصل.
{% endhint %}

#### التحقق من خادمك

يتضمن Overleaf Toolkit برنامجًا نصيًا مفيدًا يُسمى `bin/doctor` ينتج تقريرًا يشير إلى أي تبعية غير مستوفاة.

قبل المتابعة، شغّل `bin/doctor` البرنامج النصي وتحقّق من أن كل شيء يعمل بشكل صحيح:

{% code title="تشغيل Overleaf Doctor" %}

```bash
bin/doctor
```

{% endcode %}

مثال على المخرجات (مقتطعة/توضيحية):

<details>

<summary>مخرجات نموذجية من bin/doctor</summary>

```
====== Overleaf Doctor ======
- معلومات المضيف
    - لينكس
    - مخرجات 'lsb_release -a':
            لا تتوفر أي وحدات LSB.
            معرّف الموزّع:     Ubuntu
            الوصف:        Ubuntu 22.04.5 LTS
            الإصدار:    22.04
            الاسم الرمزي:   jammy
- الاعتماديات
    - bash
        - الحالة: موجود
        - معلومات الإصدار: 5.1.16(1)-release
    - docker
        - الحالة: موجود
        - معلومات الإصدار: Docker version 27.3.1, build ce12230
    - realpath
        - الحالة: موجود
        - معلومات الإصدار: realpath (GNU coreutils) 8.32
    - perl
        - الحالة: موجود
        - معلومات الإصدار: 5.034000
    - awk
        - الحالة: موجود
        - معلومات الإصدار: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1)
    - openssl
        - الحالة: موجود
        - معلومات الإصدار: OpenSSL 3.0.2 15 Mar 2022 (Library: OpenSSL 3.0.2 15 Mar 2022)
    - docker compose
        - الحالة: موجود
        - معلومات الإصدار: Docker Compose version v2.29.7
- Docker Daemon
    - الحالة: قيد التشغيل
====== الإعدادات ======
- config/version
    - الحالة: موجود
    - الإصدار: 5.1.1
- config/overleaf.rc
    - الحالة: موجود
    - القيم
        - OVERLEAF_DATA_PATH: data/overleaf
        - OVERLEAF_LOG_PATH: data/overleaf/logs
        - SERVER_PRO: true
            - تم تسجيل الدخول إلى quay.io: true
        - SIBLING_CONTAINERS_ENABLED: true
        - OVERLEAF_LISTEN_IP: 0.0.0.0
        - OVERLEAF_PORT: 80
        - MONGO_ENABLED: true
        - MONGO_IMAGE: mongo
        - MONGO_VERSION: 6.0
        - MONGO_DATA_PATH: data/mongo
        - REDIS_ENABLED: true
        - REDIS_IMAGE: redis:6.2
        - REDIS_DATA_PATH: data/redis
- config/variables.env
    - الحالة: موجود
    - القيم
        - OVERLEAF_FILESTORE_BACKEND: fs
        - OVERLEAF_HISTORY_BACKEND: fs
====== التحذيرات ======
- لا يوجد، كل شيء جيد
====== النهاية ======
```

</details>

إذا كانت أي اعتماديات مفقودة، فسيطبع doctor تحذيرات. إذا واجهت مشاكل، فشغّل أولًا `bin/doctor` وتحقّق من مخرجاته بحثًا عن تحذيرات.

{% hint style="info" %}

* يجب على مستخدمي Community Edition المجانية فتح مشكلة على GitHub: <https://github.com/overleaf/toolkit/issues>
* يجب على مستخدمي Server Pro التواصل مع الدعم: mailto:<support+serverpro@overleaf.com>

في كلتا الحالتين، أدرج مخرجات `bin/doctor` في رسالتك.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://overleaf-pro.ayaka.space/on-premises/ar/albda/what-is-the-overleaf-toolkit.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.