Міграція з docker-compose.yml на Toolkit

Перенесіть розгортання Overleaf на Docker Compose на Toolkit.

Якщо ви зараз використовуєте Docker Compose через файл docker-compose.yml, перехід на Toolkit може спростити розгортання, оновлення та обслуговування локальної версії Overleaf.

Для міграції потрібно перетворити наявне налаштування Docker Compose у формат, який використовує Toolkit. Цей процес передбачає перенесення наявної конфігурації в Toolkit.

Цей посібник крок за кроком проведе вас через увесь процес і забезпечить плавний перехід із Docker Compose на Toolkit.

Ці інструкції призначені для v4.x і ранніших версій. Тому всі змінні використовують префікс SHARELATEX_ замість OVERLEAF_.

1. Клонування репозиторію Toolkit

   Спочатку клонуйте репозиторій Toolkit на хост-машину:

   git clone https://github.com/overleaf/toolkit.git ./overleaf-toolkit
   

   Потім виконайте команду bin/init, щоб ініціалізувати Toolkit із типовою конфігурацією.

2. Налаштування образу та версії

   У типовому docker-compose.yml образ і версію визначено в описі компонента, наприклад:

   version: '2.2'
   services:
       sharelatex:
           restart: always
           # Server Pro users:
           # image: quay.io/sharelatex/sharelatex-pro
           image: sharelatex/sharelatex:3.5.13
   

   У Toolkit ім’я образу визначається автоматично; потрібно лише задати SERVER_PRO=true у config/overleaf.rc, щоб вибрати образ Server Pro, або SERVER_PRO=false, щоб використовувати Community Edition.

   Потрібний номер версії Server Pro/Community Edition задається у файлі config/version. Toolkit вимагає конкретного номера версії, наприклад 4.2.3. Якщо ви використовуєте latest, за допомогою bin/images можна знайти ідентифікатор образу вашої локальної версії latest, а потім за примітками до випусків 2.x.x, 3.x.x, 4.x.x або 5.x.x зіставити цей ідентифікатор із версією.

   Якщо ви отримуєте образ із власного внутрішнього реєстру, можна перевизначити образ, який використовує Toolkit, задавши OVERLEAF_IMAGE_NAME. Тег вказувати не потрібно, оскільки Toolkit автоматично додасть його на основі вашого файлу config/version.

3. Налаштування зовнішнього доступу

   Типово Overleaf прослуховує 127.0.0.1:80, приймаючи трафік лише з хост-машини Docker.

   Щоб дозволити зовнішній доступ, задайте OVERLEAF_LISTEN_IP і OVERLEAF_PORT у файлі config/overleaf.rc.

4. Міграція змінних середовища

   Імовірно, у сервісі sharelatex вашого docker-compose.yml визначено набір змінних середовища, наприклад:

   environment:
       OVERLEAF_APP_NAME: Overleaf Community Edition
       OVERLEAF_PROXY_LEARN: 'true'
       …
   

   Скопіюйте ці змінні у файл Toolkit config/variables.env, дотримуючись такого формату (використовуйте = замість :):

   OVERLEAF_APP_NAME=Overleaf Community Edition
   OVERLEAF_PROXY_LEARN=true
   

   Винятки й відмінності під час використання Toolkit:

   • Змінні, що починаються з SANDBOXED_COMPILES_ і DOCKER_RUNNER, більше не потрібні. Щоб увімкнути Sandboxed Compiles, задайте SIBLING_CONTAINERS_ENABLED=true у файлі config/overleaf.rc.
   • Змінні, що починаються з OVERLEAF_MONGO_, OVERLEAF_REDIS_, а також змінна REDIS_HOST більше не потрібні. MongoDB і Redis тепер налаштовуються у файлі config/overleaf.rc за допомогою MONGO_URL, REDIS_HOST і REDIS_PORT.

   Розширені параметри конфігурації описано в документації config/overleaf.rc.

5. Проксі NGINX

   Інструкції щодо міграції nginx дивіться в документації з TLS-проксі:

6. Томи

   Задайте розташування томів даних у config/overleaf.rc:

   ​

   ShareLaTeX

   Задайте в OVERLEAF_DATA_PATH розташування тому даних, який використовує контейнер sharelatex.

   ​

   MongoDB

   Задайте в MONGO_DATA_PATH розташування тому даних, який використовує контейнер mongo.

   ​

   Redis

   Задайте в REDIS_DATA_PATH розташування тому даних, який використовує контейнер redis.

Докладнішу інформацію та розширені налаштування дивіться у відповідній документації з конфігурації Toolkit, посилання на яку наведено вище.