1
Step 1Open the server Apps tab
Select your 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
Kroki
Application512MB+ RAM
Unified API for creating diagrams from text (PlantUML, Mermaid, GraphViz)
diagramsapiplantumlmermaid
Deploy Kroki in 3 Steps
1
Connect Your VPS
Add your server credentials to Server Compass
2
Select Kroki
Choose from our template library
3
Deploy & Configure
Fill in settings and click Deploy
No Docker knowledge required
Step-by-step deployment guide
Deploy Kroki on a VPS with Server Compass
Use the Kroki template in Server Compass to deploy a self-hosted diagram rendering API for PlantUML, Mermaid, GraphViz, BPMN, and other text-based diagrams on your VPS, then verify the Kroki endpoint in a browser.
About 7 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 Kroki
Use the template picker search to find Kroki in the Server Compass template catalog.
4
Step 4Select the Kroki template
Choose the Kroki template. Server Compass fills in the Kroki service plus the Mermaid and BPMN helper services, then maps the API port.
5
Step 5Review the Kroki settings
Confirm the app name and compose services. In this run, the app was named kroki-demo and used host port 8000.
6
Step 6Deploy Kroki
Review the generated environment values, confirm the port is available, and click Deploy Now.
7
Step 7Watch the deployment progress
Keep the deployment modal open while Server Compass uploads the compose file, pulls the Kroki image, starts the container, and verifies the stack.
8
Step 8Confirm Kroki is running
After deployment finishes, return to the Apps tab and confirm the Kroki app is marked Running with its application URL available.
9
Step 9Open Kroki in the browser
Open the application URL in a browser. The Kroki landing page confirms the diagram rendering API is reachable.
After Kroki Opens
- Add a domain and HTTPS before sending sensitive diagram source through Kroki.
- Restrict access with a reverse proxy, firewall, or private network if the API should not be public.
- Test the specific diagram formats your documentation tooling will use, such as Mermaid, PlantUML, GraphViz, or BPMN.
Kroki deployment questions
What does the Kroki template deploy?
It deploys Kroki with Mermaid and BPMN helper services so documentation tools can render diagrams from text definitions.
Which port did the tutorial use?
The tutorial used host port 8000, which maps to the Kroki web service on container port 8000.
Why does the guide stop at the login or setup web UI?
The tutorial verifies the clean Kroki endpoint because production access control, HTTPS, and client integrations depend on your documentation workflow.
Should this become a blog post?
No. The deployment guide should live on the Kroki template detail page and be linked from the reusable template deployment docs page.
Do It Yourself
Deploy Kroki via Command Line
Prefer the command line? Follow this step-by-step guide to deploy Kroki manually on your VPS.
1
Access Your VPS via Terminal
Open a terminal session and log into your VPS. Replace the placeholder with your actual IP.
terminal
# Connect via SSH
ssh root@your-vps-ip
# Alternative with key file
ssh -i /path/to/key root@your-vps-ipFirst time? Make sure Docker is installed on your VPS. Run: curl -fsSL https://get.docker.com | sh
2
Set Up Project Folder
Create a workspace for your deployment files.
terminal
# Create and navigate to project directory
mkdir -p ~/apps/kroki
cd ~/apps/kroki3
Create the Compose File
Configure your containers with this Docker Compose setup:
docker-compose.yml
services:
kroki:
image: yuzutech/kroki
ports:
- "8000:8000"
environment:
- KROKI_MERMAID_HOST=mermaid
- KROKI_BPMN_HOST=bpmn
restart: unless-stopped
depends_on:
- mermaid
- bpmn
mermaid:
image: yuzutech/kroki-mermaid
restart: unless-stopped
bpmn:
image: yuzutech/kroki-bpmn
restart: unless-stopped
Configuration Variables
PORTHost port to expose(default: 8000)4
Deploy Your Stack
Spin up the containers and verify the deployment.
terminal
# Start all services
docker compose up -d
# List running containers
docker compose ps
# Watch the logs
docker compose logs -f5
Update Firewall Settings
Allow incoming traffic on the application port.
terminal
# Allow the application port through firewall
sudo ufw allow 8000/tcp
sudo ufw reload
# Access your app at:
# http://your-server-ip:8000Skip the Terminal
Skip the terminal. Use Server Compass instead.
Deploy Kroki with a beautiful UI instead. No SSH, no YAML editing, no terminal commands. Just click, configure, and deploy in under 3 minutes.
- Beautiful interface
- One-click deploys
- Let's Encrypt SSL
- Zero downtime
- Container monitoring
- Easy rollbacks
Download Server Compass$29 one-time • Lifetime license
After Deployment
After deploying Kroki with Server Compass, complete these steps to finish setup
1
Test the API with a simple diagram
2
Integrate with your documentation tools
Need help? Check out our documentation for detailed guides.
Kroki FAQ
Common questions about self-hosting Kroki
How do I deploy Kroki with Server Compass?
Simply download Server Compass, connect to your VPS, and select Kroki 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 Kroki?
Kroki 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 Kroki data?
Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard Kroki backup and restore procedures.
How do I update Kroki to the latest version?
Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest Kroki image will be pulled and deployed with zero downtime.
Is Kroki free to self-host?
Kroki 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.
Ready to Self-Host Kroki?
Download Server Compass and deploy Kroki to your VPS in under 3 minutes. No Docker expertise required.
Download Server Compass