Überblick

Overleaf läuft als mehrere Dienste, die sich innerhalb des Docker-Netzwerks gegenseitig über HTTP aufrufen. Die Seiten in diesem Abschnitt beschreiben diese internen APIs. Sie stammen aus den OpenAPI-Dateien in develop/hoppscotch/openapi/, die aus dem Code der einzelnen Dienste erstellt wurden.

Keine dieser APIs ist öffentlich: Sie sind nur innerhalb des Docker-Netzwerks erreichbar, und die meisten haben keine Authentifizierung.

​

Dienste

Dienst	Adresse	Aufgabe
web	http://web:3000	Die Hauptanwendung. Ihre private API wird von den anderen Diensten und den Cron-Skripten des Images aufgerufen
document-updater	http://document-updater:3003	Hält die im Editor geöffneten Dokumente in Redis, wendet Änderungen an und schreibt sie zurück nach Mongo
docstore	http://docstore:3016	Speichert jedes Dokument jedes Projekts in der Mongo-Collection docs
real-time	http://real-time:3026	Hält die socket.io-Verbindungen des Editors und leitet Änderungen zwischen Browsern und Diensten weiter
chat	http://chat:3010	Speichert den Projekt-Chat und die Kommentar-Threads
project-history	http://project-history:3054	Wandelt eingereihte Änderungen in Verlaufsänderungen um und sendet sie an history-v1; verwaltet Labels
history-v1	http://history-v1:3100	Speichert den vollständigen Verlauf jedes Projekts und die Dateiinhalte als Blobs
filestore	http://filestore:3009	Liefert Vorlagendateien und, nur lesend, die von history-v1 geschriebenen Blobs aus
clsi	http://clsi:3013	Kompiliert Projekte, führt SyncTeX und Wortzählungen aus, konvertiert Dokumente
notifications	http://notifications:3042	Speichert die in der Projektliste angezeigten Benachrichtigungen
linked-url-proxy	http://linked-url-proxy:3066	Ruft externe URLs für web ab und lehnt interne Adressen ab
third-party-datastore	http://third-party-datastore:3002	Synchronisiert Projekte mit Dropbox über eine Job-Warteschlange pro Benutzer

​

Authentifizierung

• web: HTTP-Basic-Auth mit WEB_API_USER und WEB_API_PASSWORD. Die git-bridge-Routen verwenden stattdessen ein persönliches Zugriffstoken.
• history-v1: HTTP-Basic-Auth als staging mit STAGING_PASSWORD oder ein JWT.
• Alle anderen Dienste: keine.

​

Ausprobieren

Die Entwicklungsumgebung betreibt Hoppscotch unter http://localhost:9170, mit einem Proxy, der die Dienste über ihre Docker-Adressen erreicht. Die README zeigt, wie Sie den Proxy einrichten und die OpenAPI-Dateien importieren.