compdf-self-hosted logo

compdf-self-hosted

Edit, convert, and transform documents across PDFs, Office formats, HTML, TXT, CSV, RTF, JSON, and images with ComPDF Self-hosted, an open-source PDF platform.

docker supportedPRs welcome
Website GitHub

What is it?

What it is

An open-source, ready-to-deploy PDF processing platform that provides web-based PDF editing, document conversion (PDF, Office, images), and a management dashboard.

Why it exists

To provide enterprises with a fully controllable, self-owned document center that avoids the need for deep SDK integration while ensuring secure, private Docker deployments.

Who should use it

Organizations and teams that need a self‑hosted, Docker‑based PDF processing platform with a web UI and dashboard for editing, converting, merging, splitting, and watermarking PDFs and images. Ideal for internal document centers, automation workflows, and developers wanting to integrate PDF capabilities without external APIs.

Who should avoid it

Users who prefer a simple, single‑file command‑line tool, or those who cannot run Docker containers or manage a private deployment. Also not suitable for those who need a fully managed cloud service with zero maintenance.

How it works

A quick walkthrough in plain English

How compdf-self-hosted works

Step 1 of 3

You interact with it

Open compdf-self-hosted, send a request, or connect it to your stack.

Features

Docker Compose deployment
Open-source PDF editor
Open-source PDF converter
Open-source image converter
Full PDF tool center (merge, split, rotate, watermark, encrypt, decrypt)
PDF to/from Word, Excel, Slide, HTML, TXT, CSV, RTF, JSON, Markdown, OFD, SearchablePDF
Image to/from Word, Excel, Slide, HTML, CSV, TXT, RTF, JSON, PDF
Dashboard console for API key, license, usage, logs, account and system settings
API key and license management
Private deployment with enterprise-ready architecture

Advantages

  • Easy deployment with Docker Compose
  • Ready-to-use web UI and dashboard
  • Comprehensive PDF and image processing tools
  • Open-source and MIT licensed
  • Supports API key and license management
  • Private, self-hosted deployment for data security
  • Commercial support and dedicated assistance available
  • Extensible via Docker volumes for persistent data
  • Unified management console for monitoring and configuration

Disadvantages

  • Free edition limited by watermark, page count, and batch processing
  • No unlimited pages or custom concurrency in free edition
  • No commercial license or technical support in free edition
  • Requires Docker and Docker Compose knowledge
  • Enterprise features require purchasing a license
  • Complexity of multi-container architecture may be challenging for beginners

Installation

docker

docker compose up -d

compose

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

FAQ

How can I quickly deploy ComPDF Self-Hosted?

The fastest way is using Docker Compose. Clone the repository, create a `.env` file from `.env.example`, and run `docker compose up -d`. You can then access the Web UI at `http://localhost:8080/` and the Dashboard at `http://localhost:8080/admin`.

What are the default login credentials for the dashboard?

Upon first deployment, the dashboard uses the default administrator account: `admin` for the username and `admin` for the password.

What is the difference between the Free and Enterprise editions?

The Enterprise edition provides watermark-free document processing, unlimited page processing, custom concurrency settings, and commercial licensing/technical support, whereas the Free edition has limitations on pages and watermarks.

Can I use this platform for more than just PDF files?

Yes. In addition to PDF editing and conversion, the platform supports converting images to various formats (Word, Excel, Slide, HTML, etc.) and converting Office files (Word, Excel, Slide) and HTML to PDF.

How do I update my license key?

To use an Enterprise license, replace the `COMPDF_LICENSE_KEY` value in your `.env` file with your issued key and restart the Docker services.

Loading documentation…
View on GitHub

Featured in Videos

YouTube tutorials and walkthroughs for compdf-self-hosted

Alternatives

Similar projects ranked by category, topics, and text overlap.

Compare
compdf-self-hosted | MushyBook