Self-host Kroki with Levelrail

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.

  • Authoryuzutech
  • LicenceMIT
  • Memory512 MiB
  • Services1

How to self-host Kroki

  1. Pull the images

    One image is pulled on your server.

    Show images
    • yuzutech/kroki:0.28.0
  2. Create the app

    One service starts in a single Compose app, on port 8000.

  3. Fill in the secrets

    You do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

After the first start

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

Kroki requirements

Memory
About 512 MiB
Architectures
amd64 unknown, arm64 unknown
Ports
8000
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
MIT, permissive license
  • Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then Kroki. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the Kroki docs page.

Deploy Kroki your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy Kroki from the CLI

levelrail-cli templates deploy kroki --name my-kroki

Deploy Kroki with the API

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/kroki/deploy

Kroki configuration

Kroki services

ServiceImagePortsVolumes
kroki yuzutech/kroki:0.28.0 8000 none

Kroki environment variables

The catalog lists no environment variables for this template.

Ports and volumes

Ports
8000
Volumes
none

Kroki FAQ

How much memory does Kroki need?

The catalog lists about 512 MiB of memory for Kroki.

Does Kroki run on arm64?

For Kroki, arm64 support is not confirmed; amd64 is unknown.

What licence is Kroki under?

Kroki is licensed under MIT, which is permissive, with few conditions on reuse.

Does Kroki need configuration before it starts?

No. The template fills in its own defaults.

Which ports does Kroki use?

Kroki listens on port 8000 inside the stack.

Can I deploy Kroki on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for Kroki, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image yuzutech/kroki:0.28.0 is what you deploy there.

levelrail-cli templates deploy kroki --name my-kroki