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-kroki

Specification

Status
Listed
Category
Developer Tools
Services
kroki
Ports
8000
Volumes
0
Memory
about 512 MiB
arm64
unknown
amd64
unknown
Settings to fill in
none
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.

ServiceImageTagPortsVolumes
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

  1. Send diagram text to the address followed by /mermaid/svg or another format path to get an image.

Install Kroki on a VPS

  1. 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
  2. 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 | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get kroki
  4. 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.

More in Developer Tools

All Developer Tools templates