Översikt

Overleaf körs som flera tjänster som anropar varandra över HTTP inom Docker-nätverket. Sidorna i det här avsnittet beskriver dessa interna API:er. De kommer från OpenAPI-filerna i develop/hoppscotch/openapi/, som är skrivna utifrån koden för varje tjänst.

Inget av dessa API:er är offentligt: de nås bara inom Docker-nätverket, och de flesta har ingen autentisering.

​

Tjänster

Tjänst	Adress	Vad den gör
web	http://web:3000	Huvudappen. Dess privata API anropas av de andra tjänsterna och avbildningens cronskript
document-updater	http://document-updater:3003	Håller dokumenten som är öppna i editorn i Redis, tillämpar ändringar och skriver tillbaka dem till Mongo
docstore	http://docstore:3016	Lagrar varje dokument i varje projekt i Mongo-samlingen docs
real-time	http://real-time:3026	Håller editorns socket.io-anslutningar och vidarebefordrar ändringar mellan webbläsare och tjänster
chat	http://chat:3010	Lagrar projektchatten och kommentarstrådarna
project-history	http://project-history:3054	Gör om köade ändringar till historikändringar och skickar dem till history-v1; sparar etiketter
history-v1	http://history-v1:3100	Lagrar hela historiken för varje projekt och filinnehållet som blobbar
filestore	http://filestore:3009	Levererar mallfiler och, skrivskyddat, de blobbar som history-v1 skriver
clsi	http://clsi:3013	Kompilerar projekt, kör SyncTeX och ordräkning, konverterar dokument
notifications	http://notifications:3042	Lagrar aviseringarna som visas i projektlistan
linked-url-proxy	http://linked-url-proxy:3066	Hämtar externa URL:er åt web och nekar interna adresser
third-party-datastore	http://third-party-datastore:3002	Synkroniserar projekt med Dropbox via en jobbkö per användare

​

Autentisering

• web: HTTP basic auth med WEB_API_USER och WEB_API_PASSWORD. git-bridge-rutterna använder i stället en personlig åtkomsttoken.
• history-v1: HTTP basic auth som staging med STAGING_PASSWORD, eller en JWT.
• Alla andra tjänster: ingen.

​

Prova dem

Utvecklingsmiljön kör Hoppscotch på http://localhost:9170, med en proxy som når tjänsterna via deras Docker-adresser. Dess README visar hur du ställer in proxyn och importerar OpenAPI-filerna.