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 публічно доступний. Вона використовується в публічних посиланнях і під час підключення через вебсокети, тому має бути налаштована правильно!	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