> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# ما هي Ayakaleaf Toolkit؟

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

#### المغلِّف `bin/docker-compose`

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

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

مثال:

```bash title="Check running containers" theme={null}
$ bin/docker-compose ps
```

#### أدوات مساعدة مريحة

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

* `bin/up`: اختصار لـ `bin/docker-compose up`
* `bin/start`: اختصار لـ `bin/docker-compose start`
* `bin/stop`: اختصار لـ `bin/docker-compose stop`
* `bin/shell`: يفتح صدفة (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](https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment)

<Info>
  إذا كنت تفضّل تشغيل المثيل دون الارتباط بسجلات Docker، فيمكنك تشغيل `bin/up -d` للعمل في الوضع المنفصل (detached).
</Info>

#### فحص خادمك

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

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

```bash title="Run Overleaf Doctor" theme={null}
bin/doctor
```

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

<Accordion title="عينة من مخرجات bin/doctor">
  ```text theme={null}
  ====== Overleaf Doctor ======
  - Host Information
      - Linux
      - Output of 'lsb_release -a':
              No LSB modules are available.
              Distributor ID:     Ubuntu
              Description:        Ubuntu 22.04.5 LTS
              Release:    22.04
              Codename:   jammy
  - Dependencies
      - bash
          - status: present
          - version info: 5.1.16(1)-release
      - docker
          - status: present
          - version info: Docker version 27.3.1, build ce12230
      - realpath
          - status: present
          - version info: realpath (GNU coreutils) 8.32
      - perl
          - status: present
          - version info: 5.034000
      - awk
          - status: present
          - version info: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1)
      - openssl
          - status: present
          - version info: OpenSSL 3.0.2 15 Mar 2022 (Library: OpenSSL 3.0.2 15 Mar 2022)
      - docker compose
          - status: present
          - version info: Docker Compose version v2.29.7
  - Docker Daemon
      - status: up
  ====== Configuration ======
  - config/version
      - status: present
      - version: 5.1.1
  - config/overleaf.rc
      - status: present
      - values
          - OVERLEAF_DATA_PATH: data/overleaf
          - OVERLEAF_LOG_PATH: data/overleaf/logs
          - SERVER_PRO: true
              - logged in to 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
      - status: present
      - values
          - OVERLEAF_FILESTORE_BACKEND: fs
          - OVERLEAF_HISTORY_BACKEND: fs
  ====== Warnings ======
  - None, all good
  ====== End ======
  ```
</Accordion>

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

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

  في كلتا الحالتين، أرفق مخرجات `bin/doctor` في رسالتك.
</Info>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.