部署托管服务器

把一台 Linux 主机变成 docdoc 托管服务器:先前台验证,再交给 systemd 常驻。

前置条件:主机已安装 docdoc(站内搜索 ?安装);规划好监听端口(默认 10001);需要 HTTPS 时先完成域名解析(站内搜索 ?启用 HTTPS)。

操作步骤

  1. 编写配置文件(示例路径 /etc/docdoc/config.yaml):

    service:
      host: 0.0.0.0
      port: 10001
      dataDir: /var/lib/docdoc
      token: 一段足够随机的访问令牌
      tls:
        enabled: false
    preview:
      host: 127.0.0.1
      port: 3000
    

    字段逐项说明见站内搜索 ?config.yaml。token 是管理接口(注册/删除站点)的 Bearer 令牌,务必保密。

  2. 前台启动验证:

    docdoc serve --config /etc/docdoc/config.yaml
    

    预期输出 docdoc serve 0.1.0 监听 http://0.0.0.0:10001(0 个站点)。

  3. 另开终端探活:curl http://127.0.0.1:10001/health 返回 200 即正常。回到前台终端 Ctrl+C 结束。

  4. 安装为系统服务并启动:

    docdoc service --config /etc/docdoc/config.yaml install
    docdoc service --config /etc/docdoc/config.yaml start
    
  5. 防火墙放通监听端口(如 10001);开启 TLS 时为 HTTPS 监听端口与 80(质询与跳转端口说明见站内搜索 ?启用 HTTPS)。

  6. 验证:curl https://<主机>:<端口>/api/v1/sites -H "Authorization: Bearer <令牌>" 返回空列表 [] 即服务就绪,可以开始注册站点。

运行期管理

  • 停止 / 启动:docdoc service --config /etc/docdoc/config.yaml stop 与 start
  • 查看日志:journalctl -u docdoc -f
  • 站点注册表与产物在 dataDir 下,进程重启后自动恢复