> 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/aliadadat/overleaf-toolkit/tls-proxy.md).

# وكيل TLS

وكيل TLS اختياري لإنهاء اتصالات HTTPS، باستخدام NGINX.

شغّل `bin/init --tls` لتهيئة الإعداد المحلي مع إعدادات وكيل NGINX، أو لإضافة إعدادات وكيل NGINX إلى إعداد محلي موجود. A **مثال** يتم إنشاء المفتاح الخاص في `config/nginx/certs/overleaf_key.pem` و **وهمي** شهادة في `config/nginx/certs/overleaf_certificate.pem`. إما استبدلها بمفتاحك الخاص الفعلي وشهادتك، أو عيّن قيم `TLS_PRIVATE_KEY_PATH` و `TLS_CERTIFICATE_PATH` المتغيرات إلى مسارات المفتاح الخاص الفعلي والشهادة الفعلية على التوالي.

يتم توفير إعداد افتراضي لـ NGINX في `config/nginx/nginx.conf` والذي يمكن تخصيصه وفقًا لمتطلباتك. يمكن تغيير مسار ملف الإعداد باستخدام `NGINX_CONFIG_PATH` المتغير.

{% hint style="success" %}
إذا كان لديك **docker-compose.yml** نشر قائم على، أو تدير وكيلًا عكسيًا خاصًا بك لـ NGINX، يمكنك عرض مثال **nginx.conf** الملف [هنا](https://github.com/overleaf/toolkit/blob/master/lib/config-seed/nginx.conf).
{% endhint %}

أضف القسم التالي إلى `config/overleaf.rc` الملف إذا لم يكن موجودًا بالفعل:

```
# إعداد وكيل TLS (اختياري)
NGINX_ENABLED=false
NGINX_CONFIG_PATH=config/nginx/nginx.conf
NGINX_HTTP_PORT=80

# استبدل عناوين IP هذه بعنوان IP الخارجي للمضيف
NGINX_HTTP_LISTEN_IP=127.0.1.1 
NGINX_TLS_LISTEN_IP=127.0.1.1
TLS_PRIVATE_KEY_PATH=config/nginx/certs/overleaf_key.pem
TLS_CERTIFICATE_PATH=config/nginx/certs/overleaf_certificate.pem
TLS_PORT=443
```

{% hint style="danger" %}
إذا كنت تستخدم وكيل TLS خارجيًا (أي لا تديره حزمة أدوات Overleaf)، فيرجى التأكد من أن `OVERLEAF_TRUSTED_PROXY_IPS=loopback,<ip-of-your-tls-proxy>` مُعيّن في `config/variables.env`، على سبيل المثال `OVERLEAF_TRUSTED_PROXY_IPS=loopback,192.168.13.37`.
{% endhint %}

{% hint style="danger" %}
إذا كنت تستخدم شبكة فرعية من `172.16.0.0/12` (الشبكة الفرعية الافتراضية لشبكات Docker) لشبكتك المحلية، فستحتاج إلى تعيين `OVERLEAF_TRUSTED_PROXY_IPS=loopback,<network>` في `config/variables.env`ملفك. حيث إن `<network>` هو `IPAM -> Config -> Subnet` القيمة في `docker inspect overleaf_default`، على سبيل المثال `OVERLEAF_TRUSTED_PROXY_IPS=loopback,172.19.0.0/16`. وذلك لمنع انتحال `X-Forwarded` الرؤوس.
{% endhint %}

{% hint style="info" %}
إذا كان `OVERLEAF_TRUSTED_PROXY_IPS` غير مُعيّن يدويًا، فسيكون افتراضيًا `loopback`. إذا قمت بالتعيين يدويًا، فيجب التأكد من تضمين أحد `loopback`, `localhost` أو `127.0.0.1`، والذي يثق في **nginx** المثيل الذي يعمل داخل **sharelatex** الحاوية.
{% endhint %}

لتشغيل الوكيل، غيّر قيمة `NGINX_ENABLED` المتغير في `config/overleaf.rc` المرسل `false` إلى `true` وأعد تشغيل `bin/up`.

بشكل افتراضي، ستكون واجهة الويب HTTPS متاحة على `https://127.0.1.1:443`. الاتصالات إلى `http://127.0.1.1:80` سيتم إعادة توجيهها إلى `https://127.0.1.1:443`. لتغيير عنوان IP الذي يستمع عليه NGINX، عيّن `NGINX_HTTP_LISTEN_IP` و `NGINX_TLS_LISTEN_IP` المتغيرات. ويمكن تغيير المنافذ عبر `NGINX_HTTP_PORT` و `TLS_PORT` المتغيرات.

إذا فشل NGINX في البدء مع رسالة الخطأ `خطأ بدء وكيل userland: listen tcp4 ... bind: العنوان مستخدم بالفعل` تأكد من أن `OVERLEAF_LISTEN_IP:OVERLEAF_PORT` لا يتداخل مع `NGINX_HTTP_LISTEN_IP:NGINX_HTTP_PORT`.

{% @mermaid/diagram content="sequenceDiagram
participant user as User
participant external as Host External
participant internal as Host Internal
participant nginx as nginx
participant sharelatex as sharelatex
participant git-bridge as git-bridge
%% User connects to external host HTTP
user->>+ external: HTTP
note over external: NGINX\_HTTP\_LISTEN\_IP:NGINX\_HTTP\_PORT
external->>+ nginx: HTTP
note over nginx: nginx:80
nginx-->>-external: 301
%% User connects to external host HTTPS
user->>+ external: HTTPS
note over external: NGINX\_TLS\_LISTEN\_IP:TLS\_PORT
external->>+ nginx: HTTPS
note over nginx: nginx:443
nginx->>+ sharelatex: HTTP
note over sharelatex: sharlatex:80
%% User connects to localhost HTTP
user->>+ internal: HTTP
note over internal: OVERLEAF\_LISTEN\_IP:OVERLEAF\_PORT
internal->>+sharelatex: HTTP
note over sharelatex: sharlatex:80
%% sharelatex connects to git-bridge
sharelatex->>+git-bridge: HTTP /git/
note over git-bridge: git-bridge:8000
note over sharelatex: GIT\_BRIDGE\_HOST:GIT\_BRIDGE\_PORT
git-bridge->>+sharelatex: WEB/WEB-API:3000
git-bridge->>+sharelatex: HISTORY-V1:3100" %}


---

# 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/aliadadat/overleaf-toolkit/tls-proxy.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.