> For the complete documentation index, see [llms.txt](https://ayakaleaf-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://ayakaleaf-pro.ayaka.space/on-premises/ar/albda/what-is-the-overleaf-toolkit.md).

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

مجموعة أدوات ayakaleaf هي طريقة النشر الموصى بها لعمليات التثبيت المحلية من Community Edition وAyakaleaf Pro، وقد صُممت للعمل مع أكثر البيئات شيوعًا: خادم فعلي واحد أو آلة افتراضية واحدة. تستخدم مجموعة الأدوات `docker compose` لإدارة حاويات Docker الخاصة بخادمك، وتوفّر مجموعة من السكربتات التي تغلّف `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`، توفّر مجموعة الأدوات سكربتات مفيدة للمساعدة في المهام الشائعة:

* `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`: يساعد في ترقية المثيل. سيتحقق السكربت من تحديثات مجموعة الأدوات (عبر git) ويعرض جلب التغييرات، ويتحقق من أحدث إصدار لصورة Docker ويعرض تحديثها. ويوفّر تأكيدًا خطوة بخطوة، وخيار نسخ الإعدادات الحالية احتياطيًا، ويتولى إيقاف/تشغيل خدمات Docker. راجع ترقية النشر لديك لمزيد من المعلومات: <https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment>

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

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

تتضمن مجموعة أدوات Overleaf سكربتًا مفيدًا يُسمى `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 (المكتبة: OpenSSL 3.0.2 15 Mar 2022)
    - docker compose
        - الحالة: موجود
        - معلومات الإصدار: Docker Compose version v2.29.7
- خادم Docker الخفي
    - الحالة: يعمل
====== الإعدادات ======
- 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" %}

* يمكن لمستخدمي نسخة Ayakaleaf Pro فتح مشكلة على GitHub: <https://github.com/ayaka-notes/toolkit/issues>

في كلتا الحالتين، أدرج مخرجات `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://ayakaleaf-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.