Carbone Docker镜像技术文档

快速参考

• 维护者：Carbone团队
• 完整文档：本地部署、选项与插件
• Carbone Docker镜像可免费使用，但不包含企业功能且不提供支持。
• 获取帮助：在线聊天、预约演示 或发送邮件至 ***

镜像概述与主要用途

Carbone是一款高效、通用且面向未来的文档生成器。通过Carbone，您可以在几分钟内生成各类文档：只需提供模板文件和JSON数据集，引擎即可返回填充数据后的文档。支持多种格式：PDF、ODT、DOCX、XLSX、HTML、XML、PPTX、JPG、PNG、TXT、CSV、EPUB、IDML、ODS、ODG、ODP等。

核心功能与特性

核心功能

• 多格式支持：生成PDF、DOCX、XLSX、PPTX等20+种文档格式
• 简单集成：通过模板文件与JSON数据集快速生成文档，流程简洁（模板+JSON数据→生成文档）
• 高效性能：资源占用低，优化性能设计，响应迅速

支持的文档格式

PDF、ODT、DOCX、XLSX、HTML、XML、PPTX、JPG、PNG、TXT、CSV、EPUB、IDML、ODS、ODG、ODP等。

使用场景与适用范围

• 企业报告生成：财务报表、销售报告、客户合同等
• 自动化文档处理：批量生成发票、收据、证书等
• 开发者集成：嵌入应用系统，动态生成用户所需文档
• 多格式需求场景：需同时生成多种格式文档（如PDF版报告+XLSX数据表格）

推荐系统要求

Carbone注重性能优化，资源需求极低：

• 支持架构：x86_64 或 ARM64
• 推荐配置：1核CPU，1024MB内存

使用方法

运行Carbone社区版（永久免费）

Carbone企业版为商业软件，需授权使用。社区版可免费无限制使用基础功能，但不包含高级功能且不提供技术支持。

启动命令：

console
docker run -t -i --rm -p 4000:4000 carbone/carbone-ee

验证运行状态（需通过API文档了解完整接口）：

console
curl [***]

运行Carbone企业版

企业版需联系获取授权许可，启动时通过环境变量传入许可证：

启动命令：

console
export CARBONE_EE_LICENSE=`cat your_license_file.carbone-license`
docker run -t -i --rm -p 4000:4000 -e CARBONE_EE_LICENSE carbone/carbone-ee

验证运行状态：

console
curl [***]

配置说明

基础配置（环境变量）

通过环境变量配置Carbone功能，例如启用Studio：

console
docker run -t --rm -e CARBONE_EE_LICENSE -e CARBONE_EE_STUDIO=true carbone/carbone-ee

完整配置选项参见***文档。

数据持久化配置

单实例最小配置（模板存储）

使用S3兼容存储

支持AWS S3、GCS、Azure Blob Storage、MinIO等S3兼容服务，需配置以下环境变量：

• AWS_SECRET_ACCESS_KEY：访问密钥
• AWS_ACCESS_KEY_ID：密钥ID
• AWS_ENDPOINT_URL：S3服务API地址
• AWS_REGION：区域（如paris）
• BUCKET_TEMPLATES：存储模板的桶名称

挂载卷存储模板

通过挂载卷存储模板文件（本地文件夹或远程存储）：

console
docker run -t -i --rm -p 4000:4000 -v /本地路径:/app/templates carbone/carbone-ee

详细说明参见文件持久化文档。

多实例配置（渲染结果共享）

多实例部署需确保渲染结果可跨实例访问，可通过以下方式配置：

• 设置BUCKET_RENDERS环境变量（同模板存储的S3兼容配置）
• 挂载卷至所有实例的/app/render目录（需确保卷可读写）

Docker镜像变体

提供三种镜像变体，满足不同需求：

部署

支持所有容器化环境部署：Docker、Kubernetes、AWS ECS、Azure Container App、CloudRun等。

附加信息

• 源代码
• 许可证