Огляд

Overleaf працює як набір сервісів, які викликають один одного через HTTP всередині мережі Docker. Сторінки цього розділу описують ці внутрішні API. Вони ґрунтуються на файлах OpenAPI в develop/hoppscotch/openapi/, написаних за кодом кожного сервісу.

Жоден із цих API не є публічним: вони доступні лише всередині мережі Docker, і більшість із них не має автентифікації.

​

Сервіси

Сервіс	Адреса	Що робить
web	http://web:3000	Основний застосунок. Його приватний API викликають інші сервіси та cron-скрипти образу
document-updater	http://document-updater:3003	Тримає відкриті в редакторі документи в Redis, застосовує зміни й записує їх назад у Mongo
docstore	http://docstore:3016	Зберігає кожен документ кожного проєкту в колекції Mongo docs
real-time	http://real-time:3026	Тримає socket.io-з’єднання редактора й пересилає зміни між браузерами та сервісами
chat	http://chat:3010	Зберігає чат проєкту та гілки коментарів
project-history	http://project-history:3054	Перетворює зміни з черги на зміни історії та надсилає їх у history-v1; зберігає мітки
history-v1	http://history-v1:3100	Зберігає повну історію кожного проєкту та вміст файлів у вигляді блобів
filestore	http://filestore:3009	Віддає файли шаблонів і, лише для читання, блоби, записані history-v1
clsi	http://clsi:3013	Компілює проєкти, запускає SyncTeX і підрахунок слів, конвертує документи
notifications	http://notifications:3042	Зберігає сповіщення, що показуються в списку проєктів
linked-url-proxy	http://linked-url-proxy:3066	Завантажує зовнішні URL для web і відхиляє внутрішні адреси
third-party-datastore	http://third-party-datastore:3002	Синхронізує проєкти з Dropbox через одну чергу завдань на користувача

​

Автентифікація

• web: HTTP basic auth з WEB_API_USER і WEB_API_PASSWORD. Маршрути git-bridge натомість використовують персональний токен доступу.
• history-v1: HTTP basic auth від імені staging з STAGING_PASSWORD або JWT.
• Усі інші сервіси: немає.

​

Спробувати

Середовище розробки запускає Hoppscotch на http://localhost:9170 з проксі, який звертається до сервісів за їхніми адресами в Docker. У його README описано, як налаштувати проксі та імпортувати файли OpenAPI.