NB文档doc.nbjs.ai
Caddy HTTPS / Caddy 前置自动 HTTPS

s2:Caddy 前置自动 HTTPS(全租户)

s2 由 Caddy 接管 80/443,nb 退到 127.0.0.1:3000。证书由 Caddy 按需(on-demand TLS)向 Let's Encrypt 签发,nb 只提供一个 ask 闸门决定"这个域名配不配签"。

拓扑:

浏览器 ──HTTPS──> Caddy :80/:443 ──HTTP──> nb 127.0.0.1:3000
                      │
                      └─ on_demand 首次握手 → GET /_nb/caddy/ask?domain=... → 200 才签发

1. nb 侧改动

platform.rs:

config.rs:

~/.nb/nb.toml 关键项:

[server]
port = 3000
app_domain = "nbjs.ai"
caddy_ask_token = "<TOKEN>"
# 不要配 tls_cert / tls_key,否则 nb 抢 443
open_deploy = false

3000 端口用防火墙限制为仅本机可达。

2. Caddyfile

见 nb/deploy/s2/Caddyfile。要点:

生成 token:

node -e "console.log(require('crypto').randomBytes(24).toString('hex'))"

3. 部署步骤(复刻用)

  1. 交叉编译(Windows):
cd nb
$env:PATH = "<python site-packages>\ziglang;$env:PATH"
$env:RUSTY_V8_MIRROR = 'https://ghproxy.net/https://github.com/denoland/rusty_v8/releases/download'
cargo zigbuild --release --target x86_64-unknown-linux-gnu
  1. 上传到 s2 的 /root/nb-caddy-deploy/:nb.new、Caddyfile、nb.toml、cutover.sh、rollback.sh、merge_nb_toml.py。
  1. 改配置:按上面写 ~/.nb/nb.toml(merge_nb_toml.py 会保留原有 [s3]、[mqtt] 等段,只替换 [server])。
  1. 安装并校验:
apt-get update -qq && DEBIAN_FRONTEND=noninteractive apt-get install -y -qq caddy
install -m 755 nb.new /usr/local/bin/nb
install -m 644 Caddyfile /etc/caddy/Caddyfile
caddy validate --config /etc/caddy/Caddyfile
  1. 切换:停 nginx 腾出 80,重启 nb,启动 Caddy:
systemctl stop nginx
systemctl restart nb
systemctl enable --now caddy
ss -lntp | grep -E ':(80|443|3000)\s'
  1. Cloudflare:把官方 A 记录(nbjs.ai、*.nbjs.ai、fallback.nbjs.ai)从橙云改成灰云(DNS only),仍指到 s2 IP。HTTP-01 要求 80 从公网可达。

回滚:bash /root/nb-caddy-deploy/rollback.sh <备份标签>,会恢复旧二进制/配置并重启 nginx + nb。

4. 首次访问时序

  1. 浏览器访问 https://foo.example.com/,DNS 指向 s2
  2. Caddy 没有匹配证书 → 回调 ask(?domain=foo.example.com)
  3. nb 查 domains.json / 官方子域规则,返回 200 或 403
  4. 200 → Caddy 走 ACME HTTP-01:LE 访问 http://foo.example.com/.well-known/acme-challenge/<token>,Caddy 在 80 应答
  5. 签发、存盘、完成握手。首次会慢几秒;之后直接复用缓存,不再 ask
  6. 到期前约 30 天 Caddy 自动续期,续期会再问一次 ask;域名从 domains.json 删掉后就不再续

未绑定的域名 ask 403,Caddy 直接拒绝握手,不会去 LE 签发。

5. 验证命令

# ask 端点(只允许回环)
curl 'http://127.0.0.1:3000/_nb/caddy/ask?token=<TOKEN>&domain=nbjs.ai'        # 200
curl 'http://127.0.0.1:3000/_nb/caddy/ask?token=<TOKEN>&domain=未绑定.com'      # 403

# 公网
curl -I https://nbjs.ai/_nb/health
curl -I https://<app>.nbjs.ai/
curl -I https://<已绑定自定义域名>/

# 平台接口不能公网访问
curl -I 'https://nbjs.ai/_nb/caddy/ask?token=<TOKEN>&domain=nbjs.ai'  # 404
curl -I -X POST https://nbjs.ai/run/<app>                              # 404

# 证书落盘与日志
ls /var/lib/caddy/.local/share/caddy/certificates
journalctl -u caddy -n 100 --no-pager | grep on_demand

6. 已知限制与后续