Oversikt

Overleaf kjører som flere tjenester som kaller hverandre over HTTP innenfor Docker-nettverket. Sidene i denne delen beskriver disse interne API-ene. De kommer fra OpenAPI-filene i develop/hoppscotch/openapi/, som er skrevet ut fra koden til hver tjeneste.

Ingen av disse API-ene er offentlige: de kan bare nås innenfor Docker-nettverket, og de fleste har ingen autentisering.

​

Tjenester

Tjeneste	Adresse	Hva den gjør
web	http://web:3000	Hovedappen. Det private API-et kalles av de andre tjenestene og imagets cronskript
document-updater	http://document-updater:3003	Holder dokumentene som er åpne i editoren i Redis, bruker endringer og skriver dem tilbake til Mongo
docstore	http://docstore:3016	Lagrer hvert dokument i hvert prosjekt i Mongo-samlingen docs
real-time	http://real-time:3026	Holder editorens socket.io-tilkoblinger og videreformidler endringer mellom nettlesere og tjenester
chat	http://chat:3010	Lagrer prosjektchatten og kommentartrådene
project-history	http://project-history:3054	Gjør endringer i kø om til historikkendringer og sender dem til history-v1; lagrer etiketter
history-v1	http://history-v1:3100	Lagrer hele historikken til hvert prosjekt og filinnholdet som blobber
filestore	http://filestore:3009	Leverer malfiler og, skrivebeskyttet, blobbene som history-v1 skriver
clsi	http://clsi:3013	Kompilerer prosjekter, kjører SyncTeX og ordtelling, konverterer dokumenter
notifications	http://notifications:3042	Lagrer varslene som vises i prosjektlisten
linked-url-proxy	http://linked-url-proxy:3066	Henter eksterne URL-er for web og avviser interne adresser
third-party-datastore	http://third-party-datastore:3002	Synkroniserer prosjekter med Dropbox via én jobbkø per bruker

​

Autentisering

• web: HTTP basic auth med WEB_API_USER og WEB_API_PASSWORD. git-bridge-rutene bruker i stedet et personlig tilgangstoken.
• history-v1: HTTP basic auth som staging med STAGING_PASSWORD, eller et JWT.
• Alle andre tjenester: ingen.

​

Prøv dem

Utviklingsmiljøet kjører Hoppscotch på http://localhost:9170, med en proxy som når tjenestene via Docker-adressene deres. README-filen viser hvordan du setter opp proxyen og importerer OpenAPI-filene.