Zum Hauptinhalt springen
Diese optionalen Dienste werden für den Betrieb von Overleaf nicht benötigt, helfen aber sehr beim Entwickeln, Debuggen und beim Untersuchen der Daten. Alle sind Teil der Entwicklungsumgebung, daher muss nichts zu docker-compose.yml hinzugefügt werden. Sobald Sie auf der Website angemeldet sind, verlinkt das Menü Dev tools in deren Navigationsleiste auf die Tools, die die Website unter eigenen Pfaden bereitstellt.
Keines dieser Tools hat eine Anmeldung: Die anonymen Benutzer von Grafana sind dessen Admins, und Mongo Express kann jedes Dokument ändern. Die Website, Hoppscotch, Mongo Express (8081) und RedisInsight (5540) lauschen nur auf 127.0.0.1 des Hosts, sodass andere Hosts sie nicht erreichen können.

Grafana

Grafana wird von der Website unter /grafana/ über webpack-dev-server bereitgestellt und braucht daher keinen eigenen Port. Sein Ordner Overleaf Develop enthält diese Dashboards:

All services: der Zustand jedes Dienstes, der Host und die Ressourcen, die jeder Dienst nutzt

Data flow: eine Bearbeitung auf dem Weg von document-updater über project-history zu history-v1 und Mongo

Prometheus fragt /metrics der Dienste, mongodb-exporter, redis-exporter, cadvisor und node-exporter ab; Alloy sendet die Logs jedes Containers des Projekts an Loki, wo die Filter Log search, Service und Log level der Dashboards sie lesen. Ihre Daten liegen nur in den Containern, daher werden sie beim Neuerstellen geleert. cAdvisor läuft privilegiert und liest /, /sys, die Docker-Daten und den containerd-Socket des Hosts schreibgeschützt; node-exporter liest / des Hosts. Die Dashboards werden generiert: Ändern Sie develop/grafana/make-dashboards und führen Sie es aus, anstatt die JSON-Dateien zu bearbeiten.

Mailpit

Mit MAILPIT_ENABLED=true sendet web jede E-Mail an Mailpit statt an einen echten Mailserver, und die E-Mail-Bestätigung ist aktiv (EMAIL_CONFIRMATION_DISABLED=false). Aktivierungslinks, Projekteinladungen, Passwortzurücksetzungen und Bestätigungscodes lassen sich dann aus dem Posteingang heraus aufrufen.

Eine Aktivierungs-E-Mail, eine Projekteinladung, ein Bestätigungscode und eine Passwortzurücksetzung in Mailpit

Mailpit hat kein Volume: Wird sein Container neu erstellt, ist der Posteingang leer.

Mongo Express

Mongo Express zeigt die Collections der Datenbank sharelatex und kann ihre Dokumente anzeigen, bearbeiten, importieren und exportieren.

Die Collections der Datenbank sharelatex in Mongo Express

RedisInsight

RedisInsight speichert seine Verbindungen in develop/data/redis-insight. Wählen Sie beim ersten Mal Connect existing database und geben Sie den Host redis und den Port 6379 ein.

RedisInsight, verbunden mit dem Dienst redis

Hoppscotch einrichten

API-Anfragen über einen Proxy

Hoppscotch sendet Anfragen aus dem Browser, der die Dienste nicht über ihre Docker-Namen erreichen kann. Sein Proxy, Proxyscotch, läuft im Docker-Netzwerk und wird unter /proxy der Hoppscotch-Adresse bereitgestellt. Öffnen Sie http://localhost:9170, gehen Sie zu Settings → Interceptor, wählen Sie Proxy und setzen Sie die Proxy URL auf http://localhost:9170/proxy. Die Einstellung bleibt im Browser gespeichert.

Die Interceptor-Einstellung. Der Screenshot stammt aus einer älteren Einrichtung: Verwenden Sie http://localhost:9170/proxy als Proxy URL.

Jetzt können Sie mit http://web:3000/status testen, ob der web-Dienst läuft:

Die Service-APIs importieren

develop/hoppscotch/openapi/ enthält für jeden Dienst eine OpenAPI-Datei seiner internen API. Öffnen Sie in Hoppscotch Collections → Import → Import from File und wählen Sie alle Dateien auf einmal aus. Jede Datei wird zu einer Collection, deren Anfragen an die Docker-Adresse des Dienstes gehen. Dieselben Dateien werden im Abschnitt Service-API angezeigt.

CSRF-Probleme

Wenn Sie mit Postman oder anderen Debugging-Werkzeugen eine POST-Anfrage erzeugen, stellen Sie möglicherweise fest, dass die Anmeldung verweigert wird, und zwar mit einem 403-Fehler. Das liegt daran, dass Overleaf durch eine CSRF-Prüfung geschützt ist.
In Ihrer Konsole sehen Sie möglicherweise:
Um dies bei Ihrer Overleaf-Entwicklung zu lösen, müssen Sie Ihr CSRF-Token einrichten. Hier ist die ausführliche Anleitung.
1

Pre-Request hinzufügen

Fügen Sie den folgenden Code als Pre-Request hinzu
Das Skript lautet wie folgt:
2

Request-Header hinzufügen

Sie müssen die folgenden Header hinzufügen:
3

Mit API-Werkzeugen anmelden

Jetzt können Sie sich mit Ihrem Benutzernamen und Passwort anmelden.
So sieht die Antwort aus, wenn Sie einen falschen Benutzernamen oder ein falsches Passwort eingeben.
Zuletzt geändert am 20. November 2026