Налаштування ізольованої компіляції

Якщо ви хочете налаштувати ізольовану компіляцію (Sandbox Compiles) для розробки, слід враховувати кілька відмінностей між середовищами розробки та продакшну. Потрібно звернути увагу на 3 речі:

• Проблема з правами доступу до файлів
• Спільний том для history-v1 та filestore
• Проблема з підкаталогами

​

Увімкнення ізольованої компіляції

Тут потрібно просто увімкнути Sandbox Compiles так само, як і в Overleaf CE. Однак слід звернути увагу на користувача. Тут ми встановлюємо його як root.

У продакшн-середовищі ми використовуємо www-data як спільного користувача для контейнера Overleaf і контейнера компіляції TeX. Проте в середовищі розробки користувачем за замовчуванням у контейнері є node, і користувача www-data, до якого можна було б прив’язатися, немає. Тож як обхідне рішення ми просто використовуємо root.

Будь ласка, не використовуйте власноруч зібраний образ — ви можете зіткнутися з низкою помилок.

#################
#   Sandbox     #
#################
SANDBOXED_COMPILES=true
TEXLIVE_IMAGE_USER=root
ALL_TEX_LIVE_DOCKER_IMAGES=ghcr.io/ayaka-notes/texlive-full:2025.1, ghcr.io/ayaka-notes/texlive-full:2024.1
ALL_TEX_LIVE_DOCKER_IMAGE_NAMES=Texlive 2025, Texlive 2024
TEX_LIVE_DOCKER_IMAGE=ghcr.io/ayaka-notes/texlive-full:2025.1

​

Виправлення прав доступу до файлів

LaTeX виконується в сусідніх контейнерах від імені користувача, вказаного у змінній середовища TEXLIVE_IMAGE_USER. У прикладі вище це root з uid 0. Це створює проблему з наведеними вище правами доступу, оскільки користувач root не має дозволу на запис у підкаталоги compiles.

Швидке виправлення — надати групі root право власності та права на читання й запис для compiles, встановивши setgid, щоб нові підкаталоги також успадковували це право власності:

bash

sudo chown -R 1000:root compiles
sudo chmod -R g+w compiles
sudo chmod g+s compiles

Докладну документацію див. у services/clsi/README.md.

​

Спільний том для history-v1 та filestore

За замовчуванням filestore виконує роль мосту між S3 та іншими сервісами Overleaf. Однак в Overleaf CE або Server Pro всі файли за замовчуванням зберігаються локально. Тому в Overleaf запровадили доволі хитромудрий метод.

server-ce/config/settings.js

switch (process.env.OVERLEAF_FILESTORE_BACKEND) {
  case 's3':
    // s3 case...
  default:
    settings.filestore = {
      backend: 'fs',
      stores: {
        template_files: Path.join(DATA_DIR, 'template_files'),

        // NOTE: The below paths are hard-coded in server-ce/config/production.json, so hard code them here as well.
        // We can use DATA_DIR after switching history-v1 from 'config' to '@overleaf/settings'.
        project_blobs:
          process.env.OVERLEAF_HISTORY_PROJECT_BLOBS_BUCKET ||
          '/var/lib/overleaf/data/history/overleaf-project-blobs',
        global_blobs:
          process.env.OVERLEAF_HISTORY_BLOBS_BUCKET ||
          '/var/lib/overleaf/data/history/overleaf-global-blobs',
      },
    }
}

Водночас data/history також використовується сервісом history. Таким чином різні мікросервіси можуть спільно використовувати ті самі дані. Вам потрібно додати том history-v1-buckets до сервісу filestore у середовищі розробки. Інакше clsi не зможе отримувати blob-файли із сервісу filestore.

develop/docker-compose.yml

  filestore:
    build:
      context: ..
      dockerfile: services/filestore/Dockerfile
    env_file:
      - dev.env
#    environment:
#      - ENABLE_CONVERSIONS=true
    volumes:
      - filestore-public-files:/overleaf/services/filestore/public_files
      - filestore-template-files:/overleaf/services/filestore/template_files
      - filestore-uploads:/overleaf/services/filestore/uploads
      - history-v1-buckets:/buckets

Також потрібно додати назви BUCKET до налаштувань dev.env:

develop/dev.env

OVERLEAF_EDITOR_PROJECT_BLOBS_BUCKET='/buckets/project_blobs'
OVERLEAF_EDITOR_BLOBS_BUCKET='/buckets/blobs'

​

Використання підкаталогів

Filestore за замовчуванням використовує useSubdirectories зі значенням true, однак у середовищі розробки history v1 зберігає всі дані в пласкій структурі. Це спричиняє певний конфлікт. Щоб це виправити, додайте таке:

develop/dev.env

OVERLEAF_EDITOR_PROJECT_BLOBS_BUCKET='/buckets/project_blobs'
OVERLEAF_EDITOR_BLOBS_BUCKET='/buckets/blobs'
NODE_CONFIG='{"persistor":{"useSubdirectories":true}}'

У history v1 усі файли project_blobs початково зберігаються так:

node@43eb5dac5b1b:/buckets/project_blobs$ ls
169_609_71360f687c431b9796_5b_889ef3cf71c83a4c027c4e4dc3d1a106b27809  
94e_655_88cb5cc77ab70c9796_a0_e21c740cf81e868f158e30e88985b5ea1d6c19
169_609_71360f687c431b9796_a0_e21c740cf81e868f158e30e88985b5ea1d6c19
94e_655_88cb5cc77ab70c9796_fd_3c0326302e49486d3ea86c833edf9b88320c41
169_609_71360f687c431b9796_fd_3c0326302e49486d3ea86c833edf9b88320c41 

Потрібно встановити useSubdirectories у true, щоб перейти в режим підкаталогів. Тепер початковий символ _ у blob буде замінено на / .