服务器部署

仓库为私有,安装前需完成 gh 认证:gh auth login && gh auth setup-git。

pnpm add -g github:Xeegam/docdoc#path:/clis/docdoc
docdoc service --config ~/.config/docdoc/config.yaml install
docdoc service --config ~/.config/docdoc/config.yaml start

install 生成 systemd 单元并启用;start 启动服务。全局安装的 docdoc 同时充当单元的可执行文件与日常管理客户端。仓库根目录的 install.sh 一键完成安装、配置与服务启用(参数见用户手册,站内搜索 ?一键安装)。

环境要求

要求 说明
操作系统 Linux + systemd
运行时 Node 20+、pnpm 12+
TLS 启用时 HTTPS 端口与 HTTP 质询端口(Service.TLS.HTTPPort,缺省 80)公网可达

目录约定

路径 内容
~/.config/docdoc/config.yaml 默认配置文件
DataDir(默认 ~/.local/share/docdoc) 站点产物、注册表、证书

配置项说明见站内搜索 ?配置参考。