5. Персонализация экземпляра

​

Персонализация экземпляра

Перед первым запуском экземпляра Overleaf внесите свои данные в два конфигурационных файла:

Файл	Кто читает	Что здесь задаётся
config/overleaf.rc	скрипты Toolkit, например bin/up	как запускаются контейнеры: OVERLEAF_LISTEN_IP, OVERLEAF_PORT, SERVER_PRO, пути к данным
config/variables.env	приложение внутри контейнера	поведение Overleaf: OVERLEAF_SITE_URL, электронная почта, образы TeX Live

1. Отредактируйте файл переменных

   Откройте config/variables.env в удобном текстовом редакторе и задайте нужные значения для перечисленных ниже переменных окружения.

2. Адрес и порт для прослушивания

   По умолчанию Toolkit публикует веб-интерфейс на 127.0.0.1:80, поэтому его можно открыть только из браузера на самом сервере. Другие компьютеры получают ошибку «connection refused» или «server not found». Чтобы изменить это, отредактируйте config/overleaf.rc:

   config/overleaf.rc

   OVERLEAF_LISTEN_IP=0.0.0.0
   OVERLEAF_PORT=8080
   

   OVERLEAF_LISTEN_IP — это IP-адрес хоста, к которому привязывается контейнер, а OVERLEAF_PORT — порт хоста. Вместе они образуют сопоставление портов Docker OVERLEAF_LISTEN_IP:OVERLEAF_PORT:80. Выберите значения, соответствующие вашей конфигурации:

   Конфигурация	OVERLEAF_LISTEN_IP	OVERLEAF_PORT	Адрес в браузере
   Только на этой машине (по умолчанию)	127.0.0.1	80	http://localhost
   Другие компьютеры в локальной сети или из интернета подключаются напрямую	0.0.0.0 или один из IP-адресов сервера	80 или любой свободный порт	http://<server-ip>:<port>
   За вашим собственным обратным прокси (NGINX, Caddy, Cloudflare Tunnel) на том же хосте	127.0.0.1	любой свободный порт	URL прокси
   За TLS-прокси Toolkit	127.0.0.1	80	https://<your-domain>

   Если порт 80 на хосте уже занят, например другим веб-сервером, задайте в OVERLEAF_PORT свободный порт, например 8080. Иначе bin/up завершится ошибкой bind: address already in use.

   Порты, опубликованные Docker, обходят межсетевые экраны хоста, такие как ufw и firewalld. При значении 0.0.0.0 экземпляр доступен из всех сетей, к которым подключён сервер. На облачном сервере также нужно разрешить порт в группе безопасности провайдера. Прежде чем открывать экземпляр в интернет, настройте HTTPS, см. TLS-прокси.

   Можно начать со значений по умолчанию и сначала открыть экземпляр на localhost. Чтобы позже разрешить доступ с других компьютеров, измените эти две переменные в config/overleaf.rc и OVERLEAF_SITE_URL в config/variables.env, затем снова выполните bin/up, чтобы пересоздать контейнеры.

3. Обязательные переменные окружения

   Обновите следующие переменные в config/variables.env:

   Имя	Описание	Пример
   OVERLEAF_SITE_URL	Адрес, по которому ваш экземпляр Overleaf публично доступен. Используется в публичных ссылках и при подключении через WebSocket, поэтому должен быть настроен правильно!	https://overleaf.lilliput.com
   OVERLEAF_EMAIL_FROM_ADDRESS	Этот адрес электронной почты будет использоваться в качестве адреса from для всех исходящих писем.	[e-mail]
   OVERLEAF_ADMIN_EMAIL	Адрес электронной почты, по которому пользователи могут связаться с администратором сайта.	[e-mail]

   OVERLEAF_SITE_URL — это адрес, который пользователи вводят в браузере, а не адрес прослушивания. Указывайте порт, если он отличается от 80 (HTTP) или 443 (HTTPS), например http://192.168.1.20:8080. Не используйте http://0.0.0.0. Если OVERLEAF_SITE_URL не совпадает с адресом в браузере, редактор не сможет подключиться, а ссылки в письмах и обратные вызовы OAuth будут указывать не туда.

   Если почтового сервера нет, не задавайте OVERLEAF_EMAIL_FROM_ADDRESS: тогда Overleaf не отправляет писем, и вы можете сами передавать новым пользователям ссылку для активации, см. раздел «Вопросы и ответы» в Публичный доступ.

   Также задайте в OVERLEAF_SESSION_SECRET значение, сгенерированное командой openssl rand -hex 32. Без него каждый bin/up, пересоздающий контейнер, и каждое обновление приводят к выходу всех пользователей из системы. См. раздел «Вопросы и ответы» в Переменные окружения.

   После обновления этих переменных окружения сохраните файл и закройте редактор.

4. Настройте изолированную компиляцию

   Далее настройте TeX Live Full для sandboxed-compiles.md. Откройте config/variables.env и обновите следующие переменные окружения:

   config/variables.env

   ALL_TEX_LIVE_DOCKER_IMAGES=ghcr.io/ayaka-notes/texlive-full:2026.1, ghcr.io/ayaka-notes/texlive-full:2025.1
   ALL_TEX_LIVE_DOCKER_IMAGE_NAMES=Texlive 2026, Texlive 2025
   TEX_LIVE_DOCKER_IMAGE=ghcr.io/ayaka-notes/texlive-full:2026.1
   
5. Запустите экземпляр

   Чтобы запустить экземпляр, выполните:

   Start the instance

   bin/up
   

   Эта команда загрузит необходимые образы, включая texlive, создаст контейнеры (с учётом ваших настроек) и запустит экземпляр. Вы должны увидеть вывод журналов различных Docker-контейнеров.

   Чтобы позже снова запустить их (без подключения к выводу журналов), выполните:

   Start without attaching to logs

   bin/start
   

Toolkit использует docker compose для управления Docker-контейнерами Overleaf. Toolkit предоставляет набор скриптов, которые служат обёрткой над docker compose и берут на себя большинство деталей.

Если всё прошло успешно, вы сможете открыть страницу входа нового экземпляра Overleaf, перейдя в браузере по адресу http://127.0.0.1/ или http://localhost/. Если вы изменили OVERLEAF_LISTEN_IP или OVERLEAF_PORT, откройте вместо этого адрес из таблицы на шаге Адрес и порт для прослушивания, например http://<server-ip>:8080.

Чтобы проверить, на каком адресе и порту опубликован веб-интерфейс, выполните:

Show the published port

bin/docker-compose port sharelatex 80

Вывод, например 0.0.0.0:8080, показывает используемые IP-адрес и порт хоста. Если в нём указано 127.0.0.1, экземпляр доступен только с самого сервера.

В зависимости от конфигурации вашей сети и места размещения экземпляра Overleaf может потребоваться дополнительная настройка. Подробнее см. в настройках Toolkit: toolkit-settings.md