什么是 Overleaf 工具包？

Overleaf 工具包是建议用于本地部署 Community Edition、Server Pro 或 Overleaf Pro 的方法，它被设计为在最常见的环境中工作：单台物理服务器或虚拟机。该工具包使用 docker compose 来管理服务器的 Docker 容器，并提供一组封装 docker 命令的脚本，以帮助管理本地部署的 Overleaf 的更技术性方面。

该 bin/docker-compose 包装器

该 bin/docker-compose 脚本是对 docker compose的一个包装。它从 config/ 目录加载配置，然后调用 docker compose 并传入传递给脚本的任何参数。

您可以将 bin/docker-compose 视为安装在您机器上的 docker compose 程序的透明包装器。

示例：

检查正在运行的容器

$ bin/docker-compose ps

便捷助手

除了 bin/docker-compose之外，工具包还提供便捷脚本以辅助常见任务：

• bin/up：是 bin/docker-compose up

• bin/start：是 bin/docker-compose start

• bin/stop：是 bin/docker-compose stop

• bin/shell：在 sharelatex 容器内启动一个 shell

• bin/doctor：用于收集安装和部署信息的脚本。见下面的“检查服务器”部分

• bin/mongo：在 mongo 容器并切换到正确的数据库（sharelatex)

• bin/backup-config：创建当前配置的副本（zip 或 tar）并将其存储到您选择的目标目录中

• bin/logs：查看/追踪服务日志

• bin/error-logs：查看/追踪服务错误日志

• bin/rename-env-vars-5-0：用于在 config/variables.env 中更新环境变量的迁移脚本（从 ShareLaTeX 重新品牌为 Overleaf）

• bin/rename-rc-vars：用于在 config/overleaf.rc 中更新环境变量的迁移脚本（从 ShareLaTeX 重新品牌为 Overleaf）

• bin/run-script：用于简化运行存储在 sharelatex 容器内启动一个 shell

• bin/upgrade：协助实例升级。该脚本将检查工具包更新（通过 git）并提供拉取更改的选项，检查最新的 Docker 镜像版本并提供更新选项。它提供逐步确认、备份当前配置的选项，并处理停止/启动 Docker 服务。有关更多信息，请参见升级部署：https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment

如果您希望在不附加到 Docker 日志的情况下运行实例，可以运行 bin/up -d 以分离模式运行。

检查您的服务器

Overleaf 工具包包含一个名为 bin/doctor 的方便脚本，该脚本会生成一份报告，指出任何未满足的依赖项。

继续之前，运行 bin/doctor 脚本并检查一切是否正常：

运行 Overleaf Doctor

bin/doctor

示例输出（已截断/示例）：

来自 bin/doctor 的示例输出

====== Overleaf Doctor ======
- 主机信息
    - Linux
    - 'lsb_release -a' 的输出：
            没有可用的 LSB 模块。
            发行商 ID：     Ubuntu
            描述：        Ubuntu 22.04.5 LTS
            发行版：    22.04
            代号：   jammy
- 依赖项
    - bash
        - 状态： 存在
        - 版本信息： 5.1.16(1)-release
    - docker
        - 状态： 存在
        - 版本信息：Docker version 27.3.1, build ce12230
    - realpath
        - 状态： 存在
        - 版本信息：realpath (GNU coreutils) 8.32
    - perl
        - 状态： 存在
        - 版本信息：5.034000
    - awk
        - 状态： 存在
        - 版本信息：GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1)
    - openssl
        - 状态： 存在
        - 版本信息：OpenSSL 3.0.2 15 Mar 2022 (Library: OpenSSL 3.0.2 15 Mar 2022)
    - docker compose
        - 状态： 存在
        - 版本信息：Docker Compose version v2.29.7
- Docker 守护进程
    - 状态： 运行中
====== 配置 ======
- config/version
    - 状态： 存在
    - 版本： 5.1.1
- config/overleaf.rc
    - 状态： 存在
    - 值
        - OVERLEAF_DATA_PATH: data/overleaf
        - OVERLEAF_LOG_PATH: data/overleaf/logs
        - SERVER_PRO: true
            - 已登录到 quay.io： true
        - SIBLING_CONTAINERS_ENABLED: true
        - OVERLEAF_LISTEN_IP: 0.0.0.0
        - OVERLEAF_PORT: 80
        - MONGO_ENABLED: true
        - MONGO_IMAGE: mongo
        - MONGO_VERSION: 6.0
        - MONGO_DATA_PATH: data/mongo
        - REDIS_ENABLED: true
        - REDIS_IMAGE: redis:6.2
        - REDIS_DATA_PATH: data/redis
- config/variables.env
    - 状态： 存在
    - 值
        - OVERLEAF_FILESTORE_BACKEND: fs
        - OVERLEAF_HISTORY_BACKEND: fs
====== 警告 ======
- 无，全部良好
====== 结束 ======

如果缺少任何依赖项，doctor 将打印警告。如果遇到问题，首先运行 bin/doctor 并检查其输出是否有警告。

• 免费 Community Edition 的用户应在 GitHub 上提交 issue：https://github.com/overleaf/toolkit/issues

• Server Pro 的用户应联系支持：mailto:[email protected]

在两种情况下，请在您的消息中包含 bin/doctor 的输出。