1
Step 1Open 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.
Back to all templates
Carbone
Development512MB+ RAM
Fast, open-source document generator — fill DOCX, ODT, XLSX, or PDF templates from JSON data via a simple HTTP API
developmentdevtoolscarboneopen-sourceself-hosteddocker
Deploy Carbone in 3 Steps
1
Connect Your VPS
Add your server credentials to Server Compass
2
Select Carbone
Choose from our template library
3
Deploy & Configure
Fill in settings and click Deploy
No Docker knowledge required
Step-by-step deployment guide
Deploy Carbone on a VPS with Server Compass
Use the Carbone template in Server Compass to deploy a self-hosted document generation API on your VPS, then verify the API status response in a browser.
About 10 minutesBrowser verified
2
Step 2Choose an app template
Click New App and choose the template deployment path so Server Compass can load the built-in catalog.
3
Step 3Search for Carbone
Use the template picker search to find Carbone in the Server Compass template catalog.
4
Step 4Select the Carbone template
Choose the Carbone template. Server Compass fills the document generation service, persistent data volume, optional license key, and public API port.
5
Step 5Review the Carbone settings
Confirm the app name and compose service. In this run, the app was named carbone-demo and used host port 4247.
6
Step 6Deploy Carbone
Review the generated compose settings, confirm the Carbone web port is available, and click Deploy.
7
Step 7Watch the deployment progress
Keep the deployment modal open while Server Compass uploads the compose file, pulls the Carbone image, starts the container, and verifies the stack.
8
Step 8Confirm Carbone is running
After deployment finishes, return to the Apps tab and confirm the Carbone app is marked Running with its application URL available.
9
Step 9Open the Carbone status endpoint
Open the application status endpoint in a browser. The JSON success response confirms the document generation API is reachable.
After Carbone Opens
- Place Carbone behind HTTPS before sending production documents through the API.
- Restrict API access with a firewall, private network, or authenticated reverse proxy before exposing the service.
- Add a valid CARBONE_EE_LICENSE if you need Enterprise or Studio/template-management features.
- Treat uploaded templates and generated documents as sensitive customer data.
- Back up the Carbone data volume because it stores templates and generated service state.
- Keep the Carbone image updated for dependency and security fixes.
Verified Result
The Carbone API status endpoint returned a successful JSON response from the deployed container.
Carbone deployment questions
What does the Carbone template deploy?
It deploys the Carbone document generation API with a persistent data volume. Without a license, the image runs Community Edition API features and Studio is disabled.
Which port did the tutorial use?
The tutorial used host port 4247, which maps to the Carbone API on container port 4000.
Does Carbone need setup after deployment?
The API can answer status immediately. Add a valid license if you need Studio/template-management features, and restrict the API before production use.
Should this become a blog post?
No. The deployment guide should live on the Carbone template detail page and be linked from the reusable template deployment docs page.
After Deployment
After deploying Carbone with Server Compass, complete these steps to finish setup
1
Open http://YOUR_SERVER_IP:{{PORT}} and log into Studio with your admin credentials
2
Upload a sample DOCX or XLSX template that uses Carbone placeholders (e.g., {d.name})
3
Copy the generated template ID
4
Call the /render endpoint from your app with JSON data and verify a filled document comes back
5
(Optional) Add CARBONE_EE_LICENSE via Env Vars if you have one to remove watermarks
Need help? Check out our documentation for detailed guides.
Carbone FAQ
Common questions about self-hosting Carbone
How do I deploy Carbone with Server Compass?
Simply download Server Compass, connect to your VPS, and select Carbone 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 Carbone?
Carbone 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 Carbone data?
Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard Carbone backup and restore procedures.
How do I update Carbone to the latest version?
Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest Carbone image will be pulled and deployed with zero downtime.
Is Carbone free to self-host?
Carbone 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 Carbone?
Download Server Compass and deploy Carbone to your VPS in under 3 minutes. No Docker expertise required.
Download Server Compass