水平扩展

从 3.5.6 版本开始，Server Pro 支持横向扩展。

本文档列出了技术要求并提供了在多个节点上运行 Server Pro 的指南。

从 Server CE/Server Pro 开始 5.0.3 主机上将写入编译数据的位置 从 Overleaf CE/Server Pro 开始 直接升级到 环境变量已将前缀由.

SHARELATEX_* 重新命名为 版本（或更早）请确保相应地为变量添加前缀（例如， SHARELATEX_SITE_URL 而不是 OVERLEAF_SITE_URL)

设置横向扩展需要大量工作。我们建议在达到一定规模时考虑横向扩展， 仅 例如，一个用于 1000 名总用户的 Server Pro 安装已成功在单台服务器上部署，该服务器配备两个四核处理器和 32GB 系统内存。请参阅 硬件要求 文档以获取建议。

采用横向扩展的 Server Pro 部署涉及一组外部组件，例如负载均衡器和兼容 S3 的存储后端。

我们可以帮助排查可能由错误配置引起的 Server Pro 容器中的错误，并根据本文档提供一般性建议。不幸的是，我们无法提供第三方应用/系统的配置协助。

解决与您的硬件/软件相关的特定技术问题以提供外部组件不在我们的支持条款覆盖范围内。

要求

外部集中式数据存储

Server Pro 中的数据存储可以分为四个数据存储：

• MongoDB

  • 大多数数据持久化到 MongoDB。

  • 我们支持本地实例或外部实例，例如 MongoDB Atlas（在 AWS 基础设施中运行的完全托管 MongoDB 服务）。

  注意： 不幸的是，目前没有对兼容 MongoDB 的数据库（例如 CosmoDB/DocumentDB）的官方支持，因为我们尚未使用它们测试 Server Pro。虽然使用兼容数据库部署 Server Pro 可能 是可行的，但我们仅官方支持使用 MongoDB 的部署。

• Redis

  • Redis 存储临时数据，例如在刷新到 MongoDB 之前的待处理文档更新。

  • Redis 用于在不同服务之间通信文档更新并在给定项目中通知编辑器有关状态更改。

  • Redis 用于存储用户会话。

  • 我们支持本地实例或外部实例。

  注意： 不幸的是，目前没有对兼容 Redis 的键/值存储（例如 KeyDB/Valkey）的官方支持，因为我们尚未使用它们测试 Server Pro。虽然使用兼容存储部署 Server Pro 可能 可能可行，但我们仅官方支持使用 Redis 的部署。

• 项目文件和历史文件

  • 不可编辑的项目文件存储在 MongoDB 之外。

    新的项目历史系统（Server Pro 3.5 起）也将历史存储在 MongoDB 之外。

  • 对于小型单实例，我们支持本地文件系统（可以由本地 SSD、NFS 或 EBS 提供支持）或 兼容 S3 的数据存储系统.

  • 对于横向扩展，我们 仅 支持兼容 S3 的数据存储系统。

  重要： NFS/Amazon EFS/Amazon EBS 是 不要 支持用于横向扩展的。有关详细信息，请参阅 硬件存储 关于在 Server Pro 中扩展存储的要求部分以获取更多细节。

• 临时文件

  • LaTeX 编译需要在快速、本地磁盘上运行以获得最佳性能。编译输出不需要持久化或备份。

  • 新文件上传的缓冲和项目 zip 文件的创建也受益于使用本地磁盘。

我们强烈建议使用本地磁盘。使用任何类型的网络磁盘（例如 NFS 或 EBS）可能导致意外的编译错误和其他性能问题。

Git-bridge

从 4.0.1 版本开始，Server Pro 提供 Git-bridge。

git 仓库存储在本地磁盘上。没有可用的复制选项。git-bridge 应作为一个 单例。为了获得最佳性能，我们建议为 git-bridge 数据使用本地磁盘。git-bridge 的数据磁盘应定期备份。

对于具有横向扩展的数据存储，您需要：

• 一个可被所有 Server Pro 实例访问的集中式 MongoDB 实例

• 一个可被所有 Server Pro 实例访问的集中式 Redis 实例

