compdf-generation
Generate PDFs effortlessly with the open-source ComPDF Generation SDK. Design HTML-based templates to produce business-critical documents, such as contracts, in
What is compdf-generation?
Generate PDFs effortlessly with the open-source ComPDF Generation SDK. Design HTML-based templates to produce business-critical documents, such as contracts, invoices, reports, and certificates with ease.
Overview of compdf-generation
What it is
ComPDF Generation is an open-source, self-hosted PDF generation SDK and platform. It allows developers and teams to design HTML-based templates and use JSON data to produce business-critical documents such as contracts, invoices, reports, and certificates. Deployment, templates, and workflow integration remain under the user's control.
Key features
- Visual Template Editor — Create, test, and preview templates visually; edit HTML directly for advanced customization.
- Self-Hosted Web UI and API — Manage templates through the Web UI and integrate workflows via API access and SDK capabilities.
- Structured JSON Data — Generate customized documents from JSON data sources.
- High-Volume Processing — Multithreaded batch generation with no document-generation quota.
- AI-Friendly Workflows — Structured templates and data inputs support AI-assisted document workflows and reduce repeated prompt construction.
- Batch Template Import and Migration — Import DITO templates and ComPDF Generation templates in batches, enabling smooth migration from iText and other PDF generation solutions.
Use cases
- Automated contracts and agreements - Invoices, statements, and financial documents - Batch monthly, quarterly, and analytical reports - Certificates and standardized proof documents - On-demand PDF output for CRM, ERP, OA, and other internal systems
Getting started
Make sure Docker Desktop (macOS) or Docker Engine with the Docker Compose plugin (Linux) is installed and that you can pull the compdfkit/pdf-generation:1.0.0 image from Docker Hub. The commands below clone the project, copy the environment file, and start the services; wait until compdf-app becomes healthy, then open http://localhost:8090. .env.example includes a trial license, which adds a watermark to generated PDFs; for production use, replace COMPDF_LICENSE_KEY with a formal license. bash git clone https://github.com/ComPDFKit/compdf-generation.git cd compdf-generation cp .env.example .env docker compose up -d --build docker compose ps
License and pricing
The open-source edition is licensed under AGPL v3. A commercial edition with a commercial license is available for production use without watermark. The trial license in .env.example adds a watermark to generated PDFs. No pricing information is stated in the repository.
Based on the project's public README and repository metadata.