Ustawienia Toolkit - Ayakaleaf Pro

Ta strona opisuje zmienne środowiskowe obsługiwane w pliku config/overleaf.rc we wdrożeniach Toolkit. Plik config/overleaf.rc składa się z definicji zmiennych w postaci NAME=value. Wiersze zaczynające się od # są traktowane jako komentarze.

Po każdej zmianie w overleaf.rc lub variables.env konieczne jest odtworzenie kontenerów Docker poprzez uruchomienie bin/up.

Kontener

`sharelatex`

Nazwa	Opis
`PROJECT_NAME`	Ustawia wartość flagi `--project-name` przekazywanej do `docker-compose`. Jest to przydatne przy uruchamianiu wielu instancji Overleaf na jednym hoście, ponieważ każda instancja może mieć inną nazwę projektu. - Domyślnie: `overleaf`
`OVERLEAF_IMAGE_NAME`	Obraz Docker używany przez kontener aplikacji Server Pro/CE. Jest to tylko nazwa obrazu Docker; tag obrazu Docker jest pobierany z `config/version`. - Domyślnie: - Server Pro: `ghcr.io/ayaka-notes/overleaf-pro` - Community Edition: `sharelatex/sharelatex`
`SERVER_PRO`	Gdy ustawiono `true`, Toolkit używa obrazu Server Pro (`ghcr.io/ayaka-notes/overleaf-pro`) zamiast domyślnego obrazu Server CE (`sharelatex/sharelatex`). - Domyślnie: `false`
`GIT_BRIDGE_ENABLED`	Ustaw `true`, aby włączyć funkcję git-bridge (tylko Server Pro). Więcej informacji znajdziesz w dokumentacji użytkownika https://www.overleaf.com/learn/how-to/Git_integration. - Domyślnie: `false`
`GIT_BRIDGE_IMAGE`	Obraz Docker używany przez kontener git-bridge (tylko Server Pro). Jest to tylko nazwa obrazu Docker; tag obrazu Docker jest pobierany z `config/version`. - Domyślnie: `ghcr.io/ayaka-notes/overleaf-pro/git-bridge`
`GIT_BRIDGE_DATA_PATH`	Ustawia ścieżkę do katalogu, który zostanie zamontowany w kontenerze `git-bridge` (tylko Server Pro) i będzie używany do przechowywania repozytoriów git. Może to być pełna ścieżka (zaczynająca się od `/`) lub ścieżka względna wobec katalogu bazowego Toolkit.
`GIT_BRIDGE_LOG_LEVEL`	Konfiguruje poziom logowania kontenera `git-bridge`. Dostępne poziomy: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`. - Domyślnie: `INFO`
`SIBLING_CONTAINERS_ENABLED`	Gdy ustawiono `true`, Toolkit używa techniki Sibling Containers do kompilowania projektów w oddzielnych piaskownicach, z osobnym kontenerem Docker dla każdego projektu. Więcej informacji znajdziesz w dokumentacji <server-pro-only-configuration/sandboxed-compiles>. - Wymaga: `SERVER_PRO=true` - Domyślnie: `true`
`SIBLING_CONTAINERS_PULL`	Gdy ustawiono `true`, Toolkit przy użyciu polecenia `bin/up` automatycznie pobiera wszystkie obrazy TeX Live ustawione za pomocą `ALL_TEX_LIVE_DOCKER_IMAGES` w pliku config/variables.env. - Domyślnie: `true`
`DOCKER_SOCKET_PATH`	Ustawia ścieżkę do gniazda Docker na maszynie hosta (maszynie, na której działa Toolkit). Gdy `SIBLING_CONTAINERS_ENABLED` ma wartość `true`, gniazdo zostanie zamontowane w kontenerze, aby usługa kompilatora mogła uruchamiać nowe kontenery Docker na hoście. - Wymaga: `SIBLING_CONTAINERS_ENABLED=true` - Domyślnie: `/var/run/docker.sock`
`OVERLEAF_DATA_PATH`	Ustawia ścieżkę do katalogu, który zostanie zamontowany w głównym kontenerze `sharelatex` i będzie używany do przechowywania danych kompilacji. Może to być pełna ścieżka (zaczynająca się od `/`) lub ścieżka względna wobec katalogu bazowego Toolkit. - Domyślnie: `data/overleaf`
`OVERLEAF_LISTEN_IP`	Ustawia adres(y) IP hosta, na których kontener będzie nasłuchiwał. Na przykład, jeśli ustawiono `0.0.0.0`, interfejs webowy będzie dostępny pod dowolnym adresem IP hosta. Przy bezpośrednim dostępie do kontenera wartość `OVERLEAF_LISTEN_IP` musi być ustawiona na Twój publiczny adres IP. Ustawienie `OVERLEAF_LISTEN_IP` na `0.0.0.0` lub na zewnętrzny adres IP hosta zazwyczaj powoduje błędy przy jednoczesnym użyciu z . - Domyślnie: `127.0.0.1`
`OVERLEAF_PORT`	Ustawia port hosta, na którym kontener będzie nasłuchiwał. Na przykład, jeśli ustawiono `8099`, a `OVERLEAF_LISTEN_IP` ma wartość `127.0.0.1`, interfejs webowy będzie dostępny pod adresem `http://localhost:8099`. - Domyślnie: `80`
`OVERLEAF_LOG_PATH`	Ustawia ścieżkę do katalogu, który zostanie zamontowany w głównym kontenerze `sharelatex` i będzie używany do udostępniania logów aplikacji na hoście Docker. Może to być pełna ścieżka (zaczynająca się od `/`) lub ścieżka względna wobec katalogu bazowego Toolkit. Usuń ten wpis konfiguracji, aby wyłączyć montowanie (bind-mount). Jeśli nie jest ustawiony, logi zostaną utracone przy odtwarzaniu kontenera. Zobacz , aby uzyskać informacje o logowaniu. - Domyślnie: nieustawione

