ComPDF
联系销售
DemoAPI 参考文档FAQ
、

PDF 生成模板编辑器

开源可视化 PDF 生成引擎，支持自定义模板，并提供面向开发者的 API，灵活构建文档生成流程。

查看 GitHub

启动与配置：ComPDF AMI（AWS Marketplace / EC2） ​

本页提供从 Marketplace 启动 AMI 到服务可用的完整步骤。

1. 前置准备 ​

1.1 获取 License Key（必需） ​

请提前准备许可证密钥 LICENSE_KEY。

联系我们的销售团队，获取您的许可证密钥。

1.2 EC2 最低规格建议 ​

  • 最低建议：4 vCPU / 8 GiB RAM
  • 建议使用 SSD（gp3），并预留足够磁盘空间用于临时文件与输出文件

2. 从 AWS Marketplace 启动 AMI（EC2） ​

  1. 在 AWS Marketplace 订阅（Subscribe）该产品
  2. 点击 Launch 并进入 EC2 启动流程
  3. 选择/确认：
    • Instance type：建议不低于 4C 8G
    • Key pair：用于 SSH 登录

2.1 安全组（Security Group）入站规则（关键） ​

至少放行：

  • 22/tcp（SSH）：用于登录配置与运维（建议限制来源 IP）
  • 7000/tcp（HTTP API）：对外提供服务（按需开放给调用方）

可选：

  • 3306/tcp（MySQL）：按访问需求决定是否开放（若无明确需要，不建议对公网开放）

3. SSH 登录实例（用户名 ubuntu） ​

实例启动后，使用 SSH 登录：

bash
ssh -i /path/to/your-key.pem ubuntu@<EC2_PUBLIC_IP>

4. 配置 License Key ​

4.1 定位配置文件 ​

AMI 内置 Docker / Docker Compose。你只需要修改 Docker Compose 配置文件并启动服务即可。

Docker Compose 文件路径：

  • /var/www/compdf/docker-compose.yml

4.2 编辑并替换 LICENSE_KEY ​

bash
sudo vi /var/www/compdf/docker-compose.yml

将以下内容：

yaml
LICENSE_KEY: your LICENSE_KEY

替换为你的真实 License Key，例如：

yaml
LICENSE_KEY: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

保存退出。

5. 启动服务 ​

AMI 内置 Docker / Docker Compose，执行以下命令启动：

bash
cd /var/www/compdf
sudo docker compose up -d

此命令将启动两个容器：

  • compdfkit_processor：转换服务（对外 7000 端口）
  • dbmysql：MySQL 数据库

6. 验证服务是否正常运行 ​

6.1 查看容器运行状态 ​

bash
sudo docker ps

你应能看到：

  • compdfkit_processor
  • dbmysql

6.2 查看日志（如需排错） ​

bash
sudo docker logs -f compdfkit_processor

数据库日志：

bash
sudo docker logs -f dbmysql

7. 停止/重启 ​

停止：

bash
cd /var/www/compdf
sudo docker compose down

启动：

bash
cd /var/www/compdf
sudo docker compose up -d