Vue d'ensemble

Overleaf fonctionne comme plusieurs services qui s’appellent mutuellement en HTTP dans le réseau Docker. Les pages de cette section décrivent ces API internes. Elles proviennent des fichiers OpenAPI de develop/hoppscotch/openapi/, rédigés à partir du code de chaque service.

Aucune de ces API n’est publique : elles ne sont accessibles que dans le réseau Docker, et la plupart n’ont pas d’authentification.

​

Services

Service	Adresse	Rôle
web	http://web:3000	L’application principale. Son API privée est appelée par les autres services et par les scripts cron de l’image
document-updater	http://document-updater:3003	Conserve dans Redis les documents ouverts dans l’éditeur, applique les modifications et les réécrit dans Mongo
docstore	http://docstore:3016	Stocke chaque document de chaque projet dans la collection Mongo docs
real-time	http://real-time:3026	Gère les connexions socket.io de l’éditeur et relaie les modifications entre navigateurs et services
chat	http://chat:3010	Stocke le chat du projet et les fils de commentaires
project-history	http://project-history:3054	Transforme les modifications en file d’attente en modifications d’historique et les envoie à history-v1 ; conserve les étiquettes
history-v1	http://history-v1:3100	Stocke l’historique complet de chaque projet et le contenu des fichiers sous forme de blobs
filestore	http://filestore:3009	Sert les fichiers de modèles et, en lecture seule, les blobs écrits par history-v1
clsi	http://clsi:3013	Compile les projets, exécute SyncTeX et le comptage de mots, convertit des documents
notifications	http://notifications:3042	Stocke les notifications affichées dans la liste des projets
linked-url-proxy	http://linked-url-proxy:3066	Récupère des URL externes pour web et refuse les adresses internes
third-party-datastore	http://third-party-datastore:3002	Synchronise les projets avec Dropbox via une file de tâches par utilisateur

​

Authentification

• web : authentification HTTP basique avec WEB_API_USER et WEB_API_PASSWORD. Les routes git-bridge utilisent à la place un jeton d’accès personnel.
• history-v1 : authentification HTTP basique en tant que staging avec STAGING_PASSWORD, ou un JWT.
• Tous les autres services : aucune.

​

Les essayer

L’environnement de développement exécute Hoppscotch sur http://localhost:9170, avec un proxy qui atteint les services par leurs adresses Docker. Son README explique comment configurer le proxy et importer les fichiers OpenAPI.