• 一个用于项目和历史文件的集中式兼容 S3 的存储后端

• 每个实例上的用于临时文件的本地磁盘

• 托管 git-bridge 容器的实例上的用于 git-bridge 数据的本地磁盘

负载均衡器要求

• 持久路由，例如使用 cookie

  此要求来自以下组件：

  • Server Pro 的实时编辑功能使用 WebSockets，并回退到 XHR 轮询。每个编辑会话在服务器端具有局部状态，给定编辑会话的请求始终需要路由到相同的 Server Pro 实例。协作功能使用 Redis Pub/Sub 在多个 Server Pro 实例之间共享更新。

  • LaTeX 编译将输出和编译缓存保存在本地以提升性能。在向某个 Server Pro 实例发出编译请求后，随后的 PDF/日志下载请求需要路由到相同的 Server Pro 实例。

• 长请求超时 以支持大规模 LaTeX 文档的编译

• WebSocket 支持 以获得最佳性能

• POST 有效负载大小为 50MB

• Keep-alive 超时 必须低于 Server Pro 的 keep-alive 超时

  Server Pro 中的 keep-alive 超时可以使用环境变量进行配置 NGINX_KEEPALIVE_TIMEOUT。默认值为 65 秒。

  在默认情况下，负载均衡器中 60 秒的 keep-alive 超时可用。

  使用 NGINX_KEEPALIVE_TIMEOUT=120，负载均衡器可以选择 115 秒。

• 客户端 IP

  设置请求头 X-Forwarded-For 为客户端 IP。

• 当 终止 SSL

  负载均衡器需要添加请求头 X-Forwarded-Proto: https.

HAProxy 示例配置

global
  group haproxy
  user haproxy

  # 详细日志
  log stdout format raw local0 debug

defaults
  mode                    http
  option                  httpchk HEAD /status
  http-check              expect status 200
  default-server          check

  # 详细日志
  log                     global
  option                  httplog

  # 如果粘性后端不可用则重路由到不同后端
  option                  redispatch 1
  # 这些重试用于 TCP 连接错误，而不是用于 HTTP 状态 500 的响应
  retries                 3

  # 对于 24 小时不活动的粘性会话 -- 编译输出在 24 小时后被删除
  cookie                  server-pro-ha insert maxidle 24h

  # 尝试连接任何后端 1 分钟，然后返回 503
  timeout queue           1m
  # 给 Server Pro 实例 15 秒启动时间
  timeout connect         15s

  # 中止来自非常慢的客户端的请求（在读取请求时允许 1 分钟的不活动时间）
  timeout client          1m

  # 允许慢编译 -- clsi 中的硬编码限制为 10 分钟
  timeout server          10m

  # 在 23 小时后断开编辑器连接 -- 比他们昨天最后一次使用提前 1 小时
  timeout tunnel          23h

  # 注意：haproxy 中的 keepalive 行为与 Server Pro 的默认 keepalive 设置配合良好。
  #       Haproxy 在后台清理连接，并在需要时重新分发请求。

listen server-pro-ha-http
  bind :80
  http-request redirect scheme https unless { ssl_fc }

listen server-pro-ha-https
  bind :443 ssl crt /etc/ssl/certs/ssl-key-and-certificate-bundle.pem

  # 告诉应用我们位于 https 之后
  http-request set-header X-Forwarded-Proto https

  # 告诉应用实际的客户端 IP
  option forwardfor

  # 参见 https://hstspreload.org/#deployment-recommendations
  http-response set-header Strict-Transport-Security "max-age=63072000; includeSubDomains; preload;"

  # 将 git 流量路由到 git-bridge 的同级容器
  use-server server-pro-ha-1 if { path_beg /git/ }

  # 调试
  http-response add-header X-Served-By %s
  stats enable
  stats uri /haproxy

  server server-pro-ha-1 198.18.1.1:80 cookie server-pro-ha-1
  server server-pro-ha-2 198.18.1.2:80 cookie server-pro-ha-2
  server server-pro-ha-3 198.18.1.3:80 cookie server-pro-ha-3

Server Pro 配置

密钥/秘密

Server Pro 实例需要就共享密钥达成一致：

