Zmienne środowiskowe

Na tej stronie opisano zmienne środowiskowe obsługiwane w pliku config/variables.env we wdrożeniach opartych na Toolkit.

Plik config/variables.env składa się z definicji zmiennych w postaci NAME=value; wiersze zaczynające się od # są traktowane jako komentarze.

Po wprowadzeniu jakichkolwiek zmian w overleaf.rc lub variables.env konieczne jest odtworzenie kontenerów Docker poprzez uruchomienie bin/up.

​

Wszystkie wersje

Te zmienne środowiskowe są zgodne z Server CE i Server Pro i zapewniają łatwą ścieżkę migracji między tymi dwiema wersjami lokalnymi. Można ich także używać zarówno we wdrożeniach Toolkit, jak i Docker Compose.

Wcześniej te zmienne środowiskowe miały prefiks SHARELATEX_ zamiast OVERLEAF_.

Nazwa	Opis
OVERLEAF_SITE_URL	Adres, pod którym Twoja instancja Overleaf jest publicznie dostępna. Jest używany w linkach publicznych oraz podczas łączenia przez websockety, dlatego musi być poprawnie skonfigurowany!
OVERLEAF_ADMIN_EMAIL	Adres e-mail, pod którym użytkownicy mogą skontaktować się z osobą zarządzającą witryną.
OVERLEAF_APP_NAME	Nazwa wyświetlana w odniesieniu do uruchomionej aplikacji. Domyślnie ‘Overleaf (Community Edition)’.
OVERLEAF_MONGO_URL i MONGO_URL	Adres URL bazy danych Mongo, która ma być używana.
OVERLEAF_REDIS_HOST i REDIS_HOST	Nazwa hosta instancji Redis, która ma być używana. Obie zmienne są wymagane (zobacz informacje o wydaniach).
OVERLEAF_REDIS_PORT i REDIS_PORT	Port instancji Redis, która ma być używana. Obie zmienne są wymagane (zobacz informacje o wydaniach).
OVERLEAF_REDIS_PASS i REDIS_PASSWORD	Hasło używane podczas łączenia z Redis (jeśli dotyczy). Należy ustawić obie zmienne środowiskowe. Więcej informacji znajdziesz w sekcji włączanie uwierzytelniania hasłem.
OVERLEAF_REDIS_TLS	Ustawienie na true umożliwia połączenie z instancją Redis wymagającą TLS. Uwaga: mTLS nie jest obecnie obsługiwany.
OVERLEAF_NAV_TITLE	Ustawia tytuł karty aplikacji.
OVERLEAF_HEADER_IMAGE_URL_LIGHT i OVERLEAF_HEADER_IMAGE_URL_DARK	Adresy URL własnych logo nagłówka dla motywu jasnego i ciemnego (dodane w 6.3.0). Jeśli zmienna dla danego motywu nie jest ustawiona, używana jest wartość OVERLEAF_HEADER_IMAGE_URL. Zobacz Branding.
OVERLEAF_LINKED_URL_OUTBOUND_PROXY	Adres URL serwera proxy HTTP(S) do pobierania zewnętrznych połączonych plików oraz zewnętrznych zasobów ZIP lub TeX za pośrednictwem API Open in Overleaf. Dostępne od ponownie wydanej wersji Ayakaleaf Pro 6.3.0 (3 października 2026). Pozostaw nieustawione, aby łączyć się bezpośrednio. Przykład: OVERLEAF_LINKED_URL_OUTBOUND_PROXY=http://proxy.internal:3128. Konfigurację i ograniczenia dostępu sieciowego opisano w sekcji Outbound Proxy.
OVERLEAF_INVITE_TOKEN_SECRET	Wymagana. Losowy ciąg znaków używany do zabezpieczania tokenów udostępniania projektów (dodane w Server Pro 6.2.0). Minimalna liczba znaków: 16
OVERLEAF_SESSION_SECRET	Losowy ciąg znaków używany do zabezpieczania tokenów; w przypadku równoważenia obciążenia musi mieć tę samą wartość na wszystkich maszynach. Jeśli uruchomiona jest tylko 1 instancja, użytkownik nie musi go ustawiać.
OVERLEAF_COOKIE_SESSION_LENGTH	Pozwala nadpisać domyślny czas wygaśnięcia ciasteczka sesji, wynoszący 5 dni. Wartość należy podać w milisekundach. Przykład: aby sesja trwała 1 godzinę, ustaw COOKIE_SESSION_LENGTH=3600000. (Dodane w Server Pro 4.2)
OVERLEAF_TRUSTED_PROXY_IPS	Jeśli nie jest ustawiona, domyślnie przyjmuje wartość loopback. W przypadku ręcznego ustawienia oprócz zaufanych adresów IP musisz również uwzględnić loopback (lub 127.0.0.1), co oznacza zaufanie dla instancji nginx działającej wewnątrz kontenera sharelatex. Akceptowane są wyłącznie adresy IP i zakresy CIDR: nie dodawaj nazw hostów, takich jak localhost, w przeciwnym razie Overleaf nie uruchomi się i zwróci 502 Bad Gateway. Jeśli w swojej zwykłej sieci używasz podsieci z zakresu 172.16.0.0/12 (domyślna podsieć sieci Docker), ustaw OVERLEAF_TRUSTED_PROXY_IPS=loopback,<network> w pliku config/variables.env, gdzie <network> to wartość IPAM -> Config -> Subnet z polecenia docker inspect overleaf_default, np. OVERLEAF_TRUSTED_PROXY_IPS=loopback,172.19.0.0/16. Zapobiega to podszywaniu się pod nagłówki X-Forwarded. Jeśli korzystasz z zewnętrznego proxy TLS (tzn. niezarządzanego przez Overleaf Toolkit), upewnij się, że OVERLEAF_TRUSTED_PROXY_IPS=loopback,<ip-of-your-tls-proxy>, np. OVERLEAF_TRUSTED_PROXY_IPS=loopback,192.168.13.37.
OVERLEAF_RESTRICT_INVITES_TO_EXISTING_ACCOUNTS	Ustawienie na true ogranicza zaproszenia do projektów do adresów e-mail odpowiadających istniejącym kontom użytkowników.
OVERLEAF_ALLOW_PUBLIC_ACCESS	Ustawienie na true pozwala nieuwierzytelnionym użytkownikom przeglądać witrynę. Wartość domyślna to false, co oznacza, że nieuwierzytelnieni użytkownicy będą bezwarunkowo przekierowywani na stronę logowania przy próbie wyświetlenia dowolnej części witryny. Uwaga: ustawienie tej opcji w żaden sposób nie wyłącza uwierzytelniania ani zabezpieczeń. Opcja ta jest niezbędna, jeśli użytkownicy zamierzają upubliczniać swoje projekty i udostępniać je do wglądu nieuwierzytelnionym użytkownikom.
OVERLEAF_ALLOW_ANONYMOUS_READ_AND_WRITE_SHARING	Ustawienie na true pozwala anonimowym użytkownikom przeglądać i edytować projekty udostępnione za pomocą funkcji udostępniania przez link.
OVERLEAF_DISABLE_LINK_SHARING	Wyłącza funkcję udostępniania przez link.
EMAIL_CONFIRMATION_DISABLED	Po ustawieniu na true baner z prośbą o potwierdzenie adresu e-mail nie będzie wyświetlany.
ADDITIONAL_TEXT_EXTENSIONS	Tablica ciągów znaków służąca do konfigurowania dodatkowych rozszerzeń plików edytowalnych.
DEFAULT_LATEX_COMPILER	Służy do ustawienia domyślnego kompilatora używanego przez nowe projekty. (Dodane w Server Pro 6.2.0). Opcje: pdflatex, latex, xelatex lub lualatex
OVERLEAF_STATUS_PAGE_URL	Adres URL własnej strony statusu (dodane w Server Pro 3.4.0), np. status.example.com.
OVERLEAF_FPH_INITIALIZE_NEW_PROJECTS	Ustaw na 'false', aby nowe projekty nie były inicjalizowane z pełną historią projektu (Full Project History) (dodane w Server Pro 3.5.0).
OVERLEAF_FPH_DISPLAY_NEW_PROJECTS	Ustaw na 'false', aby nowe projekty nie wyświetlały pełnej historii projektu (Full Project History) zamiast starszej historii (dodane w Server Pro 3.5.0).
ENABLE_CRON_RESOURCE_DELETION	Ustaw tę zmienną środowiskową na true, aby włączyć automatyczne usuwanie skasowanych projektów i użytkowników po 90 dniach.
OVERLEAF_USER_HARD_DELETION_DELAY	Służy do zmiany czasu, po którym usunięci użytkownicy są trwale kasowani. Wartość podawana w milisekundach. Domyślnie: 90 dni
OVERLEAF_PROJECT_HARD_DELETION_DELAY	Służy do zmiany czasu, po którym usunięte projekty są trwale kasowane. Wartość podawana w milisekundach. Domyślnie: 90 dni
MAX_UPLOAD_SIZE	Określa maksymalny rozmiar pojedynczego przesyłanego pliku w megabajtach. Domyślnie 50. Uwaga: Ta zmienna to sama liczba, bez jednostki (MB) ani żadnego opakowania. Łączny rozmiar przesłanego pliku .zip po rozpakowaniu jest ograniczony do 6 × tej wartości (domyślnie 300 MB).
COMPILE_SIZE_LIMIT	Określa maksymalny rozmiar treści żądania w bajtach. Jest to suma rozmiarów wszystkich plików dokumentów w projekcie (main.tex, references.bib (jeśli nie jest połączony) itp.), które muszą zostać wysłane w początkowym żądaniu kompilacji do usługi CLSI.
COMPILE_TIMEOUT	Czas w sekundach, w którym kompilacja musi się zakończyć. Więcej informacji znajdziesz w sekcji Aktualizacja limitu czasu kompilacji projektu.
MAX_RECONNECT_GRACEFULLY_INTERVAL_MS	Konfigurowalne opóźnienie między łagodnym ponownym połączeniem edytora, zapisem danych a zamknięciem kontenera, ograniczające ryzyko utraty danych.
SECCOMP_PROFILE	Ustaw tę zmienną środowiskową na ścieżkę na maszynie hosta Docker, wskazującą profil SECCOMP. Kopię profilu możesz pobrać tutaj. Obecnie wymagane we wdrożeniach Podman przy korzystaniu z Sandboxed Compiles.
OVERLEAF_DISABLE_CHAT	Ustawienie na true wyłącza czat w projekcie.
OVERLEAF_LOGIN_SUPPORT_TEXT	Po ustawieniu pozwala wyświetlać informacje o wsparciu pod przyciskiem logowania. Tekst będzie widoczny na ekranie logowania i może służyć do kierowania użytkowników do wewnętrznego wsparcia lub udzielania wskazówek dotyczących logowania, tworzenia kont itp.
ALLOW_MONGO_ADMIN_CHECK_FAILURES	Ustawienie na true pozwala, aby niepowodzenie testów startowych MongoDB nie blokowało uruchomienia wdrożenia. Może to być konieczne, jeśli korzystasz z bazy danych MongoDB, w której użytkownik bazy danych nie ma roli clusterParameterReader. Pomoc dotyczącą tworzenia własnej roli znajdziesz tutaj.
V1_HISTORY_URL_FOR_GIT_BRIDGE	Pozwala rozdzielić punkt końcowy history-v1 dla ruchu wewnętrznego (usługa web → usługa history-v1, obie w kontenerze sharelatex) i ruchu zewnętrznego (git-bridge → history-v1, działające w osobnych kontenerach).
OVERLEAF_MAINTENANCE_MESSAGE i OVERLEAF_MAINTENANCE_MESSAGE_HTML	Służą do dostosowania tytułu i treści strony prac serwisowych. Nie można ich używać razem z OVERLEAF_STATUS_PAGE_URL.

Przy korzystaniu z systemu logowania Overleaf (konta lokalne), a nie z opcji SSO, takiej jak LDAP, można wymuszać na użytkownikach ograniczenia dotyczące haseł. W przypadku kont SSO zasady haseł są egzekwowane przez dostawcę tożsamości lub usługę katalogową, co dodatkowo umożliwia obsługę uwierzytelniania wieloskładnikowego.