文档站部署说明

本页记录当前正式文档站的实际部署方式。
当前线上版本运行在香港服务器，通过 Caddy 独立提供 docs.mycodexhub.xyz。

当前生产环境

• 文档地址：https://docs.mycodexhub.xyz/
• 控制台地址：https://sub2api.mycodexhub.xyz
• 源码目录：/opt/sub2api-docs
• 构建产物：/opt/sub2api-docs/docs/.vitepress/dist
• 发布目录：/var/www/sub2api-docs
• Web 服务器：Caddy

当前标准更新流程

1. 更新源码

修改 /opt/sub2api-docs/docs 和 /opt/sub2api-docs/docs/.vitepress/config.mts 中的内容。

2. 安装依赖并构建

cd /opt/sub2api-docs
npm install
npm run docs:build

3. 发布静态文件

sudo mkdir -p /var/www/sub2api-docs
sudo rsync -av --delete /opt/sub2api-docs/docs/.vitepress/dist/ /var/www/sub2api-docs/

4. 校验并重载 Caddy

sudo caddy validate --config /etc/caddy/Caddyfile
sudo systemctl reload caddy
sudo systemctl status caddy --no-pager

5. 验证站点

curl -I http://docs.mycodexhub.xyz/
curl -I https://docs.mycodexhub.xyz/

正常情况下，HTTP 会跳转到 HTTPS，HTTPS 会直接返回 200。

当前 Caddy 站点块

docs.mycodexhub.xyz {
    root * /var/www/sub2api-docs
    encode zstd gzip
    try_files {path} /index.html
    file_server
}

当前正式环境使用的就是这套 Caddy 配置，不再以 Cloudflare Pages、Vercel 或 Nginx 作为主发布方案。

DNS 与主站回填

• docs.mycodexhub.xyz 应解析到当前香港服务器
• 主站后台中的文档入口应指向 https://docs.mycodexhub.xyz/

如果主站有单独的 doc_url、帮助中心或文档入口字段，请保持与本页一致。

备用说明

未来如需迁移到其他静态托管平台，可以继续沿用 VitePress 构建产物；但当前正式站点以“香港服务器 + Caddy + 独立文档子域名”为准。