Přehled

Overleaf běží jako několik služeb, které se navzájem volají přes HTTP uvnitř sítě Docker. Stránky v této části popisují tato interní API. Vycházejí ze souborů OpenAPI v develop/hoppscotch/openapi/, které jsou napsány podle kódu jednotlivých služeb.

Žádné z těchto API není veřejné: jsou dostupná jen uvnitř sítě Docker a většina z nich nemá ověřování.

​

Služby

Služba	Adresa	Co dělá
web	http://web:3000	Hlavní aplikace. Její soukromé API volají ostatní služby a cron skripty image
document-updater	http://document-updater:3003	Drží dokumenty otevřené v editoru v Redisu, aplikuje úpravy a zapisuje je zpět do Monga
docstore	http://docstore:3016	Ukládá každý dokument každého projektu do kolekce Mongo docs
real-time	http://real-time:3026	Drží socket.io spojení editoru a předává úpravy mezi prohlížeči a službami
chat	http://chat:3010	Ukládá chat projektu a vlákna komentářů
project-history	http://project-history:3054	Převádí úpravy z fronty na změny historie a posílá je do history-v1; uchovává štítky
history-v1	http://history-v1:3100	Ukládá úplnou historii každého projektu a obsah souborů jako bloby
filestore	http://filestore:3009	Poskytuje soubory šablon a, pouze pro čtení, bloby zapsané history-v1
clsi	http://clsi:3013	Kompiluje projekty, spouští SyncTeX a počítání slov, převádí dokumenty
notifications	http://notifications:3042	Ukládá oznámení zobrazovaná v seznamu projektů
linked-url-proxy	http://linked-url-proxy:3066	Načítá externí URL pro web a odmítá interní adresy
third-party-datastore	http://third-party-datastore:3002	Synchronizuje projekty s Dropboxem přes jednu frontu úloh na uživatele

​

Ověřování

• web: HTTP basic auth s WEB_API_USER a WEB_API_PASSWORD. Trasy git-bridge místo toho používají osobní přístupový token.
• history-v1: HTTP basic auth jako staging s STAGING_PASSWORD, nebo JWT.
• Všechny ostatní služby: žádné.

​

Vyzkoušejte je

Vývojové prostředí spouští Hoppscotch na http://localhost:9170 s proxy, která se ke službám dostane přes jejich adresy v Dockeru. Jeho README ukazuje, jak nastavit proxy a importovat soubory OpenAPI.