Gotenberg

Development512MB+ RAM

Containerized API for converting HTML, Markdown, Office documents, and URLs to PDF

Download Server Compass Install Gotenberg to server

developmentdevtoolsgotenbergopen-sourceself-hosteddocker

Deploy Gotenberg in 3 Steps

Connect Your VPS

Add your server credentials to Server Compass

Select Gotenberg

Choose from our template library

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required

Step-by-step deployment guide

Deploy Gotenberg on a VPS with Server Compass

Use the Gotenberg template in Server Compass to deploy a self-hosted document conversion API on your VPS, then verify the health endpoint.

About 10 minutesBrowser verified

Step 1

Open the server Apps tab

Select the tutorial-vps VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.

Server Compass Apps tab before creating a Gotenberg app

Step 2

Choose an app template

Click New App and choose the template deployment path so Server Compass can load the built-in catalog.

Choosing to deploy an app from a Server Compass template

Step 3

Search for Gotenberg

Use the template picker search to find Gotenberg in the Server Compass template catalog.

Searching for Gotenberg in the Server Compass template picker

Step 4

Select the Gotenberg template

Choose the Gotenberg template. Server Compass fills the document conversion API service, basic-auth username, basic-auth password, and public API port.

Gotenberg template selected in Server Compass

Step 5

Review the Gotenberg settings

Confirm the app name and compose service. In this run, the app was named gotenberg-demo and used host port 4013.

Reviewing Gotenberg project settings and compose service

Step 6

Deploy Gotenberg

Review the generated compose settings, confirm the Gotenberg API port is available, and click Deploy.

Reviewing Gotenberg web port before deployment

Step 7

Watch the deployment progress

Keep the deployment modal open while Server Compass uploads the compose file, pulls the Gotenberg image, starts the container, and verifies the stack.

Server Compass deploying the Gotenberg template on the VPS

Step 8

Confirm Gotenberg is running

After deployment finishes, return to the Apps tab and confirm the Gotenberg app is marked Running with its published API port available.

Gotenberg template running in the Server Compass Apps tab

Step 9

Verify Gotenberg with the API response

Call the Gotenberg health endpoint with basic auth and inspect recent logs to confirm the conversion API is responding.

Gotenberg service verification output from logs

After Gotenberg Opens

Keep API basic auth enabled before exposing Gotenberg.
Use HTTPS before sending real documents.
Do not allow untrusted users to submit arbitrary URLs or files without rate limiting.
Monitor CPU and memory because conversions can be resource-intensive.
Test with harmless sample documents before production integration.
Store the API password in a password manager.
Keep the Gotenberg image updated for LibreOffice, Chromium, and dependency security fixes.

Verified Result

Gotenberg returned a health response and logs showed startup activity.

Download Server Compass Docs

Gotenberg deployment questions

What does the Gotenberg template deploy?

It deploys Gotenberg as a single-container document conversion API with basic authentication enabled.

Which port did the tutorial use?

The tutorial used host port 4013, which maps to the Gotenberg API on container port 3002.

Does Gotenberg need setup after deployment?

No account setup is required. Verify `/health` with basic auth, then integrate document conversion jobs from trusted applications.

Should this become a blog post?

No. The deployment guide should live on the Gotenberg template detail page and be linked from the reusable template deployment docs page.

After Deployment

After deploying Gotenberg with Server Compass, complete these steps to finish setup

Check http://YOUR_SERVER_IP:{{PORT}}/health

Call API endpoints with basic auth credentials

Integrate document conversion jobs from your application

Need help? Check out our documentation for detailed guides.

Gotenberg FAQ

Common questions about self-hosting Gotenberg

How do I deploy Gotenberg with Server Compass?

Simply download Server Compass, connect to your VPS, and select Gotenberg from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.

What are the system requirements for Gotenberg?

Gotenberg requires a minimum of 512MB RAM. We recommend a VPS with at least 1024MB RAM for optimal performance. Any modern Linux server with Docker support will work.

Can I migrate my existing Gotenberg data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard Gotenberg backup and restore procedures.

How do I update Gotenberg to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest Gotenberg image will be pulled and deployed with zero downtime.

Is Gotenberg free to self-host?

Gotenberg is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.

Related Templates

View all Development

PocketBase

Open-source backend in a single file with realtime database, auth, and file storage

Appwrite

Open-source backend-as-a-service - self-hosted Firebase alternative

Parse Server

Open-source backend framework with dashboard

Supabase

Full Supabase self-hosted with Kong, GoTrue Auth, Realtime, and Studio

Ready to Self-Host Gotenberg?

Download Server Compass and deploy Gotenberg to your VPS in under 3 minutes. No Docker expertise required.

Download Server Compass