跳转到主要内容
这些可选服务不是运行 Overleaf 所必需的,但在开发、调试和查看数据时非常有用。它们都是开发环境的一部分,因此无需向 docker-compose.yml 添加任何内容。登录网站后,导航栏中的 Dev tools 菜单会链接到网站在自身路径上提供的工具。
这些工具都没有登录:Grafana 的匿名用户就是其管理员,Mongo Express 可以修改任何文档。网站、Hoppscotch、Mongo Express(8081)和 RedisInsight(5540)只监听主机的 127.0.0.1,因此其他主机无法访问它们。

Grafana

Grafana 由网站通过 webpack-dev-server 在 /grafana/ 上提供,因此不需要单独的端口。它的 Overleaf Develop 文件夹中有以下仪表板:

All services:每个服务的状态、主机以及每个服务使用的资源

Data flow:一次编辑从 document-updater 经 project-history 到 history-v1 和 Mongo 的过程

Prometheus 抓取各服务的 /metrics,以及 mongodb-exporter、redis-exporter、cadvisor 和 node-exporter;Alloy 将项目中每个容器的日志发送到 Loki,仪表板中的 Log search、Service 和 Log level 筛选器从那里读取。这些数据只存在于容器中,因此重新创建容器会将其清空。cAdvisor 以特权模式运行,以只读方式读取主机的 /、/sys、Docker 数据和 containerd 套接字;node-exporter 读取主机的 /。 仪表板是生成的:请修改 develop/grafana/make-dashboards 并运行它,而不要直接编辑 JSON 文件。

Mailpit

设置 MAILPIT_ENABLED=true 后,web 会把每封邮件发送到 Mailpit 而不是真实的邮件服务器,并且邮箱确认处于开启状态(EMAIL_CONFIRMATION_DISABLED=false)。这样就可以从收件箱中打开激活链接、项目邀请、密码重置和确认码。

Mailpit 中的激活邮件、项目邀请、确认码和密码重置

Mailpit 没有卷:重新创建其容器会清空收件箱。

Mongo Express

Mongo Express 显示 sharelatex 数据库中的集合,并可以查看、编辑、导入和导出其中的文档。

Mongo Express 中 sharelatex 数据库的集合

RedisInsight

RedisInsight 将其连接保存在 develop/data/redis-insight 中。首次使用时,选择 Connect existing database,并输入主机 redis 和端口 6379。

已连接到 redis 服务的 RedisInsight

设置 Hoppscotch

代理 API 请求

Hoppscotch 从浏览器发送请求,而浏览器无法通过 Docker 名称访问各服务。它的代理 Proxyscotch 运行在 Docker 网络内部,并在 Hoppscotch 地址的 /proxy 上提供。打开 http://localhost:9170,进入 Settings → Interceptor,选择 Proxy,并将 Proxy URL 设置为 http://localhost:9170/proxy。该设置会保存在浏览器中。

Interceptor 设置。截图来自旧的配置:请使用 http://localhost:9170/proxy 作为 Proxy URL。

现在你可以使用 http://web:3000/status 来测试 web 服务是否正常运行:

导入服务 API

develop/hoppscotch/openapi/ 中为每个服务的内部 API 提供了一个 OpenAPI 文件。在 Hoppscotch 中打开 Collections → Import → Import from File,并一次选择所有文件。每个文件都会成为一个集合,其请求发送到该服务的 Docker 地址。相同的文件也展示在 服务 API 部分中。

CSRF 问题

如果你使用 Postman 或其他调试工具发起 POST 请求,可能会发现登录被禁止,原因是 403 错误。这是因为 Overleaf 受到 CSRF 验证保护。
在控制台中,你可能会看到:
要在 Overleaf 开发中解决此问题,你需要设置 CSRF 令牌。以下是详细教程。
1

添加预请求脚本

将以下代码添加到 Pre-Request 中
脚本如下:
2

添加请求头

你需要添加以下请求头:
3

使用 API 工具登录

现在你可以使用用户名和密码登录。
以下是输入错误的用户名或密码时的响应。
最后修改于 2026年11月20日