docdoc 文档

发布第一个站点

完成本任务后，你的文档站将可被公网访问。服务器侧用一键脚本装好托管服务，本地一条 add 命令注册上线。

前置条件：本地站点已写好并预览通过（站内搜索 ?第一个文档站）；有一台可 root 登录、公网可达的 Linux 服务器。

操作步骤

  1. 在服务器上执行一键安装（需先完成 gh auth login）：

    gh api repos/Xeegam/docdoc/contents/install.sh --jq .content | base64 -d | \
  DOCDOC_EMAIL=ops@example.com bash

    脚本安装 CLI、生成配置与随机管理令牌（/etc/docdoc/config.yaml，已存在则保留）、安装并启动 systemd 服务、放通防火墙端口。结束时输出健康检查与令牌位置——记下令牌。

  2. 在本地机器把源目录注册到服务器（绑域名时域名须已解析到服务器）：

    docdoc add --remote docdoc://<服务器IP或域名> ./my-docs --name my-docs --domain docs.example.com --token <令牌>

    终端输出「注册成功」即上线：绑定了域名用 https://<域名>/ 访问；未绑域名用 https://<服务器>/<站点名>/ 访问。

  3. 浏览器访问站点，核对侧栏、搜索与翻页都正常。

补充说明

  • 不使用 HTTPS 时加 DOCDOC_TLS_ENABLED=false DOCDOC_PORT=10001 重跑脚本（明文 HTTP 部署的完整说明见站内搜索 ?部署托管服务器）
  • 服务器参数（端口、数据目录、管理端口等）由环境变量在安装时定制，脚本行为的逐项说明见站内搜索 ?安装
  • 令牌忘了去服务器看 /etc/docdoc/config.yaml 的 service.token
  • 站点内容的后续更新见站内搜索 ?更新站点