Overzicht

Overleaf draait als meerdere services die elkaar via HTTP aanroepen binnen het Docker-netwerk. De pagina’s in deze sectie beschrijven deze interne API’s. Ze komen uit de OpenAPI-bestanden in develop/hoppscotch/openapi/, die op basis van de code van elke service zijn geschreven.

Geen van deze API’s is openbaar: ze zijn alleen bereikbaar binnen het Docker-netwerk, en de meeste hebben geen authenticatie.

​

Services

Service	Adres	Wat het doet
web	http://web:3000	De hoofdapp. De privé-API wordt aangeroepen door de andere services en de cronscripts van de image
document-updater	http://document-updater:3003	Houdt de in de editor geopende documenten in Redis, past bewerkingen toe en schrijft ze terug naar Mongo
docstore	http://docstore:3016	Slaat elk document van elk project op in de Mongo-collectie docs
real-time	http://real-time:3026	Beheert de socket.io-verbindingen van de editor en geeft bewerkingen door tussen browsers en services
chat	http://chat:3010	Slaat de projectchat en de commentaarthreads op
project-history	http://project-history:3054	Zet bewerkingen uit de wachtrij om in geschiedeniswijzigingen en stuurt ze naar history-v1; bewaart labels
history-v1	http://history-v1:3100	Slaat de volledige geschiedenis van elk project en de bestandsinhoud als blobs op
filestore	http://filestore:3009	Levert sjabloonbestanden en, alleen-lezen, de blobs die history-v1 schrijft
clsi	http://clsi:3013	Compileert projecten, voert SyncTeX en woordtellingen uit, converteert documenten
notifications	http://notifications:3042	Slaat de meldingen op die in de projectenlijst worden getoond
linked-url-proxy	http://linked-url-proxy:3066	Haalt externe URL’s op voor web en weigert interne adressen
third-party-datastore	http://third-party-datastore:3002	Synchroniseert projecten met Dropbox via één jobwachtrij per gebruiker

​

Authenticatie

• web: HTTP basic auth met WEB_API_USER en WEB_API_PASSWORD. De git-bridge-routes gebruiken in plaats daarvan een persoonlijk toegangstoken.
• history-v1: HTTP basic auth als staging met STAGING_PASSWORD, of een JWT.
• Alle andere services: geen.

​

Uitproberen

De ontwikkelomgeving draait Hoppscotch op http://localhost:9170, met een proxy die de services via hun Docker-adressen bereikt. De README laat zien hoe u de proxy instelt en de OpenAPI-bestanden importeert.