Self-host Kroki on a VPS
An API that turns diagram text such as Mermaid, PlantUML and Graphviz into images. It has no database and no login, so restrict who can reach it.
levelrail-cli templates deploy kroki --name my-krokiSpecification
- Status
- Listed
- Category
- Developer Tools
- Services
- kroki
- Ports
- 8000
- Volumes
- 0
- Memory
- about 512 MiB
- arm64
- unknown
- amd64
- unknown
- Settings to fill in
- none
- License
- Permissive license, MIT
- Listing
- Community template
About Kroki
An API that turns diagram text such as Mermaid, PlantUML and Graphviz into images. It has no database and no login, so restrict who can reach it.
What it deploys
Kroki runs as one service in a single Compose app, listening on port 8000.
| Service | Image | Tag | Ports | Volumes |
|---|---|---|---|---|
| kroki | yuzutech/kroki | 0.28.0 | 8000 | none |
Before you install
- CPU architecture. arm64 unknown. The scan could not read a manifest or the tag is chosen at install time. This is not a claim either way.
- Listed. It is in the catalog. Back up the data volume before changing an image tag.
Settings and environment
The catalog lists no environment variables for this template.
First run
- Send diagram text to the address followed by /mermaid/svg or another format path to get an image.
Install Kroki on a VPS
-
Install Levelrail on a fresh VPS
Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.
curl -fsSL https://levelrail.com/install.sh | sudo sh -
Sign in
Open the setup link, choose a password, then log the CLI in. The CLI install command is
curl -fsSL https://levelrail.com/install-cli.sh | shif the machine does not have it. See Getting started.levelrail-cli login --device -
Read the template
Shows the entry, including its full compose.yaml.
levelrail-cli templates get kroki -
Deploy it
This deploys the template compose file as an app. The app name defaults to the template id; --name sets another.
levelrail-cli templates deploy kroki --name my-kroki
Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then Kroki.
Docs and upstream
More in Developer Tools
- KellnrSelf-hosted registry for private Rust crates with a web UI and docs hosting. Runs a single container with data on a volume.
- LibreTranslateA free and open machine translation API that runs entirely on your own hardware.
- JupyterHubMulti user server that manages and proxies notebook servers. The install form carries jupyterhub_config.py as an editable file with a generated shared password, so it starts with a working login.
- Jupyter NotebookA web-based notebook environment for interactive Python, data analysis, and visualization.
- Jupyter NotebookA Jupyter Notebook server for interactive Python data work, protected by a generated access token.
- LivebookInteractive and collaborative code notebooks for Elixir with a built in package manager and visualizations. A generated password protects the editor.