> 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/aldam/getting-help.md).

# الحصول على المساعدة

### أداة التشخيص

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

{% hint style="info" %}
يمكن لمستخدمي Overleaf Pro أن [يفتحوا مشكلة على GitHub](https://github.com/ayaka-notes/overleaf/issues).

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

### الاستعانة بأداة التشخيص <a href="#consulting-with-the-doctor" id="consulting-with-the-doctor"></a>

شغّل سكربت التشخيص:

{% code title="شغّل أداة التشخيص" %}

```bash
bin/doctor
```

{% endcode %}

سترى مخرجات مشابهة للمثال أدناه.

<details>

<summary>مثال على المخرجات الكاملة</summary>

```
====== Overleaf Doctor ======
- معلومات المضيف
    - Linux
    - ناتج الأمر 'lsb_release -a':
            لا توجد وحدات LSB متاحة.
            معرّف الموزّع:	Ubuntu
            الوصف:	Ubuntu 22.04.5 LTS
            الإصدار:	22.04
            الاسم الرمزي:	jammy
- الاعتماديات
    - bash
        - الحالة: موجود
        - معلومات الإصدار: 5.1.16(1)-release
    - docker
        - الحالة: موجود
        - معلومات الإصدار: Docker version 28.0.4, build b8034c0
    - docker compose
        - الحالة: موجود
        - معلومات الإصدار: Docker Compose version v2.34.0
    - realpath
        - الحالة: موجود
        - معلومات الإصدار: realpath (GNU coreutils) 8.32
    - perl
        - الحالة: موجود
        - معلومات الإصدار: 5.034000
    - awk
        - الحالة: موجود
        - معلومات الإصدار: mawk 1.3.4 20200120
- Docker Daemon
    - الحالة: قيد التشغيل
====== الإعدادات ======
- config/version
    - الحالة: موجود
    - الإصدار: 5.4.0
- config/overleaf.rc
    - الحالة: موجود
    - القيم
        - OVERLEAF_DATA_PATH: data/overleaf
        - OVERLEAF_LOG_PATH: data/overleaf/logs
        - SERVER_PRO: true
        - SIBLING_CONTAINERS_ENABLED: true
            - تسجيل الدخول إلى quay.io: true
        - MONGO_ENABLED: true
        - REDIS_ENABLED: true
- config/variables.env
    - الحالة: موجود
    - القيم
        - OVERLEAF_FILESTORE_BACKEND: fs
        - OVERLEAF_HISTORY_BACKEND: fs

====== التحذيرات ======
- لا توجد، كل شيء على ما يرام
====== النهاية ======
```

</details>

### معلومات المضيف

يجب أن يكون `معلومات المضيف` يحتوي هذا القسم على معلومات حول الجهاز الذي يشغّل Toolkit (على سبيل المثال، توزيعة Linux وإصدارها).

<details>

<summary>مثال على مخرجات معلومات المضيف</summary>

```
- معلومات المضيف
    - Linux
    - ناتج الأمر 'lsb_release -a':
            لا توجد وحدات LSB متاحة.
            معرّف الموزّع:	Ubuntu
            الوصف:	Ubuntu 22.04.5 LTS
            الإصدار:	22.04
            الاسم الرمزي:	jammy
```

</details>

### التبعيات

يجب أن يكون `التبعيات` يسرد هذا القسم الأدوات المطلوبة لعمل Toolkit. إذا كانت إحدى الأدوات موجودة فستُدرج على أنها `الحالة: موجود` مع معلومات الإصدار. وإذا كانت مفقودة فستُدرج على أنها `الحالة: مفقود!` وسيُضاف تحذير إلى أسفل `أداة التشخيص` المخرجات.

<details>

<summary>مثال على مخرجات التبعيات (موجود)</summary>

```
- docker
    - الحالة: موجود
    - معلومات الإصدار: Docker version 28.0.4, build b8034c0
```

</details>

<details>

<summary>مثال على مخرجات التبعيات (مفقود)</summary>

```
- docker
    - الحالة: مفقود!
```

</details>

إذا كانت أي من التبعيات مفقودة، فمن شبه المؤكد أن Toolkit لن يعمل.

### الإعدادات

يجب أن يكون `الإعدادات` يحتوي هذا القسم على معلومات حول الملفات في `الدليل config/` الدليل. بالنسبة إلى `config/overleaf.rc`، يطبع doctor بعض القيم الأساسية. وستُدرج الملفات المفقودة على أنها `الحالة: مفقود!` وسيُضاف تحذير إلى أسفل `أداة التشخيص` المخرجات.

<details>

<summary>مثال على مخرجات الإعداد</summary>

```
====== الإعدادات ======
- config/version
    - الحالة: موجود
    - الإصدار: 5.4.0
- config/overleaf.rc
    - الحالة: موجود
    - القيم
        - OVERLEAF_DATA_PATH: /tmp/overleaf
        - SERVER_PRO: false
        - MONGO_ENABLED: false
        - REDIS_ENABLED: true
- config/variables.env
    - الحالة: مفقود!
```

</details>

ملاحظات من المثال أعلاه:

* `OVERLEAF_DATA_PATH` مضبوطًا على `/tmp/overleaf` قد لا يكون موقعًا آمنًا للبيانات المهمة.
* `MONGO_ENABLED: false` يعني أن Toolkit لن يوفّر MongoDB خاصًا به؛ تأكّد من أن `MONGO_URL` يشير إلى MongoDB مُدار خارجيًا إذا لزم الأمر.
* `config/variables.env` مفقود في المثال.

### التحذيرات

يجب أن يكون `التحذيرات` يلخّص هذا القسم المشكلات التي اكتشفها السكربت doctor. إذا لم تكن هناك مشكلات، فسيشير هذا القسم إلى ذلك.

<details>

<summary>مثال على مخرجات التحذيرات</summary>

```
====== التحذيرات ======
- لم يتم العثور على ملف الإعدادات variables.env
- ملف rc، لم يتم تعيين OVERLEAF_DATA_PATH
====== النهاية =======
```

</details>


---

# 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/aldam/getting-help.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.