快速开始
简易安装
安装 CapRover 的推荐方式是使用 DigitalOcean 一键应用。CapRover 已作为 DigitalOcean Marketplace 的 One-Click 应用提供。
注意:如果你是 DigitalOcean 新用户,注册后的前两个月会获得 $100 免费额度。这足够支撑多台服务器跑两个月!
如果你使用这种方式,可以跳过下面的 前置条件 部分,以及 CapRover 安装配置 中的第 1 步!
前置条件
A) 域名
安装过程中,你需要把一个通配符 DNS 记录指向你的 CapRover IP 地址。成本低至每年 $2(或者甚至更低!)
你也可以在没有域名的情况下使用 CapRover,但将无法配置 HTTPS。
B) 服务器
B1) 公网 IP
补充说明:你可以在处于 NAT(路由器)之后的私有网络里,在笔记本上本地安装 CapRover。但如果你希望启用 HTTPS,和/或从私有网络外访问应用,就需要做一些特殊配置,例如端口转发。
在标准安装方式下,CapRover 必须安装在一台拥有公网 IP 的机器上。如果你需要了解公网 IP 的相关内容,请参阅服务器与公网 IP 地址。成本低至每月 $5。如果你使用 DigitalOcean 的推荐链接,你会获得 $100 额度,相当于两个月免费的服务器: https://m.do.co/c/6410aa23d3f3
B2) 服务器规格
CPU 架构: CapRover 源码兼容任何 CPU 架构;Docker Hub 上提供的镜像构建了 AMD64(x86)、ARM64 和 ARMV7 版本。
推荐组合: CapRover 在 Ubuntu 22.04 和 Docker 25+ 上进行了测试。如果你在其他系统上使用 CapRover,建议参考 Docker 文档。
Ubuntu 24.04: 该版本已被多人测试过,目前看起来没有已知问题。
最低内存: 注意构建过程有时会占用较多内存,512MB 可能不够(参见该 issue)。大多数云厂商的 $5 套餐通常至少提供 1GB 内存,例如 DigitalOcean、Vultr、Scaleway、Linode、SSD Nodes 等。
B3) Docker
你的服务器必须安装 Docker。如果你使用 DigitalOcean,可以直接选择带 CapRover 一键应用的服务器,系统会自动完成安装。否则,你可以按照该指南安装 Docker CE。注意 Docker 版本至少需要 25.x+。
避免使用 snap 安装:通过 snap 安装 Docker 存在 bug。请使用 Docker 官方安装指南。
B4) 配置防火墙
一些服务器提供商的防火墙规则比较严格。要在 Ubuntu 上放通端口可以执行:
ufw allow 80,443,3000,996,7946,4789,2377/tcp; ufw allow 7946,4789,2377/udp;如需更多信息,请参阅防火墙设置。
CapRover 安装配置
第 1 步:安装 CapRover
只需要运行下面这一行,然后坐下来等它完成即可!
docker run -p 80:80 -p 443:443 -p 3000:3000 -e ACCEPTED_TERMS=true -v /var/run/docker.sock:/var/run/docker.sock -v /captain:/captain caprover/caprover注意:不要修改端口映射。CapRover 只能在指定端口上正常工作。
你会在屏幕上看到一系列输出。CapRover 初始化完成后,你可以在浏览器中打开 http://[IP_OF_YOUR_SERVER]:3000,使用默认密码 captain42 登录。你稍后可以修改密码。但请不要在控制台界面里做任何改动,我们将使用命令行工具来完成服务器初始化(推荐)。
第 2 步:绑定根域名
假设你拥有 mydomain.com。你可以在 DNS 设置里添加一条 A 记录,将 *.something.mydomain.com 指向你安装 CapRover 的服务器 IP 地址。注意该变更可能需要数小时生效。DNS 配置看起来会类似这样:
- 类型: A 记录
- 主机:
*.something - 指向:(你的服务器 IP 地址)
- TTL:(通常无所谓)
为确认解析是否生效,请打开 MXToolbox DNS Lookup,输入 randomthing123.something.mydomain.com,检查解析出的 IP 是否与你在 DNS 中设置的一致。注意这里需要 randomthing123,因为你设置的是 *.something 的通配符记录,而不是 something。
注意:CapRover 要求 A 记录必须指向 CapRover 的 IP 地址。如果你使用 Cloudflare 等代理服务,可能会遇到困难。CapRover 官方并不支持这类用法。
第 3 步:配置并初始化 CapRover
使用 CLI(推荐)
假设你的本地机器(例如笔记本)已经安装了 npm,直接运行(如有需要可加 sudo):
npm install -g caprover然后运行:
caprover serversetup按照提示操作并登录你的 CapRover 实例。当提示输入根域名时,输入 something.mydomain.com(前提是你在第 2 步把 *.something.mydomain.com 指向了服务器 IP)。随后你可以通过 captain.something.mydomain.com 访问 CapRover。关于隐藏根域名的更多说明见这里。
注意:如果你已经在 CapRover 实例上强制启用了 HTTPS,则无法继续执行
caprover serversetup。 这种情况下请直接使用caprover login登录。要修改密码,请在应用的设置菜单中操作。
使用 Web 界面(不需要 npm)
- 登录
http://[IP_OF_YOUR_SERVER]:3000 - 配置根域名
- 启用 HTTPS,然后强制使用 HTTPS
- 通过 HTTPS 连接后,修改默认密码(
captain42)
第 4 步:(可选)设置 Swap 文件
在某些情况下,你可能会因为物理内存不足而遇到问题。 例如,在构建 Docker 镜像时,如果占用内存过高,构建可能会失败。 要在不额外购买内存的情况下缓解这一问题,你可以设置 Swap 文件(作为虚拟内存), 可参考这篇教程:How To Create A Linux Swap File。
第 5 步:部署测试应用
在浏览器中打开 CapRover,从左侧菜单选择 Apps 并创建一个新应用,命名为 my-first-app。然后从这里下载任意一个测试应用,解压后进入该测试应用目录,运行:
/home/Desktop/captain-examples/captain-node$ caprover deploy按照提示操作,当询问应用名称时输入 my-first-app。第一次构建大约需要两分钟。构建完成后,访问 my-first-app.something.mydomain.com(其中 something.mydomain.com 是你的根域名)。
恭喜!你的应用已上线!
你可以把多个自定义域名(例如 www.my-app.com)绑定到同一个应用,启用 HTTPS,并在应用的设置页面做更多配置。
注意:当你运行 caprover deploy 时,当前 git commit 会被发送到服务器。
重要:未提交的文件以及
gitignore中的文件不会被发送到服务器。
你可以在浏览器中访问 CapRover,为应用设置环境变量等自定义参数,并做更多操作!关于部署的更多细节,请参阅 CLI 文档。关于 captain-definition 文件的更多说明,请参阅 Captain Definition File。