Oversigt

Overleaf kører som flere tjenester, der kalder hinanden over HTTP inden for Docker-netværket. Siderne i dette afsnit beskriver disse interne API’er. De stammer fra OpenAPI-filerne i develop/hoppscotch/openapi/, som er skrevet ud fra koden til hver tjeneste.

Ingen af disse API’er er offentlige: de kan kun nås inden for Docker-netværket, og de fleste har ingen godkendelse.

​

Tjenester

Tjeneste	Adresse	Hvad den gør
web	http://web:3000	Hovedappen. Dens private API kaldes af de andre tjenester og imagets cronscripts
document-updater	http://document-updater:3003	Holder de dokumenter, der er åbne i editoren, i Redis, anvender ændringer og skriver dem tilbage til Mongo
docstore	http://docstore:3016	Gemmer hvert dokument i hvert projekt i Mongo-samlingen docs
real-time	http://real-time:3026	Holder editorens socket.io-forbindelser og videresender ændringer mellem browsere og tjenester
chat	http://chat:3010	Gemmer projektchatten og kommentartrådene
project-history	http://project-history:3054	Omdanner ændringer i kø til historikændringer og sender dem til history-v1; gemmer etiketter
history-v1	http://history-v1:3100	Gemmer hele historikken for hvert projekt og filindholdet som blobs
filestore	http://filestore:3009	Leverer skabelonfiler og, skrivebeskyttet, de blobs, som history-v1 skriver
clsi	http://clsi:3013	Kompilerer projekter, kører SyncTeX og ordtælling, konverterer dokumenter
notifications	http://notifications:3042	Gemmer de notifikationer, der vises i projektlisten
linked-url-proxy	http://linked-url-proxy:3066	Henter eksterne URL’er for web og afviser interne adresser
third-party-datastore	http://third-party-datastore:3002	Synkroniserer projekter med Dropbox via én jobkø pr. bruger

​

Godkendelse

• web: HTTP basic auth med WEB_API_USER og WEB_API_PASSWORD. git-bridge-ruterne bruger i stedet et personligt adgangstoken.
• history-v1: HTTP basic auth som staging med STAGING_PASSWORD eller et JWT.
• Alle andre tjenester: ingen.

​

Prøv dem

Udviklingsmiljøet kører Hoppscotch på http://localhost:9170 med en proxy, der når tjenesterne via deres Docker-adresser. Dens README viser, hvordan du opsætter proxyen og importerer OpenAPI-filerne.