跳到正文

在 CapRover 上部署 Kaeso

用仓库中的模板,以一键应用的形式,部署到您自己的服务器。共六个应用:一个公开边缘,位于 nginx 之后;PostgreSQL、ClickHouse 和 Valkey,在 Kaeso 旁边运行。

发布日期
阅读时间
4 分钟
作者
Kaeso Team
浓郁的橙色、粉色与紫色渐变,呈竖直的褶皱,如同帘幕,一角透着暖光

CapRover(在新标签页中打开) 通过一键模板安装应用,您也可以粘贴自己的模板。Kaeso 仓库中的 deploy/caprover/kaeso.yml 就是这样一个模板。它会在您的 CapRover 服务器上创建六个应用:CapRover 的 nginx 之后的公开边缘、私有网关和控制台,以及 Compose 软件包中的 PostgreSQL、ClickHouse 和 Valkey,全部固定为同一版本。

您会得到什么

  • kaeso
    镜像
    控制台镜像,运行 kaeso-edge
    谁能访问
    所有人,通过 nginx 访问应用的域名
  • kaeso-gateway
    镜像
    网关镜像
    谁能访问
    边缘服务
  • kaeso-console
    镜像
    控制台镜像
    谁能访问
    边缘服务
  • kaeso-postgres、kaeso-clickhouse、kaeso-valkey
    镜像
    与 Compose 软件包相同的版本
    谁能访问
    网关

这些名称跟随您给出的应用名,这里是 kaeso。只有边缘服务是 Web 应用;其他应用只能在 CapRover 的覆盖网络中访问。网关以 kaeso 身份登录 PostgreSQL,该用户拥有自己的数据库,但不是超级用户。Valkey 的数据保持在 512 MB 以内,从不驱逐任何键。

CapRover 的 nginx 会追加到调用方的 X-Forwarded-For 后面,所以边缘服务读取由 nginx 设置的 X-Real-IP,网关只信任私有地址。模板为边缘服务开启了 WebSocket 支持,这会让 nginx 以 HTTP/1.1 与它通信。

部署

  1. 生成主密钥,并保存在密码管理器中:

    docker run --rm ghcr.io/logicplanes/kaeso-gateway:0.6.0 master-key generate
  2. 在 CapRover 中依次打开 Apps 和 One-Click Apps/Databases,然后选择列表末尾的 >> TEMPLATE <<。

  3. 粘贴 prod 分支中的模板,该分支包含最新版本:

    https://raw.githubusercontent.com/logicplanes/kaeso/prod/deploy/caprover/kaeso.yml
  4. 填写表单:

    字段填写内容
    App namekaeso,或您自己取的名字
    Public URL应用在您根域名下的地址(表单会自动填写),或您自己的域名
    Master key第 1 步的密钥
    Passwords随机密码,表单会自动填写
    Mail transportsmtp 表示发送邮件;默认值 log 只记录每封邮件的类型
    Setup email, SMTP host, port, user, password, sender您的 SMTP 服务器,如果有的话
  5. 部署,等待各个应用创建完毕。在 PostgreSQL 和 Valkey 应答之前,网关会不断重启。

  6. 打开应用 kaeso,开启 HTTPS 和 Force HTTPS;如果 Public URL 用的是您自己的域名,再连接该域名。

  7. 打开设置链接,创建第一个用户。配置了 SMTP 时,链接会发到设置邮箱。没有配置时,在服务器上打印它:

    docker exec $(docker ps --quiet --filter name=srv-captain--kaeso-gateway) kaeso setup-link

更新和回滚

发布新版本会修改 kaeso.yml 中的镜像标签。在 kaeso-gateway、kaeso-console 和 kaeso 这三个应用中,分别打开 Deployment,按镜像名称用新标签部署,例如 ghcr.io/logicplanes/kaeso-gateway:0.6.0,先部署网关。网关在启动时迁移数据库,只向前进行。要回滚,用同样的方式部署之前的标签。

须知

  • CapRover 只会读取一键应用中的部分 Compose 字段。健康检查、移除的 capabilities、只读根文件系统和内存限制都不会作用到应用上,所以它们以镜像的默认设置运行。如果您想在自己的服务器上获得完整的加固,安装脚本可以提供。
  • nginx 默认等待回复 60 秒。流会发送保活,但不使用流式传输、耗时更长的请求会得到 504。如果需要更长时间,请在边缘应用的 nginx 配置中调大 proxy_read_timeout。
  • Kaeso 的更新器不在这里运行;每个版本都由您在 CapRover 中部署。

已验证的内容

模板可以解析,并且只使用 CapRover 会读取的字段。它尚未部署到 CapRover 服务器上。如果您部署了,请告诉我们结果如何。

下一步

作者:Kaeso Team

本页内容

网关归您。记录也归您。

curl -fsSLhttps://kaeso.app/install.sh | sh