`mongo`

Nazwa	Opis
`MONGO_ENABLED`	Gdy ustawiono `true`, Toolkit tworzy kontener MongoDB, w którym działa baza danych. Gdy ustawiono `false`, ten kontener nie zostanie utworzony, a system użyje zamiast tego bazy danych MongoDB określonej przez `MONGO_URL`. - Domyślnie: `true`
`MONGO_URL`	Określa adres URL połączenia z MongoDB używany, gdy `MONGO_ENABLED` ma wartość `false`. - Domyślnie: nieustawione
`MONGO_DATA_PATH`	Ustawia ścieżkę do katalogu, który zostanie zamontowany w kontenerze `mongo` i będzie używany do przechowywania bazy danych MongoDB. Może to być pełna ścieżka (zaczynająca się od `/`) lub ścieżka względna wobec katalogu bazowego Toolkit. Ta opcja dotyczy tylko lokalnego kontenera `mongo`, tworzonego, gdy `MONGO_ENABLED` ma wartość `true`. - Domyślnie: `data/mongo`
`MONGO_IMAGE`	Obraz Docker używany przez kontener MongoDB. Jest to tylko nazwa obrazu Docker; tag obrazu Docker należy podać w `MONGO_VERSION` (patrz niżej). - Domyślnie: `mongo`
`MONGO_VERSION`	Wersja MongoDB używana przez kontener MongoDB. Wartość musi zaczynać się od głównej wersji MongoDB i kropki, np. `6.0` lub `6.0-with-suffix`. - Domyślnie: `6.0`

`redis`

Nazwa	Opis
`REDIS_ENABLED`	Gdy ustawiono `true`, Toolkit tworzy kontener Redis, w którym działa baza danych redis. Gdy ustawiono `false`, ten kontener nie zostanie utworzony, a system użyje zamiast tego bazy danych Redis określonej przez `REDIS_HOST` i `REDIS_PORT`. - Domyślnie: `true`
`REDIS_HOST`	Określa host Redis używany, gdy `REDIS_ENABLED` ma wartość `false`. - Domyślnie: nieustawione
`REDIS_PORT`	Określa port Redis używany, gdy `REDIS_ENABLED` ma wartość `false`. - Domyślnie: nieustawione
`REDIS_DATA_PATH`	Ustawia ścieżkę do katalogu, który zostanie zamontowany w kontenerze `redis` i będzie używany do przechowywania bazy danych Redis. Może to być pełna ścieżka (zaczynająca się od `/`) lub ścieżka względna wobec katalogu bazowego Toolkit. Ta opcja dotyczy tylko lokalnego kontenera `redis`, tworzonego, gdy `REDIS_ENABLED` ma wartość `true`. - Domyślnie: `data/redis`
`REDIS_AOF_PERSISTENCE`	Włącza trwałość AOF (Append Only File) dla Redis. Jest to zalecana konfiguracja trwałości Redis. Więcej szczegółów znajdziesz w sekcji <../../../maintenance/data-and-backups#aof-append-only-file> w <../../maintenance/data-and-backups>. - Domyślnie: `true`

`nginx`

Nazwa	Opis
`NGINX_ENABLED`	Gdy ustawiono `true`, Toolkit tworzy kontener NGINX pełniący funkcję proxy TLS. - Domyślnie: `false`
`NGINX_CONFIG_PATH`	Ścieżka do pliku konfiguracyjnego NGINX używanego przez proxy TLS. - Domyślnie: `config/nginx/nginx.conf`
`NGINX_TLS_LISTEN_IP`	Ustawia adres(y) IP hosta, na których kontener proxy TLS będzie nasłuchiwał połączeń HTTPS. Na przykład, jeśli ustawiono `0.0.0.0`, interfejs webowy HTTPS będzie dostępny pod dowolnym adresem IP hosta. Zazwyczaj należy tu ustawić zewnętrzny adres IP hosta. - Domyślnie: `127.0.1.1`
`NGINX_HTTP_LISTEN_IP`	Ustawia adres(y) IP hosta, na których kontener proxy TLS będzie nasłuchiwał w celu przekierowania HTTP. Na przykład, jeśli ustawiono `127.0.1.1`, połączenia HTTP do `127.0.1.1` będą przekierowywane do interfejsu webowego HTTPS. Zazwyczaj należy tu ustawić zewnętrzny adres IP hosta. Nie ustawiaj `0.0.0.0`, ponieważ zazwyczaj powoduje to konflikt z `OVERLEAF_LISTEN_IP`. - Domyślnie: `127.0.1.1`
`NGINX_HTTP_PORT`	Ustawia port hosta, na którym kontener proxy TLS będzie nasłuchiwał połączeń HTTP. - Domyślnie: `80`
`TLS_PORT`	Ustawia port hosta, na którym kontener proxy TLS będzie nasłuchiwał połączeń HTTPS. - Domyślnie: `443`
`TLS_PRIVATE_KEY_PATH`	Ścieżka do klucza prywatnego używanego przez proxy TLS. - Domyślnie: `config/nginx/certs/overleaf_key.pem`
`TLS_CERTIFICATE_PATH`	Ścieżka do publicznego certyfikatu używanego przez proxy TLS. - Domyślnie: `config/nginx/certs/overleaf_certificate.pem`

Ostatnia modyfikacja 5 października 2026