Змінні середовища

На цій сторінці описано змінні середовища, які підтримуються у файлі config/variables.env для розгортань через Toolkit.

Файл config/variables.env складається з визначень змінних у формі NAME=value; рядки, що починаються з #, вважаються коментарями.

Після будь-якої зміни в overleaf.rc або variables.env необхідно перестворити контейнери Docker, виконавши bin/up.

​

Усі версії

Ці змінні середовища сумісні з Server CE і Server Pro та забезпечують простий шлях міграції між цими двома локальними версіями. Їх також можна використовувати як для розгортань через Toolkit, так і через Docker Compose.

Раніше ці змінні середовища мали префікс SHARELATEX_ замість OVERLEAF_.

Назва	Опис
OVERLEAF_SITE_URL	Адреса, за якою ваш екземпляр Overleaf публічно доступний. Використовується в публічних посиланнях і під час підключення через websockets, тому має бути налаштована правильно!
OVERLEAF_ADMIN_EMAIL	Електронна адреса, за якою користувачі можуть зв’язатися з особою, що адмініструє сайт.
OVERLEAF_APP_NAME	Назва, що відображається, коли йдеться про запущений застосунок. За замовчуванням ‘Overleaf (Community Edition)’.
OVERLEAF_MONGO_URL and MONGO_URL	URL бази даних Mongo, яку слід використовувати.
OVERLEAF_REDIS_HOST and REDIS_HOST	Ім’я хоста екземпляра Redis, який слід використовувати. Обидві змінні обов’язкові (див. примітки до випуску).
OVERLEAF_REDIS_PORT and REDIS_PORT	Порт екземпляра Redis, який слід використовувати. Обидві змінні обов’язкові (див. примітки до випуску).
OVERLEAF_REDIS_PASS and REDIS_PASSWORD	Пароль для підключення до Redis (за потреби). Потрібно задати обидві змінні середовища. Докладніше див. увімкнення автентифікації за паролем.
OVERLEAF_REDIS_TLS	Якщо встановлено true, дозволяє підключення до екземпляра Redis, що вимагає TLS. Примітка: mTLS наразі не підтримується.
OVERLEAF_NAV_TITLE	Задає заголовок вкладки застосунку.
OVERLEAF_HEADER_IMAGE_URL_LIGHT and OVERLEAF_HEADER_IMAGE_URL_DARK	URL власних логотипів заголовка для світлої та темної тем (додано у 6.3.0). Якщо змінну для конкретної теми не задано, використовується OVERLEAF_HEADER_IMAGE_URL. Див. Branding.
OVERLEAF_LINKED_URL_OUTBOUND_PROXY	URL проксі HTTP(S) для отримання зовнішніх пов’язаних файлів, а також зовнішніх ресурсів ZIP або TeX через API Open in Overleaf. Доступно починаючи з повторно випущеного Ayakaleaf Pro 6.3.0 (3 жовтня 2026 р.). Залиште незаданою для прямого підключення. Приклад: OVERLEAF_LINKED_URL_OUTBOUND_PROXY=http://proxy.internal:3128. Налаштування та обмеження мережевого доступу див. у Outbound Proxy.
OVERLEAF_INVITE_TOKEN_SECRET	Обов’язкова. Випадковий рядок, що використовується для захисту токенів спільного доступу до проєктів (додано в Server Pro 6.2.0). Мінімальна кількість символів: 16
OVERLEAF_SESSION_SECRET	Випадковий рядок, що використовується для захисту токенів; у разі балансування навантаження на всіх машинах потрібно задати однакове значення. Якщо запущено лише 1 екземпляр, користувачеві не потрібно його задавати.
OVERLEAF_COOKIE_SESSION_LENGTH	Дає змогу перевизначити стандартний термін дії cookie сеансу, що становить 5 днів. Значення вказується в мілісекундах. Приклад: щоб сеанс тривав 1 годину, встановіть COOKIE_SESSION_LENGTH=3600000. (Додано в Server Pro 4.2)
OVERLEAF_TRUSTED_PROXY_IPS	Якщо не задано, за замовчуванням loopback. Якщо ви задаєте значення вручну, окрім ваших довірених IP-адрес потрібно також включити loopback (або 127.0.0.1), що забезпечує довіру до екземпляра nginx, запущеного всередині контейнера sharelatex. Приймаються лише IP-адреси та діапазони CIDR: не додавайте імена хостів, як-от localhost, інакше Overleaf не запуститься й повертатиме 502 Bad Gateway. Якщо для вашої звичайної мережі використовується підмережа з 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. Якщо ви використовуєте зовнішній TLS-проксі (тобто такий, що не керується Overleaf Toolkit), переконайтеся, що OVERLEAF_TRUSTED_PROXY_IPS=loopback,<ip-of-your-tls-proxy>, наприклад OVERLEAF_TRUSTED_PROXY_IPS=loopback,192.168.13.37.
OVERLEAF_RESTRICT_INVITES_TO_EXISTING_ACCOUNTS	Якщо встановлено true, запрошення до проєктів обмежуватимуться електронними адресами, які відповідають наявним обліковим записам користувачів.
OVERLEAF_ALLOW_PUBLIC_ACCESS	Якщо встановлено true, неавтентифіковані користувачі зможуть переглядати сайт. За замовчуванням false, тобто неавтентифікованих користувачів безумовно перенаправлятиме на сторінку входу, коли вони спробують переглянути будь-яку частину сайту. Зауважте, що цей параметр жодним чином не вимикає автентифікацію чи захист. Він потрібен, якщо ваші користувачі мають намір робити свої проєкти публічними й дозволяти неавтентифікованим користувачам їх переглядати.
OVERLEAF_ALLOW_ANONYMOUS_READ_AND_WRITE_SHARING	Якщо встановлено true, анонімні користувачі зможуть переглядати й редагувати проєкти, надані через функцію спільного доступу за посиланням.
OVERLEAF_DISABLE_LINK_SHARING	Вимикає функцію спільного доступу за посиланням.
EMAIL_CONFIRMATION_DISABLED	Якщо встановлено true, банер із запитом на підтвердження електронної адреси не відображатиметься.
ADDITIONAL_TEXT_EXTENSIONS	Масив рядків для налаштування додаткових розширень файлів, які можна редагувати.
DEFAULT_LATEX_COMPILER	Задає компілятор за замовчуванням для нових проєктів. (Додано в Server Pro 6.2.0). Варіанти: pdflatex, latex, xelatex або lualatex
OVERLEAF_STATUS_PAGE_URL	URL власної сторінки стану (додано в Server Pro 3.4.0), наприклад status.example.com.
OVERLEAF_FPH_INITIALIZE_NEW_PROJECTS	Встановіть 'false', щоб нові проєкти не ініціалізувалися з повною історією проєкту (Full Project History) (додано в Server Pro 3.5.0).
OVERLEAF_FPH_DISPLAY_NEW_PROJECTS	Встановіть 'false', щоб нові проєкти не відображали повну історію проєкту (Full Project History) замість застарілої історії (додано в Server Pro 3.5.0).
ENABLE_CRON_RESOURCE_DELETION	Встановіть цю змінну середовища в true, щоб увімкнути автоматичне очищення видалених проєктів і користувачів через 90 днів.
OVERLEAF_USER_HARD_DELETION_DELAY	Змінює затримку остаточного видалення видалених користувачів. Задається в мілісекундах. За замовчуванням: 90 днів
OVERLEAF_PROJECT_HARD_DELETION_DELAY	Змінює затримку остаточного видалення видалених проєктів. Задається в мілісекундах. За замовчуванням: 90 днів
MAX_UPLOAD_SIZE	Визначає максимальний розмір окремого завантаження в мегабайтах. За замовчуванням 50. Увага: ця змінна — просто число, без одиниці виміру (MB) чи обгортки. Загальний розпакований розмір завантаженого файлу .zip обмежено 6 × цим значенням (300 МБ за замовчуванням).
COMPILE_SIZE_LIMIT	Визначає максимальний розмір тіла запиту в байтах. Це сума розмірів усіх файлів-документів у проєкті (main.tex, references.bib (якщо не пов’язаний) тощо), які потрібно надіслати в початковому запиті компіляції до сервісу CLSI.
COMPILE_TIMEOUT	Час у секундах, відведений на завершення компіляції. Докладніше див. Оновлення тайм-ауту компіляції проєкту.
MAX_RECONNECT_GRACEFULLY_INTERVAL_MS	Налаштовувана затримка між плавним перепідключенням редактора, скиданням даних і зупинкою контейнера для зменшення ризику втрати даних.
SECCOMP_PROFILE	Встановіть цю змінну середовища на шлях на хост-машині Docker, що вказує на профіль SECCOMP. Копію профілю можна завантажити тут. Наразі потрібна для розгортань Podman з ізольованою компіляцією.
OVERLEAF_DISABLE_CHAT	Якщо встановлено true, вимикає функцію чату в проєкті.
OVERLEAF_LOGIN_SUPPORT_TEXT	Якщо задано, дає змогу відображати інформацію про підтримку під кнопкою входу. Текст показується на екрані входу й може використовуватися, щоб спрямувати користувачів до внутрішньої підтримки або надати вказівки щодо входу, створення облікових записів тощо.
ALLOW_MONGO_ADMIN_CHECK_FAILURES	Якщо встановлено true, дозволяє перевіркам MongoDB під час запуску завершуватися невдачею, не перешкоджаючи запуску розгортання. Це може знадобитися, якщо ви використовуєте базу даних MongoDB, де ваш користувач бази даних не має ролі clusterParameterReader. Допомогу зі створенням власної ролі див. тут.
V1_HISTORY_URL_FOR_GIT_BRIDGE	Дає змогу розділити кінцеву точку history-v1 для внутрішнього трафіку (сервіс web → сервіс history-v1, обидва в контейнері sharelatex) і зовнішнього трафіку (git-bridge → history-v1, що працюють в окремих контейнерах).
OVERLEAF_MAINTENANCE_MESSAGE and OVERLEAF_MAINTENANCE_MESSAGE_HTML	Використовуються для налаштування заголовка та вмісту сторінки технічного обслуговування. Не можна використовувати разом з OVERLEAF_STATUS_PAGE_URL.

Можна запровадити обмеження паролів для користувачів, коли використовується система входу Overleaf (локальні облікові записи), а не SSO, як-от LDAP. Для облікових записів SSO політики паролів застосовуватиме ваш постачальник ідентичності або служба каталогів, що додатково дає змогу підтримувати багатофакторну автентифікацію.