入门指南

系统要求

• 64 位 Linux 服务器或 Docker Desktop 环境。
• 至少 4 GB RAM。
• Docker Engine 和 Docker Compose v2。
• 生产使用需要有效的 ComPDF License Key。

获取项目

克隆项目仓库并进入目录：

git clone https://github.com/ComPDFKit/compdf-self-hosted.git
cd compdf-self-hosted

配置环境

在启动服务前，需要准备环境配置文件。复制默认配置文件：

cp .env.example .env

.env 文件中默认内置了免费版 License，可直接用于本地开发、功能体验与接口验证。如果申请了正式版 License Key，请替换文件中的 COMPDF_LICENSE_KEY 字段。

启动服务

运行以下命令在后台启动完整的服务栈：

docker compose up -d

健康检查

服务启动后，可以通过以下命令检查容器状态：

docker compose ps
docker compose logs -f

首次登录

服务启动后，在浏览器中访问以下地址：

• ComPDF Web: http://localhost:8080/
• Dashboard 控制台: http://localhost:8080/admin

首次部署时，Dashboard 默认的管理员账号和密码为：

• 账号: admin
• 密码: admin

首次调用

您可以通过 ComPDF Web 界面直接上传文档进行处理。如果需要进行 API 调用，开发环境的 API 基址为：

Server API: http://localhost:8080/api/v1/

生产检查

生产部署会将持久化数据存放在 Docker volumes 中，并将 ./configs 挂载到 Server 容器。如果修改了源码，需要重新打包生产环境镜像：

docker compose -f docker-compose.yml up -d --build compdf-infra compdf-app compdf-server

了解更多

有关完整的配置项说明以及更多高级用法，请访问我们的 GitHub 仓库。