Файли та розташування

На цій сторінці описано конфігураційні файли, які Toolkit використовує для налаштування вашого локального розгортання Overleaf.

​

Постійні дані

Overleaf Toolkit потребує зберігання постійних даних, як-от файлів, необхідних для компіляції проєктів LaTeX, і вмісту бази даних MongoDB. Для цього кілька каталогів із хост-машини монтуються в Docker-контейнери, і дані записуються в ці каталоги.

​

Каталоги даних

Контейнеру sharelatex потрібен каталог для зберігання даних, пов’язаних із компіляцією LaTeX. Цей каталог задається змінною OVERLEAF_DATA_PATH у config/overleaf.rc.

Контейнеру mongo, якщо його ввімкнено, потрібен каталог для зберігання файлів бази даних; те саме стосується і контейнера redis. Ці каталоги також можна налаштувати в config/overleaf.rc.

​

Права доступу до файлів

Оскільки Docker працює від імені root, власником каталогів даних зрештою стане користувач root, навіть якщо Toolkit використовується не від імені root. Це не проблема, але про це варто пам’ятати, якщо ви плануєте змінювати постійні дані ззовні контейнерів.

​

Розташування конфігураційних файлів

Усі конфігураційні файли, що належать користувачеві, розташовані в каталозі config/.

Цей каталог виключено із системи контролю версій git, тому оновлення коду Toolkit його не змінить. Toolkit не змінюватиме жодних даних у каталозі config/ без вашого дозволу.

Зміни в конфігураційних файлах не застосовуються автоматично до наявних контейнерів, навіть якщо контейнер зупинити й перезапустити (за допомогою bin/stop і bin/start). Щоб застосувати зміни, виконайте bin/up — за лаштунками docker compose автоматично застосує зміни конфігурації до нового контейнера. (Або виконайте bin/up -d, якщо не бажаєте під’єднуватися до логів Docker.)

​

Файл overleaf.rc

Файл config/overleaf.rc містить найважливіші параметри конфігурації верхнього рівня, які використовує Toolkit. Він складається з інструкцій, що задають змінні у форматі: VARIABLE_NAME=value

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

​

Файл variables.env

Файл config/variables.env містить змінні середовища, які завантажуються в контейнер sharelatex і використовуються для налаштування мікросервісів Overleaf. Серед них — назва застосунку, що відображається в заголовку вебінтерфейсу, параметри надсилання електронної пошти та інші преміальні параметри, як-от SSO для використання із Server Pro.

Детальний перелік усіх доступних змінних середовища наведено в розділі Змінні середовища.

​

Файл version

Файл config/version містить номер версії Docker-образу, який буде використано для створення робочого екземпляра вашого сервера Overleaf.

Зміни в цих конфігураційних файлах не застосовуються автоматично до наявних контейнерів, навіть якщо контейнер зупинити й перезапустити (за допомогою bin/stop і bin/start). Щоб застосувати зміни, виконайте bin/up, і Toolkit автоматично створить для вас новий контейнер із застосованими змінами конфігурації.

​

Файл docker-compose.override.yml

Якщо файл config/docker-compose.override.yml існує, його буде включено у виклик docker compose. Це зручно для перевизначення конфігурації, специфічної для Docker Compose.

Докладніше дивіться в документації docker-compose.