Part of the KDAN ecosystem, ComPDF Self-hosted offers PDF editing and document conversion, helping teams process PDFs, Office files, and images securely in private Docker deployments.
- If you find ComPDF Self-hosted useful, please consider giving us a ⭐ Star on GitHub. It helps us grow and improve.
- Got questions or ideas? Join the conversation in our Discussions.
Features • Quick Start • Architecture • Upgrade to Enterprise • support • License • Enterprise →
Unlike traditional SDKs that require deep integration, ComPDF Self-hosted is a ready-to-deploy open-source PDF processing platform. It combines PDF editing and conversion capabilities, while also supporting image format conversion—covering the full spectrum from documents to images. This enables enterprises to quickly establish a fully controllable, self-owned document center.
- Docker Compose deployment
- Complete PDF tool center — edit, convert, merge, split
- API key management and license management
- Private deployment with enterprise-ready architecture
- Commercial support and dedicated assistance available
Whether you're building an internal document platform, document automation workflow, or enterprise PDF service, ComPDF Self-hosted helps you get started in minutes.
ComPDF Self-Hosted provides a ready-to-use open source PDF editor, open source PDF converter, and open source image converter center directly accessible through a browser.
| Category | Features |
|---|---|
| PDF Editing | Merge PDF, Split PDF, Rotate PDF, Insert Pages, Delete Pages, Extract Pages, Add Watermark, Remove Watermark, Encrypt PDF, Decrypt PDF |
| PDF to Others | PDF to Word, PDF to Excel, PDF to Slide, PDF to Image (PNG, JPG, JPEG, JPEG2000, BMP, TIFF, TGA, GIF, WEBP), PDF to HTML, PDF to TXT, PDF to CSV, PDF to RTF, PDF to JSON, PDF to SearchablePDF, PDF to OFD, PDF to Markdown, Word to PDF, Excel to PDF |
| Others to PDF | Slide to PDF, HTML to PDF, TXT to PDF, CSV to PDF, RTF to PDF, PNG to PDF |
| Image to Others | Image to Word, Image to Excel, Image to Slide, Image to HTML, Image to CSV, Image to TXT, Image to RTF, Images to JSON, Images to PDF |
ComPDF Self-hosted provides a unified management console for viewing API Key details, API usage, and License status, as well as supporting operation log auditing, account management, and core system configuration.
-
Overview Panel: Displays API Key details, API usage statistics, License scope, and usage status.
-
Operation Logs: Track, search, and export all the operation logs.
-
Account Management: Set the user name and password.
-
System Settings: Set the name, logo, and theme color of the system.
- Clone the repository and enter the project directory:
git clone https://github.com/ComPDF/compdf-self-hosted.git
cd compdf-self-hosted- Prepare the environment file before starting services:
cp .env.example .env.env includes a free License by default for local development, feature
evaluation, and API verification. Docker Compose automatically loads .env
from the project directory.
- Start the full stack:
docker compose up -d- Open ComPDF Web and Dashboard:
ComPDF Web: http://localhost:8080/
Dashboard: http://localhost:8080/admin
The dashboard ships with a default administrator account on first deployment:
admin / admin.
To use an Enterprise license, replace COMPDF_LICENSE_KEY in .env with the
issued License Key. Restart the services after updating the License Key.
Apply for the Enterprise version to obtain the following benefits:
- Watermark-free document processing
- No limit on the number of document pages processed
- Batch document processing
Development uses Docker for the infra and SDK services, while the server and Web UI can run locally for hot reload.
Start the development stack:
docker compose -f docker-compose.dev.yml up -d --build compdf-infra compdf-app compdf-server
docker compose -f docker-compose.dev.yml psServer API URL:
http://localhost:8080/api/v1/
You can also view the Documentation.
Open ComPDF Web and Dashboard:
ComPDF Web: http://localhost:8080/
Dashboard: http://localhost:8080/admin
docker compose ps
docker compose logs -f compdf-serverThe production deployment stores persistent data in Docker volumes and mounts ./configs into the server container.
Keep this path when you have changed the local source code and need to package a new production compdf-server image from the root Dockerfile. The Dockerfile builds ComPDF Web and Dashboard from frontend/compdf-web, copies the static assets into /app/public/compdf-web, builds the server, and serves pages and APIs together on port 8080.
docker compose -f docker-compose.yml up -d --build compdf-infra compdf-app compdf-serverAll features above come with ComPDF — check them out here.
┌────────────────────────────────────────────────────────────────────┐
│ Browser │
│ Use / for ComPDF Web and /admin for Dashboard in production │
└───────────────────────────────┬────────────────────────────────────┘
│
│ HTML/CSS/JS + HTTP /api/v1/*
▼
┌────────────────────────────────────────────────────────────────────┐
│ compdf-server container │
│ ComPDF Web + Dashboard + Server, port 8080 │
├────────────────────────────────────────────────────────────────────┤
│ - Serves ComPDF Web and Dashboard from /app/public/compdf-web │
│ - ComPDF Web uses /api/v1/process/* and /api/v1/task/* │
│ - Dashboard uses /api/v1/dashboard/* for API keys, license, logs │
│ and system settings │
│ - Orchestrates async task status, cancellation, and downloads │
│ - Injects brand config, API key, and display-only license metadata │
│ - Normalizes processing-service errors and writes operation logs │
└───────────────┬───────────────────────────────┬────────────────────┘
│ │
│ HTTP │ MySQL / Redis
▼ ▼
┌────────────────────────────────┐ ┌────────────────────────────────┐
│ compdf-app container │ │ compdf-infra container │
│ │ │ MySQL 8 + Redis 7 + RustFS │
│ │ │ persistent Docker volumes │
└────────────────────────────────┘ └────────────────────────────────┘
│
▼
┌────────────────────────────────────────────────────────────────────┐
│ Project-mounted data │
├────────────────────────────────────────────────────────────────────┤
│ configs/: license.jwt, settings.yml, init.sql │
│ storage/: async task result files │
│ fonts/: optional fonts mounted into the SDK container │
└────────────────────────────────────────────────────────────────────┘
In local development, compdf-infra, compdf-app, and compdf-server all run
through docker-compose.dev.yml so the service-to-service connections stay
consistent with the deployment topology.
Contact sales to update to the Enterprise Edition.
| Feature | Free Edition | Enterprise |
|---|---|---|
| PDF Editing | ✅ | ✅ |
| PDF Conversion | ✅ | ✅ |
| Web UI | ✅ | ✅ |
| Dashboard | ✅ | ✅ |
| Watermark-Free Output | ❌ | ✅ |
| Unlimited Pages | ❌ | ✅ |
| Custom Concurrency | ❌ | ✅ |
| Commercial License | ❌ | ✅ |
| Technical Support | ❌ | ✅ |
-
Deployment Guide: https://www.compdf.com/documentation
-
API Reference: https://www.compdf.com/guides/pdf-sdk/self-hosted-deployment/api-reference-conversion
-
SDK Documentation: https://www.compdf.com/guides/pdf-sdk/self-hosted-deployment/overview
Have suggestions? Start a discussion. If you find ComPDF Self-hosted useful, please consider giving us a ⭐ Star on GitHub. It helps us grow and improve.
-
This project is licensed under the MIT License. See the LICENSE file for details.
-
Contact Sales for the Commercial / Enterprise licenses for ComPDF Self-hosted.
Built by the ComPDF team.
Website ·
Docs ·
Enterprise Inquiries