ComPDF
Contact Sales
Docs OverviewDemoDownloadFAQChangelog

Overview ​

This AMI guide is intended for AWS Marketplace users and provides a self-hosted deployment method for ComPDF conversion capabilities. After launching an EC2 instance from AWS Marketplace, you can configure the License and start the service, then access it via HTTP API from your application within the same VPC (private network) to complete PDF conversion tasks. If you need public Internet access, assign a public IP address to the EC2 instance and allow port 7000 in the security group. It is also recommended to restrict the source IP addresses.

1. Component Architecture ​

This AMI uses Docker Compose to manage and start two containers:

  • compdfkit_processor

    • Image: compdfkit/compdfkit:3.2.1
    • Purpose: Provides the PDF conversion HTTP API
    • Exposed port: 7000/tcp

  • dbmysql

    • Image: mysql:8.0.27
    • Purpose: Service database (starts together with the processor by default)

2. Key Ports ​

  • 7000/tcp: API service port (must be allowed in the security group to be reachable)
  • 22/tcp: SSH administration (recommended to restrict the source IP addresses)
  • 3306/tcp: MySQL port (whether to open it depends on your access requirements; if not necessary, it is not recommended to expose it to the public Internet)

3. Key Files and Directories ​

  • Docker Compose file: /var/www/compdf/docker-compose.yml
  • Database initialization script: /var/www/compdf/compdfkit.sql
  • MySQL persistent data directory: /var/www/compdf/data/

4. License (Important) ​

This AMI requires you to provide your own LICENSE_KEY and set it in docker-compose.yml before the service can be started and used.

To purchase/get a License: