Proměnné prostředí

Tato stránka popisuje proměnné prostředí, které jsou podporovány v souboru config/variables.env při nasazení pomocí Toolkitu.

Soubor config/variables.env se skládá z definic proměnných ve tvaru NAME=value; řádky začínající znakem # jsou považovány za komentáře.

Po jakékoli změně v overleaf.rc nebo variables.env je nutné znovu vytvořit Docker kontejnery spuštěním bin/up.

​

Všechny verze

Tyto proměnné prostředí jsou kompatibilní se Server CE i Server Pro a umožňují snadnou migraci mezi těmito dvěma on-premise verzemi. Lze je také používat jak při nasazení pomocí Toolkitu, tak pomocí Docker Compose.

Dříve měly tyto proměnné prostředí místo předpony OVERLEAF_ předponu SHARELATEX_.

Název	Popis
OVERLEAF_SITE_URL	Adresa, na které je vaše instance Overleafu veřejně dostupná. Používá se ve veřejných odkazech a při připojování přes websockety, proto musí být nakonfigurována správně!
OVERLEAF_ADMIN_EMAIL	E-mailová adresa, na které mohou uživatelé kontaktovat provozovatele webu.
OVERLEAF_APP_NAME	Název, který se zobrazuje při zmínkách o běžící aplikaci. Výchozí hodnota je ‘Overleaf (Community Edition)’.
OVERLEAF_MONGO_URL a MONGO_URL	URL databáze Mongo, která se má použít.
OVERLEAF_REDIS_HOST a REDIS_HOST	Název hostitele instance Redis, která se má použít. Obě proměnné jsou povinné (viz poznámky k vydání).
OVERLEAF_REDIS_PORT a REDIS_PORT	Port instance Redis, která se má použít. Obě proměnné jsou povinné (viz poznámky k vydání).
OVERLEAF_REDIS_PASS a REDIS_PASSWORD	Heslo pro připojení k Redisu (je-li potřeba). Je nutné nastavit obě proměnné prostředí. Další informace najdete v části povolení ověřování heslem.
OVERLEAF_REDIS_TLS	Pokud je nastaveno na true, umožňuje připojení k instanci Redis vyžadující TLS. Poznámka: mTLS není v současnosti podporováno.
OVERLEAF_NAV_TITLE	Nastavuje titulek karty aplikace.
OVERLEAF_HEADER_IMAGE_URL_LIGHT a OVERLEAF_HEADER_IMAGE_URL_DARK	URL vlastních log v záhlaví pro světlý a tmavý motiv (přidáno ve verzi 6.3.0). Pokud není proměnná pro daný motiv nastavena, použije se OVERLEAF_HEADER_IMAGE_URL. Viz Branding.
OVERLEAF_LINKED_URL_OUTBOUND_PROXY	URL proxy HTTP(S) pro stahování externích propojených souborů a externích ZIP nebo TeX zdrojů přes API Open in Overleaf. K dispozici od znovu vydané verze Ayakaleaf Pro 6.3.0 (3. října 2026). Pro přímé připojení ponechte nenastavené. Příklad: OVERLEAF_LINKED_URL_OUTBOUND_PROXY=http://proxy.internal:3128. Konfiguraci a omezení síťového přístupu najdete v části Outbound Proxy.
OVERLEAF_INVITE_TOKEN_SECRET	Povinné. Náhodný řetězec používaný k zabezpečení tokenů pro sdílení projektů (přidáno v Server Pro 6.2.0). Minimální počet znaků: 16
OVERLEAF_SESSION_SECRET	Náhodný řetězec používaný k zabezpečení tokenů; při vyvažování zátěže musí být na všech strojích nastaven na stejnou hodnotu. Pokud běží pouze 1 instance, uživatel jej nastavovat nemusí.
OVERLEAF_COOKIE_SESSION_LENGTH	Umožňuje přepsat výchozí dobu platnosti session cookie, která je 5 dní. Hodnota se zadává v milisekundách. Příklad: aby relace trvala 1 hodinu, nastavte COOKIE_SESSION_LENGTH=3600000. (Přidáno v Server Pro 4.2)
OVERLEAF_TRUSTED_PROXY_IPS	Pokud není nastaveno, výchozí hodnota je loopback. Pokud ji nastavujete ručně, musíte kromě svých důvěryhodných IP adres uvést také loopback (nebo 127.0.0.1), čímž se důvěřuje instanci nginx běžící uvnitř kontejneru sharelatex. Přijímány jsou pouze IP adresy a rozsahy CIDR: nepřidávejte názvy hostitelů jako localhost, jinak se Overleaf nespustí a vrátí 502 Bad Gateway. Pokud pro svou běžnou síť používáte podsíť z rozsahu 172.16.0.0/12 (výchozí podsíť pro sítě Dockeru), nastavte prosím v config/variables.env hodnotu OVERLEAF_TRUSTED_PROXY_IPS=loopback,<network>, kde <network> je hodnota IPAM -> Config -> Subnet z výstupu docker inspect overleaf_default, např. OVERLEAF_TRUSTED_PROXY_IPS=loopback,172.19.0.0/16. Zabrání se tím podvrhování hlaviček X-Forwarded. Pokud používáte externí TLS proxy (tj. nespravovanou Overleaf Toolkitem), zajistěte, aby platilo OVERLEAF_TRUSTED_PROXY_IPS=loopback,<ip-of-your-tls-proxy>, např. OVERLEAF_TRUSTED_PROXY_IPS=loopback,192.168.13.37.
OVERLEAF_RESTRICT_INVITES_TO_EXISTING_ACCOUNTS	Pokud je nastaveno na true, omezí pozvánky do projektů na e-mailové adresy odpovídající existujícím uživatelským účtům.
OVERLEAF_ALLOW_PUBLIC_ACCESS	Pokud je nastaveno na true, umožní neověřeným uživatelům prohlížet web. Výchozí hodnota je false, což znamená, že neověření uživatelé budou při pokusu o zobrazení jakékoli části webu bezpodmínečně přesměrováni na přihlašovací stránku. Upozorňujeme, že nastavení této volby nijak nevypíná autentizaci ani zabezpečení. Tato volba je nutná, pokud vaši uživatelé chtějí zveřejňovat své projekty a umožnit jejich prohlížení neověřeným uživatelům.
OVERLEAF_ALLOW_ANONYMOUS_READ_AND_WRITE_SHARING	Pokud je nastaveno na true, umožní anonymním uživatelům prohlížet a upravovat projekty sdílené pomocí funkce sdílení odkazem.
OVERLEAF_DISABLE_LINK_SHARING	Vypne funkci sdílení odkazem.
EMAIL_CONFIRMATION_DISABLED	Pokud je nastaveno na true, nebude se zobrazovat banner s výzvou k potvrzení e-mailu.
ADDITIONAL_TEXT_EXTENSIONS	Pole řetězců pro konfiguraci dalších přípon upravitelných souborů.
DEFAULT_LATEX_COMPILER	Slouží k nastavení výchozího kompilátoru používaného novými projekty. (Přidáno v Server Pro 6.2.0). Možnosti: pdflatex, latex, xelatex nebo lualatex
OVERLEAF_STATUS_PAGE_URL	URL vlastní stavové stránky (přidáno v Server Pro 3.4.0), např. status.example.com.
OVERLEAF_FPH_INITIALIZE_NEW_PROJECTS	Nastavte na 'false', aby se nové projekty neinicializovaly s úplnou historií projektu (Full Project History) (přidáno v Server Pro 3.5.0).
OVERLEAF_FPH_DISPLAY_NEW_PROJECTS	Nastavte na 'false', aby nové projekty nezobrazovaly úplnou historii projektu (Full Project History) místo starší historie (přidáno v Server Pro 3.5.0).
ENABLE_CRON_RESOURCE_DELETION	Nastavte tuto proměnnou prostředí na true, chcete-li povolit automatické odstraňování smazaných projektů a uživatelů po 90 dnech.
OVERLEAF_USER_HARD_DELETION_DELAY	Slouží ke změně doby, po které vyprší smazaní uživatelé. Zadává se v milisekundách. Výchozí hodnota: 90 dní
OVERLEAF_PROJECT_HARD_DELETION_DELAY	Slouží ke změně doby, po které vyprší smazané projekty. Zadává se v milisekundách. Výchozí hodnota: 90 dní
MAX_UPLOAD_SIZE	Určuje maximální velikost jednoho nahrávaného souboru v megabajtech. Výchozí hodnota je 50. Pozor: Tato proměnná je pouze holé číslo, bez jednotky (MB) či jiného obalu. Celková nekomprimovaná velikost nahraného souboru .zip je omezena na 6 × tuto hodnotu (ve výchozím stavu 300 MB).
COMPILE_SIZE_LIMIT	Určuje maximální velikost těla požadavku v bajtech. Jde o součet velikostí všech dokumentových souborů v projektu (main.tex, references.bib (pokud není propojen) atd.), které je nutné odeslat v úvodním požadavku na kompilaci službě CLSI.
COMPILE_TIMEOUT	Doba v sekundách, během níž musí být kompilace dokončena. Další informace najdete v části Aktualizace časového limitu kompilace projektu.
MAX_RECONNECT_GRACEFULLY_INTERVAL_MS	Konfigurovatelná prodleva mezi řádným opětovným připojením editoru, zápisem dat a vypnutím kontejneru, která zmírňuje riziko ztráty dat.
SECCOMP_PROFILE	Nastavte tuto proměnnou prostředí na cestu na hostitelském stroji Dockeru, která ukazuje na profil SECCOMP. Kopii profilu si můžete stáhnout zde. V současnosti je potřeba pro nasazení s Podmanem při použití Sandboxed Compiles.
OVERLEAF_DISABLE_CHAT	Pokud je nastaveno na true, vypne funkci chatu v projektu.
OVERLEAF_LOGIN_SUPPORT_TEXT	Pokud je nastaveno, lze jím pod tlačítkem přihlášení zobrazit informace o podpoře. Text se zobrazí na přihlašovací obrazovce a lze jej využít k nasměrování uživatelů na interní podporu nebo k poskytnutí pokynů k přihlašování, vytváření účtů atd.
ALLOW_MONGO_ADMIN_CHECK_FAILURES	Pokud je nastaveno na true, umožní, aby kontroly MongoDB při spuštění selhaly, aniž by zabránily spuštění nasazení. To může být nutné, pokud používáte databázi MongoDB, v níž uživatel databáze nemá roli clusterParameterReader. Nápovědu k vytvoření vlastní role najdete zde.
V1_HISTORY_URL_FOR_GIT_BRIDGE	Umožňuje oddělit endpoint history-v1 pro interní provoz (služba web → služba history-v1, obě v kontejneru sharelatex) a externí provoz (git-bridge → history-v1, běžící v samostatných kontejnerech).
OVERLEAF_MAINTENANCE_MESSAGE a OVERLEAF_MAINTENANCE_MESSAGE_HTML	Slouží k přizpůsobení názvu a obsahu stránky údržby. Nelze je použít společně s OVERLEAF_STATUS_PAGE_URL.

Při použití přihlašovacího systému Overleafu (lokální účty), nikoli SSO možnosti jako LDAP, je možné uživatelům vynutit omezení hesel. U SSO účtů vynucuje zásady hesel váš poskytovatel identity nebo adresářová služba, což navíc umožňuje podporu vícefaktorové autentizace.