• WEB_API_PASSWORD （Web API 认证）

• STAGING_PASSWORD 和 V1_HISTORY_PASSWORD 相同的值（历史认证）

• CRYPTO_RANDOM （用于会话 cookie）

• OT_JWT_AUTH_KEY （历史认证）

所有这些密钥需要用各自唯一的值配置并在实例之间共享。

如果未配置且用户请求被路由到不同的 Server Pro 实例，他们的请求将无法通过认证检查，用户可能会频繁被重定向到登录页面或其在 UI 中的操作会以意外方式失败。

如果未配置，Server Pro 会基于来自 /dev/urandom 的 32 字节随机数为每个密钥使用新的随机值（256 位随机数）。

# https://github.com/overleaf/overleaf/blob/45ca0f796c679103efd305ddbef28073c4a5de32/server-ce/init_scripts/00_regen_sharelatex_secrets.sh#L14
dd if=/dev/urandom bs=1 count=32 2>/dev/null | base64 -w 0 | rev | cut -b 2- | rev | tr -d '\n+/'

MongoDB

指向 OVERLEAF_MONGO_URL (如果您正在使用 对于 版本 重新命名为 及更早版本）指向集中式 MongoDB 实例。

Redis

指向 OVERLEAF_REDIS_HOST (SHARELATEX_REDIS_HOST 对于 版本 重新命名为 及更早）和 REDIS_HOST 指向集中式 Redis 实例。

用于项目和历史文件的兼容 S3 存储

请参阅有关 兼容 S3 的存储 的文档以获取详细信息。

临时文件

默认将本地 SSD 绑定挂载到 /var/lib/overleaf (/var/lib/sharelatex 对于 版本 重新命名为 及更早）将足够。请确保将 DOCKER_RUNNER 指向主机上的挂载点。

我们强烈建议使用本地磁盘。使用任何类型的网络磁盘（例如 NFS 或 EBS）可能导致意外的编译错误和其他性能问题。

代理配置

• 设置 OVERLEAF_BEHIND_PROXY=true (SHARELATEX_BEHIND_PROXY 对于 版本 重新命名为 及更早）以获取准确的客户端 IP。

• 设置 TRUSTED_PROXY_IPS 为负载均衡器的 IP（可以指定多个 CIDR，逗号分隔）。

Git-bridge 集成

从 4.0.1 版本开始，Server Pro 提供 Git-bridge。

git-bridge 容器需要一个同级的 Server Pro 容器来处理传入的 git 请求。该同级容器也可以处理常规用户流量。在示例配置中，第一个实例作为 git-bridge 的同级容器，但实际上任何实例都可以充当该角色。

为什么需要将一个 Server Pro 容器指定为 git-bridge 的同级？Server Pro 会为历史服务向 git-bridge 提供下载 URL。我们需要将这些历史 URL 配置为 git-bridge 容器可访问。

Server Pro 容器配置：

• 设置 GIT_BRIDGE_ENABLED 直接升级到 ‘true’

• 设置 GIT_BRIDGE_HOST 直接升级到 <git-bridge 容器名称> 例如， git-bridge

• 设置 GIT_BRIDGE_PORT 直接升级到 8000

• 设置 V1_HISTORY_URL 直接升级到 http://<server-pro 同级容器名称>:3100/api.

  注意：这只需要在作为 git-bridge 同级容器的实例上配置。其他实例可以使用本地主机 URL，这也是默认值。

git-bridge 容器配置：

• 设置 GIT_BRIDGE_API_BASE_URL 直接升级到 http://<server-pro 同级容器名称>/api/v0中的值，例如 http://server-pro-ha-1/api/v0

• 设置 GIT_BRIDGE_OAUTH2_SERVER 直接升级到 http://<server-pro 同级容器名称>中的值，例如 http://server-pro-ha-1

• 设置 GIT_BRIDGE_POSTBACK_BASE_URL 直接升级到 http://<git-bridge 容器名称>:8000中的值，例如 http://git-bridge:8000

• 设置 GIT_BRIDGE_ROOT_DIR 指向绑定挂载的 git-bridge 数据磁盘，例如， /data/git-bridge

示例 docker-compose.yml 配置

以下配置展示了一个自包含的设置。要使演示工作，您需要提供有效的 SSL 密钥/证书并调整 OVERLEAF_SITE_URL (SHARELATEX_SITE_URL 对于 版本 重新命名为 及更早）。对于实际部署，您必须将示例中的虚拟密钥替换为实际密钥。如用于实际部署，您需要将各个容器移到专用节点并根据本地网络设置调整 IP 地址。

version: '2.2'

# 实际横向扩展设置：选择您自己的网络并在配置中替换 IP。
networks:
    default:
        ipam:
            config:
                # 该子网是用于基准测试的保留子网的一部分
                # https://tools.ietf.org/html/rfc2544
                # 完整子网为 198.18.0.0/15
                # 对于 lb 和 dbs 使用 198.18.0.0/24
                # 对于 server-pro 使用 198.18.1.0/24
                # 对于临时容器使用 198.18.0.128/25
                - gateway: 198.18.0.1
                  ip_range: 198.18.0.128/25
                  subnet: 198.18.0.0/23

services：
    # 实际横向扩展设置：在单独主机上将 haproxy 运行在 Docker 之外。
    lb:
        image: haproxy:2.6
        container_name: lb
        user: root
        logging:
            driver: local
            options:
                max-size: 10g
                max-file: '100'
        卷：
            - ./haproxy.conf:/usr/local/etc/haproxy/haproxy.cfg
            # $ cat certificate.pem key.pem > ssl-key-and-certificate-bundle.pem
            - /path/to/ssl-key-and-certificate-bundle.pem:/etc/ssl/certs/ssl-key-and-certificate-bundle.pem
        # “ports”的替代：使用主机网络以避免 docker-proxy 开销
        network_mode: host

        # “network_mode: host”的替代：使用 docker-proxy 以实现网络隔离
        # ports:
        #     - "80:80"
        #     - "443:443"
        # networks:
        #     default:
        #         ipv4_address: 198.18.0.2

        # 实际横向扩展设置：移除这些，因为它们在其他主机上运行。
        depends_on:
            server-pro-ha-1:
                condition: service_started
            server-pro-ha-2:
                condition: service_started
            server-pro-ha-3:
                condition: service_started

    # 实际横向扩展设置：将此容器与 server-pro-ha-1 一起运行。
    # 适用于 Server Pro 4.0 及以后版本。
    git-bridge：
        restart: always
        # 标签应与 `server-pro-ha-1` 容器的标签匹配。
        image: quay.io/sharelatex/git-bridge:4.0.1
        卷：
            # 实际横向扩展设置：将 /data/git-bridge 指向专用的本地 SSD。
            - ~/git_bridge_data:/data/git-bridge
        container_name: git-bridge
        环境：
            GIT_BRIDGE_API_BASE_URL: "http://server-pro-ha-1/api/v0"
            GIT_BRIDGE_OAUTH2_SERVER: "http://server-pro-ha-1"
            GIT_BRIDGE_POSTBACK_BASE_URL: "http://198.18.0.6:8000"
            GIT_BRIDGE_ROOT_DIR: "/data/git-bridge"
        user: root
        command: ["/server-pro-start.sh"]

        # 实际横向扩展设置：在主机 198.18.0.6 上运行并暴露端口
        # ports:
        #     - "8000:8000"
        networks:
            default:
                ipv4_address: 198.18.0.6

    # 实际横向扩展设置：在单独主机上运行此容器。
    server-pro-ha-1: &server-pro-ha-config
        restart: always
        image: quay.io/sharelatex/sharelatex-pro:4.0.1
        container_name: server-pro-ha-1
        hostname: server-pro-ha-1
        depends_on:
            # 实际横向扩展设置：保留此条目。
            git-bridge：
                condition: service_started

            # 实际横向扩展设置：移除下面的条目，因为它们在其他主机上运行。
            mongo：
                condition: service_healthy
            redis：
                condition: service_started
            minio:
                condition: service_started
            mongo_replica_set_setup:
                condition: service_completed_successfully
            minio_setup:
                condition: service_completed_successfully
        stop_grace_period: 60s
        卷：
            - /tmp/scratch-disk1:/var/lib/sharelatex
            版本（或更早），请确保变量前缀相应（例如
        environment: &server-pro-ha-environment
            # 实际横向扩展设置：提供您自己的域/应用名称。
            OVERLEAF_SITE_URL: 'https://overleaf.example.com'
            OVERLEAF_APP_NAME: Server Pro 横向扩展演示

            OVERLEAF_MONGO_URL: mongodb://198.18.0.3/sharelatex
            OVERLEAF_REDIS_HOST: 198.18.0.4
            REDIS_HOST: 198.18.0.4

            ENABLED_LINKED_FILE_TYPES: 'project_file,project_output_file'
            EMAIL_CONFIRMATION_DISABLED: 'true'

            SANDBOXED_COMPILES: 'true'
            SANDBOXED_COMPILES_SIBLING_CONTAINERS: 'true'
            SANDBOXED_COMPILES_HOST_DIR: '/tmp/scratch-disk1/data/compiles'

            # S3
            # 实际横向扩展设置：选择安全的凭证。
            OVERLEAF_FILESTORE_BACKEND: s3
            OVERLEAF_FILESTORE_USER_FILES_BUCKET_NAME: overleaf-user-files
            OVERLEAF_FILESTORE_TEMPLATE_FILES_BUCKET_NAME: overleaf-template-files
            OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID: OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID
            OVERLEAF_FILESTORE_S3_SECRET_ACCESS_KEY: OVERLEAF_FILESTORE_S3_SECRET_ACCESS_KEY
            OVERLEAF_FILESTORE_S3_ENDPOINT: http://198.18.0.5:9000
            OVERLEAF_FILESTORE_S3_PATH_STYLE: 'true'
            OVERLEAF_FILESTORE_S3_REGION: ''

            OVERLEAF_HISTORY_BACKEND: "s3"
            OVERLEAF_HISTORY_PROJECT_BLOBS_BUCKET: "overleaf-project-blobs"
            OVERLEAF_HISTORY_CHUNKS_BUCKET: "overleaf-chunks"
            OVERLEAF_HISTORY_S3_ACCESS_KEY_ID: "OVERLEAF_HISTORY_S3_ACCESS_KEY_ID"
            OVERLEAF_HISTORY_S3_SECRET_ACCESS_KEY: "OVERLEAF_HISTORY_S3_SECRET_ACCESS_KEY"
            OVERLEAF_HISTORY_S3_ENDPOINT: http://198.18.0.5:9000
            OVERLEAF_HISTORY_S3_PATH_STYLE: 'true'
            OVERLEAF_HISTORY_S3_REGION: ''
            # /S3

            # git-bridge
            GIT_BRIDGE_ENABLED: 'true'
            GIT_BRIDGE_HOST: 198.18.0.6
            GIT_BRIDGE_PORT: 8000
            # 仅在 git-bridge 的同级实例上需要
            V1_HISTORY_URL: "http://server-pro-ha-1:3100/api"
            # /git-bridge

            # 横向扩展
            # 实际横向扩展设置：选择安全的凭证。
            WEB_API_PASSWORD: WEB_API_PASSWORD
            STAGING_PASSWORD: V1_HISTORY_PASSWORD
            V1_HISTORY_PASSWORD: V1_HISTORY_PASSWORD
            CRYPTO_RANDOM: CRYPTO_RANDOM
            OT_JWT_AUTH_KEY: OT_JWT_AUTH_KEY
            OVERLEAF_BEHIND_PROXY: 'true'
            # 实际横向扩展设置：负载均衡器的 IP
            TRUSTED_PROXY_IPS: 198.18.0.1,198.18.0.2
            # /横向扩展

        # 实际横向扩展设置：在主机 198.18.1.1 上运行并暴露端口
        # ports:
        #     - "80:80"
        networks:
            default:
                ipv4_address: 198.18.1.1

    # 实际横向扩展设置：在单独主机上运行此容器。
    server-pro-ha-2:
        <<: *server-pro-ha-config
        hostname: server-pro-ha-2
        container_name: server-pro-ha-2
        卷：
            - /tmp/scratch-disk2:/var/lib/sharelatex
            版本（或更早），请确保变量前缀相应（例如
        环境：
            <<: *server-pro-ha-environment
            SANDBOXED_COMPILES_HOST_DIR: '/tmp/scratch-disk2/data/compiles'
            V1_HISTORY_URL: "http://localhost:3100/api"

        # 实际横向扩展设置：在主机 198.18.1.2 上运行并暴露端口
        # ports:
        #     - "80:80"
        networks:
            default:
                ipv4_address: 198.18.1.2

    # 实际横向扩展设置：在单独主机上运行此容器。
    server-pro-ha-3:
        <<: *server-pro-ha-config
        hostname: server-pro-ha-3
        container_name: server-pro-ha-3
        卷：
            - /tmp/scratch-disk3:/var/lib/sharelatex
            版本（或更早），请确保变量前缀相应（例如
        环境：
            <<: *server-pro-ha-environment
            SANDBOXED_COMPILES_HOST_DIR: '/tmp/scratch-disk3/data/compiles'
            V1_HISTORY_URL: "http://localhost:3100/api"

        # 实际横向扩展设置：在主机 198.18.1.3 上运行并暴露端口
        # ports:
        #     - "80:80"
        networks:
            default:
                ipv4_address: 198.18.1.3

    # 实际横向扩展设置：在单独主机上运行此容器。
    minio:
        image: minio/minio:RELEASE.2023-05-18T00-05-36Z
        container_name: minio
        command: server /data
        卷：
            # 实际横向扩展设置：使用多个磁盘运行 minio，参见 minio 文档。
            - ~/minio_data:/data
        环境：
            # 实际横向扩展设置：选择安全的凭证。
            MINIO_ROOT_USER: MINIO_ROOT_USER
            MINIO_ROOT_PASSWORD: MINIO_ROOT_PASSWORD

        # 实际横向扩展设置：在主机 198.18.0.5 上运行并暴露端口
        # ports:
        #     - "9000:9000"
        networks:
            default:
                ipv4_address: 198.18.0.5

    # 实际横向扩展设置：在单独主机上仅运行此设置一次。
    minio_setup:
        depends_on:
            - minio
        image: minio/mc:RELEASE.2023-05-18T16-59-00Z
        entrypoint: sh
        命令：
            - '-c'
            # 实际横向扩展设置：选择安全的凭证。
            - |
                mc alias set s3 http://198.18.0.5:9000 MINIO_ROOT_USER MINIO_ROOT_PASSWORD \
                || sleep 10 && \
                mc alias set s3 http://198.18.0.5:9000 MINIO_ROOT_USER MINIO_ROOT_PASSWORD \
                || sleep 10 && \
                mc alias set s3 http://198.18.0.5:9000 MINIO_ROOT_USER MINIO_ROOT_PASSWORD \
                || sleep 10 && \
                mc alias set s3 http://198.18.0.5:9000 MINIO_ROOT_USER MINIO_ROOT_PASSWORD

                mc mb --ignore-existing s3/overleaf-user-files
                mc mb --ignore-existing s3/overleaf-template-files
                mc admin user add s3 \
                  OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID \
                  OVERLEAF_FILESTORE_S3_SECRET_ACCESS_KEY

                mc mb --ignore-existing s3/overleaf-project-blobs
                mc mb --ignore-existing s3/overleaf-chunks
                mc admin user add s3 \
                  OVERLEAF_HISTORY_S3_ACCESS_KEY_ID \
                  OVERLEAF_HISTORY_S3_SECRET_ACCESS_KEY

                echo '
                  {
                    "Version": "2012-10-17",
                    "Statement": [
                      {
                        "Effect": "Allow",
                        "Action": [
                          "s3:ListBucket"
                        ],
                        "Resource": "arn:aws:s3:::overleaf-user-files"
                      },
                      {
                        "Effect": "Allow",
                        "Action": [
                          "s3:PutObject",
                          "s3:GetObject",
                          "s3:DeleteObject"
                        ],
                        "Resource": "arn:aws:s3:::overleaf-user-files/*"
                      },
                      {
                        "Effect": "Allow",
                        "Action": [
                          "s3:ListBucket"
                        ],
                        "Resource": "arn:aws:s3:::overleaf-template-files"
                      },
                      {
                        "Effect": "Allow",
                        "Action": [
                          "s3:PutObject",
                          "s3:GetObject",
                          "s3:DeleteObject"
                        ],
                        "Resource": "arn:aws:s3:::overleaf-template-files/*"
                      }
                    ]
                  }' > policy-filestore.json

                echo '
                  {
                    "Version": "2012-10-17",
                    "Statement": [
                      {
                        "Effect": "Allow",
                        "Action": [
                          "s3:ListBucket"
                        ],
                        "Resource": "arn:aws:s3:::overleaf-project-blobs"
                      },
                      {
                        "Effect": "Allow",
                        "Action": [
                          "s3:PutObject",
                          "s3:GetObject",
                          "s3:DeleteObject"
                        ],
                        "Resource": "arn:aws:s3:::overleaf-project-blobs/*"
                      },
                      {
                        "Effect": "Allow",
                        "Action": [
                          "s3:ListBucket"
                        ],
                        "Resource": "arn:aws:s3:::overleaf-chunks"
                      },
                      {
                        "Effect": "Allow",
                        "Action": [
                          "s3:PutObject",
                          "s3:GetObject",
                          "s3:DeleteObject"
                        ],
                        "Resource": "arn:aws:s3:::overleaf-chunks/*"
                      }
                    ]
                  }' > policy-history.json

                # 将上一节策略的内容放入 policy-filestore.json
                # 提示：相应地替换桶名称。
                mc admin policy create s3 overleaf-filestore policy-filestore.json
                mc admin policy attach s3 overleaf-filestore \
                  --user=OVERLEAF_FILESTORE_S3_ACCESS_KEY_ID || true

                mc admin policy create s3 overleaf-history policy-history.json
                mc admin policy attach s3 overleaf-history \
                  --user=OVERLEAF_HISTORY_S3_ACCESS_KEY_ID || true

    # 实际横向扩展设置：在单独主机上运行此容器。
    mongo：
        restart: always
        image: mongo:4.4
        container_name: mongo
        command: "--replSet overleaf"
        expose：
            - 27017
        卷：
            - ~/mongo_data:/data/db
        healthcheck:
            test: echo 'db.stats().ok' | mongo localhost:27017/test --quiet
            interval: 10s
            timeout: 10s
            retries: 5

        # 实际横向扩展设置：在主机 198.18.0.3 上运行并暴露端口
        # ports:
        #     - "27017:27017"
        networks:
            default:
                ipv4_address: 198.18.0.3

    mongo_replica_set_setup:
        image: mongo:4.4
        entrypoint: sh
        depends_on:
            mongo：
                condition: service_healthy
        命令：
            - '-c'
            - |
                mongo 198.18.0.3 --eval "rs.initiate({ _id: \"overleaf\", members: [ { _id: 0, host: \"198.18.0.3:27017\" } ] })"

    # 实际横向扩展设置：在单独主机上运行此容器。
    redis：
        restart: always
        image: redis:6.2
        container_name: redis
        expose：
            - 6379
        卷：
            - ~/redis_data:/data

        # 实际横向扩展设置：在主机 198.18.0.4 上运行并暴露端口
        # ports:
        #     - "6379:6379"
        networks:
            default:
                ipv4_address: 198.18.0.4

硬件

我们建议对参与横向扩展的所有 Server Pro 实例使用相同的硬件规格。

有关通用建议的 硬件规格 适用于 Server Pro 实例。

升级 Server Pro

作为升级过程的一部分，Server Pro 会自动运行数据库迁移。这些迁移被 不要 设计为可以从多个实例并行运行。

迁移需要在实际 Web 应用启动之前完成。您可以检查日志中是否有一条 已完成迁移 的条目，或等待应用接受流量。

升级过程如下：

1. 安排维护窗口

2. 停止所有 Server Pro 实例

3. 按照 文档进行一致性备份

4. 启动一个带有新版本的单个 Server Pro 实例

5. 验证新实例按预期工作

6. 以新版本启动其他实例