Att hosta Kroki på en Managed VPS innebär att du renderar dina diagram i PlantUML, Mermaid, GraphViz, D2, BPMN eller Excalidraw på en egen maskin, som våra team håller uppdaterad och bevakar dag och natt. Kroki är fri programvara under MIT-licensen. Den här guiden följer den officiella dokumentationen: gatewayen och dess följecontainrar, installation med Docker Compose, konfigurationen, HTTPS, skyddet av en publik instans, anslutningen av Asciidoctor och MkDocs, säkerhetskopior och uppdateringar.
Av Simon Vasconcelos Lee
Publicerad den 20 november 2026Lästid: 14 minuter
yuzutech/kroki.KROKI_*_HOST: Docker Compose startar dem tillsammans.SECURE, som hindrar det från att läsa filer eller nätverket; åtkomsten till en publik instans styrs i den omvända proxyn.compose.yaml och proxyns, och uppdatera sedan med docker compose pull, efter att ha läst varje versionsanteckning.Kroki erbjuder ett enhetligt HTTP-API som tar emot ett diagram beskrivet som text och returnerar en bild. Din dokumentation, din wiki eller din kodplattform skickar diagrammets källkod; Kroki svarar med en SVG och, beroende på diagramtyp, en PNG, en PDF eller en JPEG. Dess README räknar upp BlockDiag, BPMN, Bytefield, C4 med PlantUML, D2, DBML, diagrams.net, Ditaa, Erd, Excalidraw, GoAT, GraphViz, Lini, Mermaid, Nomnoml, Pikchr, PlantUML, Svgbob, Symbolator, UMLet, Vega, Vega-Lite, WaveDrom och WireViz.
/plantuml/svg/SyfFKj2rKt3CoKnELR1Io4ZDoSa70000. En webbsida visar det då som vilken annan bild som helst./graphviz/svg, eller i JSON-kroppen.Kroki-Diagram-Options-*.Dokumentationen för tillägget Asciidoctor Kroki ger tre skäl att köra en egen server i stället för den publika instansen kroki.io: en företagsbrandvägg som blockerar den, fördröjningen när du befinner dig långt från den europeiska instansen, och sekretessen, när diagrammens källkod måste stanna inom din infrastruktur.
Kroki publiceras under MIT-licensen. Den ger kostnadsfritt rätten att använda, kopiera, ändra, slå samman, publicera, distribuera, underlicensiera och sälja kopior av programvaran. Du kan alltså köra den för ditt företag, ditt team eller dina kunder, utan att köpa någon licens.
Det enda villkoret är att behålla upphovsrättsmeddelandet och licenstexten i alla kopior eller väsentliga delar av programvaran. Texten tillhandahåller programvaran ”i befintligt skick”, utan garanti. Diagrambiblioteken som följer med Kroki behåller var och en sin egen licens.
Kroki har en modulär arkitektur. En gateway skriven i Java, på Vert.x, tar emot varje förfrågan och skickar den vidare till rätt bibliotek. Endast avbilden yuzutech/kroki är obligatorisk: dokumentationen påpekar att den, beroende på dina diagram, kan räcka.
| Avbild | Vad den renderar | Obligatorisk |
|---|---|---|
yuzutech/kroki | Gatewayen, samt ActDiag, BlockDiag, Bytefield, D2, Ditaa, Erd, GoAT, GraphViz, Lini, Nomnoml, NwDiag, PacketDiag, Pikchr, PlantUML och C4, RackDiag, SeqDiag, Structurizr, Svgbob, Symbolator, UMLet, Vega, Vega-Lite, WaveDrom och WireViz | Ja |
yuzutech/kroki-mermaid | Mermaid: flödesscheman, sekvens- och Gantt-diagram | Nej |
yuzutech/kroki-bpmn | BPMN, med bpmn-js | Nej |
yuzutech/kroki-excalidraw | Excalidraw, den handritade stilen | Nej |
yuzutech/kroki-diagramsnet | diagrams.net, fortfarande experimentell | Nej |
Dokumentationen anger ingen siffra för minne eller processor. Den säger däremot vad som väger tyngst: följecontainrarna för Mermaid, BPMN, Excalidraw och diagrams.net renderar varje diagram i en Chromium-webbläsare utan gränssnitt. För att en våg av konverteringar inte ska överskrida containerns minne begränsar var och en sina samtidiga renderingar: som standard 6 för Mermaid, BPMN och diagrams.net, 4 för Excalidraw. Ytterligare förfrågningar väntar på sin tur i en kö.
yuzutech/kroki 0.36.0 cirka 1 GB komprimerad. Kroki skriver inga data: det behåller ingenting mellan två förfrågningar.amd64 och arm64.depends_on och KROKI_*_HOST.På en Managed VPS berättar du om dina diagram, de följecontainrar de behöver och den trafik du väntar dig, så rekommenderar vi lämplig storlek.
Dokumentationen rekommenderar containrar, Docker eller Podman, så att du slipper installera varje bibliotek för hand. Skapa en mapp på en server där Docker är installerat och lägg denna compose.yaml i den, hämtad från dokumentationen:
services:
kroki:
image: yuzutech/kroki:0.36.0
restart: unless-stopped
depends_on:
- mermaid
- bpmn
- excalidraw
environment:
- KROKI_MERMAID_HOST=mermaid
- KROKI_BPMN_HOST=bpmn
- KROKI_EXCALIDRAW_HOST=excalidraw
ports:
- "127.0.0.1:8000:8000"
# If you mount /tmp yourself, keep the exec option
tmpfs:
- /tmp:exec
mermaid:
image: yuzutech/kroki-mermaid:0.36.0
restart: unless-stopped
expose:
- "8002"
bpmn:
image: yuzutech/kroki-bpmn:0.36.0
restart: unless-stopped
expose:
- "8003"
excalidraw:
image: yuzutech/kroki-excalidraw:0.36.0
restart: unless-stopped
expose:
- "8004"
docker compose up -d
127.0.0.1: detta är den första ändringen jämfört med dokumentationens exempel, som publicerar 8000:8000. Kroki lyssnar som standard på alla gränssnitt, och Docker publicerar en port på alla serverns adresser när ingen anges. Här nås API:et bara via den omvända proxyn.expose: den stannar på det interna Compose-nätverket, där gatewayen når dem via tjänstens namn. Variablerna KROKI_MERMAID_HOST, KROKI_BPMN_HOST och KROKI_EXCALIDRAW_HOST anger det namnet; deras standardportar, 8002, 8003 och 8004, behöver inte upprepas.0.36.0 är den andra ändringen: dokumentationens exempel följer den senaste versionen. De fyra avbilderna publiceras tillsammans under samma tagg, som därmed låser en sammanhängande version och gör varje uppdatering till ett medvetet beslut.För diagrams.net, fortfarande experimentell, lägger README:n till en fjärde följecontainer. Lägg till den här tjänsten, och variabeln KROKI_DIAGRAMSNET_HOST=diagramsnet i environment för kroki:
diagramsnet:
image: yuzutech/kroki-diagramsnet:0.36.0
restart: unless-stopped
expose:
- "8005"
Från servern returnerar vägen /health gatewayens status och versionerna av de bibliotek den levereras med. De två följande förfrågningarna renderar ett GraphViz-diagram via gatewayen och sedan ett Mermaid-diagram via dess följecontainer:
curl http://127.0.0.1:8000/health
curl http://127.0.0.1:8000/graphviz/svg --data-raw 'digraph G {Hello->World}'
curl http://127.0.0.1:8000/mermaid/svg --data-raw 'graph TD; A-->B'
Dokumentationens andra väg är den fristående servern, publicerad på kodförrådets versionssida som kroki-standalone-server-v0.36.0.jar. Den kräver Java 21 eller senare och innehåller inga diagrambibliotek: vart och ett installeras separat, och dess sökväg anges med en variabel som KROKI_DOT_BIN_PATH när programmet inte finns i PATH. För lyssningsadressen är KROKI_LISTEN att föredra, eftersom konfigurationsdokumentationen meddelar att KROKI_PORT kommer att tas bort:
KROKI_LISTEN=127.0.0.1:8000 java -jar kroki-standalone-server-v0.36.0.jar
Kroki har varken administrationssida, användarkonton eller databas: dess konfiguration är en uppsättning miljövariabler, eller Java-systemegenskaper med jar-filen. I Docker Compose står de i blocket environment för den berörda tjänsten, och sedan återskapar docker compose up -d containern. De inställningar som betyder mest för en server:
| Variabel | Standard | Vad den gör |
|---|---|---|
KROKI_SAFE_MODE | secure | Säkerhetsnivån, som beskrivs nedan |
KROKI_LISTEN | Alla gränssnitt, port 8000 | Lyssningsadressen och porten; godtar också en UNIX-socket, unix:// följt av en sökväg |
KROKI_MERMAID_HOST, KROKI_BPMN_HOST, KROKI_EXCALIDRAW_HOST | 127.0.0.1 | Var gatewayen når varje följecontainer; motsvarande variabler _PORT anger porten, och KROKI_DIAGRAMSNET_HOST gäller diagrams.net |
KROKI_COMMAND_TIMEOUT | 5 sekunder | Den längsta väntetiden på ett diagramprogram, som dot |
KROKI_CONVERT_TIMEOUT | 20 sekunder | Den längsta väntetiden på ett Java-bibliotek, som PlantUML |
KROKI_DELEGATE_TIMEOUT_MS | 30 000 | Den längsta väntetiden på en följecontainer, i millisekunder |
KROKI_MAX_URI_LENGTH | 4 096 | Den URL-längd som godtas med GET, utöver vilken Kroki svarar 414 |
KROKI_CONTENT_SECURITY_POLICY | script-src 'none'; object-src 'none' | Rubriken Content-Security-Policy, som skickas med varje svar |
KROKI_CORS_ALLOWED_HEADERS | Inga extra | Ytterligare rubriker som tillåts för anrop från en annan webbplats |
Excalidraw-diagram ger långa URL:er. Om du höjer KROKI_MAX_URI_LENGTH rekommenderar dokumentationen att hålla sig på högst 8 192 tecken, även om de flesta webbläsare godtar mer i en tagg <img>. För de största diagrammen bär en POST-förfrågan källkoden i kroppen i stället för i URL:en.
Kroki behöver ingen hemlighet för att köras. Två valfria inställningar innehåller en: token KROKI_COMPANION_REGISTRATION_TOKEN, användbar om du aktiverar registrering av följecontainrar från tredje part, som tas upp i avsnittet om skydd, och den privata nyckeln till ett certifikat, om du låter Kroki själv hantera HTTPS. Håll dem utanför alla kodförråd.
Gatewayen levererar sitt API över HTTP. En omvänd proxy framför den lyssnar på portarna 80 och 443, hämtar certifikatet från Let’s Encrypt, krypterar trafiken och skickar den vidare till Kroki på 127.0.0.1:8000. Det är också där åtkomsten filtreras, som nästa avsnitt visar.
Caddy hämtar och förnyar certifikatet för det angivna namnet på egen hand, och dess direktiv reverse_proxy skickar vidare rubrikerna X-Forwarded-For, X-Forwarded-Proto och X-Forwarded-Host utan extra inställning:
diagrams.example.com {
encode gzip
reverse_proxy 127.0.0.1:8000
}
Det här serverblocket lyssnar på port 80 så att Certbot kan sätta upp HTTPS. Två av Nginx gränser möter Krokis: en förfrågningskropp på över 1 MB avvisas som standard med en 413, vilket client_max_body_size justerar för stora diagram som skickas med POST; en förfrågningsrad längre än 8 KB får en 414, vilket large_client_header_buffers justerar om du höjer KROKI_MAX_URI_LENGTH utöver det.
server {
listen 80;
listen [::]:80;
server_name diagrams.example.com;
client_max_body_size 1m;
location / {
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_pass http://127.0.0.1:8000;
}
}
sudo nginx -t
sudo certbot --nginx
Dokumentationen beskriver också kryptering av Kroki självt: KROKI_SSL=true, med certifikatet och den privata nyckeln i PEM-format, som text via KROKI_SSL_CERT och KROKI_SSL_KEY, eller som filer via KROKI_SSL_CERT_PATH och KROKI_SSL_KEY_PATH. Förnyelsen av certifikatet görs då för hand, medan Caddy eller Certbot sköter den på egen hand framför en proxy.
Kroki har ingen autentisering: den som når API:et kan få det att rendera diagram. Skyddet vilar därför på tre saker, som beskrivs i dokumentationen och versionsanteckningarna: säkerhetsläget, gränserna för storlek och tid, och det som proxyn släpper igenom. Börja med att ta reda på vem som behöver nå din server.
kroki-fetch-diagram, MkDocs-insticksprogrammet med http_method: POST: bilderna sparas med webbplatsen, och Kroki-servern behöver inte längre vara publik.KROKI_SAFE_MODE anger tre nivåer, där var och en omfattar den föregåendes begränsningar. Dokumentationen förklarar att vissa bibliotek kan läsa filer eller URL:er, som PlantUML:s direktiv !include, och att Kroki, som inte granskar deras kod, blockerar sådan åtkomst som standard. Den uppmanar alla som driver en server att välja den nivå som passar deras användning.
| Nivå | Vad den gör |
|---|---|
SECURE, standard | Förhindrar varje försök att läsa filer från filsystemet eller resurser från nätverket |
SAFE | Förlitar sig på den rensning av förfrågningar som varje biblioteks eget säkra läge gör |
UNSAFE | Stänger av alla säkerhetsfunktioner |
SECURE avvisas dess !include och !includeurl, och dess säkerhetsprofil är SANDBOX. I SAFE blir profilen ALLOWLIST, och KROKI_PLANTUML_ALLOWLIST_URL eller KROKI_PLANTUML_ALLOWLIST_PATH anger vad som får inkluderas.UNSAFE laddar deras webbläsare bara lokala resurser. För att tillåta en intern bildbank utan att lämna det läget erbjuder dokumentationen KROKI_ALLOWED_ORIGINS, eller formen per följecontainer som KROKI_MERMAID_ALLOWED_ORIGINS, på följecontainerns container.UNSAFE: ingen !include för Structurizr, ingen extern bild för BlockDiag, ingen filläsning för Lini.KROKI_STRUCTURIZR_SAFE_MODE eller KROKI_MERMAID_SAFE_MODE, i stället för att sänka nivån för hela servern.Behåll SECURE på en publik instans. Rubriken Content-Security-Policy, som skickas som standard sedan 0.36.0, kompletterar skyddet: ett skript som smugglats in i en SVG körs inte på Krokis ursprung, inte ens när bilden öppnas direkt.
Tidsgränserna i konfigurationstabellen begränsar varje konvertering. Följecontainrarna lägger till sina egna, utformade mot resursutmattning:
KROKI_MERMAID_MAX_TEXT_SIZE) eller med fler än 500 kanter, med en 400, och avbryter en rendering efter 10 sekunder, med en 408. Dessa gränser kan inte åsidosättas via en förfrågans parametrar.KROKI_MAX_BODY_SIZE).När bara din publiceringskedja anropar Kroki är det enklast att godta enbart dess IP-adress. Med Caddy väljer matcharen remote_ip ut de övriga adresserna, och respond skickar dem en 403:
diagrams.example.com {
@external not remote_ip 203.0.113.10
respond @external 403
reverse_proxy 127.0.0.1:8000
}
Med Nginx gör direktiven allow och deny i blocket location samma jobb, där den första regel som matchar gäller:
allow 203.0.113.10;
deny all;
Proxyns grundläggande autentisering är den andra vägen: basic_auth med Caddy, vars lösenord hashas med caddy hash-password, eller auth_basic och en fil som skapas med htpasswd med Nginx. Den passar klienter som skickar inloggningsuppgifterna med varje anrop, som curl -u; för en dokumentationskedja bör du kontrollera att dess verktyg kan skicka vidare dem. För en instans som förblir publik kan Nginx också begränsa antalet förfrågningar per IP-adress med sin modul limit_req, anpassad efter antalet diagram på dina sidor.
Kroki kan ta emot följecontainrar från tredje part som registrerar sig via API:et /services. Den upptäckten är avstängd som standard och förblir alltid avstängd i läget SECURE. Om du aktiverar den med KROKI_ENABLE_COMPANION_DISCOVERY=true ber dokumentationen dig att hålla /services på ett betrott nätverk och rekommenderar starkt token KROKI_COMPANION_REGISTRATION_TOKEN: utan den varnar Kroki vid start för att vilken klient som helst av gatewayen kan registrera en följecontainer.
Asciidoctor Kroki och MkDocs-insticksprogrammet pekar som standard på https://kroki.io. Allt de behöver är din servers URL, med prefixet https://.
Tillägget Asciidoctor Kroki läser attributet kroki-server-url, i dokumenthuvudet, på kommandoraden eller i Antora-playbooken. Lägg till kroki-fetch-diagram för att hämta bilderna vid bygget i stället för att låta HTML-koden peka på din server; det alternativet kräver ett säkerhetsläge i Asciidoctor på server eller lägre.
:kroki-server-url: https://diagrams.example.com
:kroki-fetch-diagram:
Insticksprogrammet mkdocs-kroki-plugin läser server_url, som standard miljövariabeln KROKI_SERVER_URL. Med http_method: POST sparas bilderna bredvid varje sida i den byggda webbplatsen och cachas mellan två byggen:
plugins:
- kroki:
server_url: https://diagrams.example.com
http_method: POST
Dokumentationens sida om verktyg från tredje part nämner också GitLab, som renderar Kroki-diagram i Markdown, AsciiDoc, reST och Textile, Sphinx, Jekyll, Hugo, Remark, Python-Markdown, MediaWiki, tillägg för Visual Studio Code och IntelliJ samt Kroki.jl för Julia. Vilken HTTP-klient som helst fungerar också, som i det här exemplet från dokumentationen:
curl https://diagrams.example.com/erd/svg --data-binary '@project.erd'
Kroki är tillståndslöst: det behåller ingenting mellan två förfrågningar, och till och med registret över följecontainrar från tredje part försvinner vid en omstart. Källkoden till dina diagram finns i dina dokumentationsförråd, och bilderna i dina byggda webbplatser. På Kroki-servern är det konfigurationen som säkerhetskopieras:
| Del | Vad den innehåller | Säkerhetskopiera |
|---|---|---|
compose.yaml | Avbilderna, deras taggar och variablerna KROKI_* | Ja |
Filen .env, om den finns | Variabler som hålls utanför compose.yaml, som en token eller ett certifikat | Ja, på ett säkert ställe |
| Proxyns konfiguration | Caddyfile eller Nginx-blocket, och lösenordsfilen | Ja |
| Docker-avbilder | Själva programvaran | Nej: docker compose pull hämtar dem igen |
tar -czf kroki-config-$(date +%F).tar.gz compose.yaml /etc/caddy/Caddyfile
Anpassa listan efter din proxy, gör en ny kopia efter varje ändring av konfigurationen och skicka den utanför servern. Lagrad på dess disk ingår den också i dess nattliga säkerhetskopior. En återställning innebär att lägga tillbaka filerna och köra docker compose up -d.
Med låsta taggar ändrar du versionen för de fyra avbilderna i compose.yaml och kör sedan, från dess mapp:
docker compose pull
docker compose up -d
Kroki följer semantisk versionshantering, och varje version publicerar sina ändringar i CHANGELOG.md och på sin versionssida. Läs dem före uppdateringen, särskilt deras avsnitt ”Security”: 0.35.0 från den 5 november 2026 och 0.36.0 från den 9 november 2026 åtgärdar fjärrkörning av kod via Bytefield- och TikZ-diagram, XSS-sårbarheter i GoAT och DBML samt förfalskning av förfrågningar på serversidan via BlockDiag och följecontainrarna. På en öppen instans driftsätter du dessa versioner utan dröjsmål.
Version 0.36.0 lägger också till rubriken Content-Security-Policy som standard och layoutmotorn TALA för D2. För den manuella installationen anger den Java 21 som lägsta version.
Att självhosta innebär att sköta servern utöver applikationen. På en Managed VPS tar våra team hand om servern och följer din instans proaktivt; Kroki förblir din programvara, med sin konfiguration och sina följecontainrar.
| Område | Våra team | Du |
|---|---|---|
| Servern | Uppdateringar av system och säkerhet, ingrepp på servern inräknade | Tidpunkten som passar din verksamhet |
| Övervakningen | Servern följs dygnet runt, alla dagar, med ingrepp utan att vänta på ditt samtal | Läsningen av din instans loggar |
| Kroki | Proaktiv uppföljning: fel, långsamma svarstider, följecontainrarnas minne och diskutrymme upptäcks, med rekommenderad rättelse | Installationen, uppdateringarna och inställningarna, som du genomför själv eller med din AI-assistent |
| Diagrammen och åtkomsten | Servern som renderar dem, övervakad och säkerhetskopierad | Säkerhetsläget, följecontainrarna, gränserna och proxyns åtkomstregler |
| Säkerhetskopiorna | Varje natt, krypterade och förvarade utanför maskinen; återställning ingår | Kopiorna av din konfiguration som du förvarar på annat håll, och begäran om återställning, när du behöver den |
| Migreringen | Din nuvarande server migreras kostnadsfritt | Tidpunkten för bytet |
Om du föredrar att våra team ingriper i själva applikationen faktureras den tjänsten per timme eller som fast pris, med en offert som lämnas före ingreppet.
Med en Managed VPS från Simafri håller våra team servern för din Kroki-instans uppdaterad, övervakar den dag och natt och griper in utan att vänta på ditt samtal; de följer också din instans proaktivt och rekommenderar de rättelser som är till nytta, som du genomför själv eller med din AI-assistent. Säkerhetskopiorna krypteras varje natt och förvaras utanför maskinen, återställningen ingår, och migreringen av din nuvarande server är kostnadsfri.
Ja. Kroki omfattas av MIT-licensen: du kan använda, ändra och vidaredistribuera det i ett företag utan att köpa någon licens, så länge du behåller dess upphovsrättsmeddelande. Det som återstår är kostnaden för servern som kör det.
Bara för de diagram som de renderar. Avbilden yuzutech/kroki räcker för PlantUML, GraphViz, D2, Structurizr och de flesta format. Mermaid, BPMN, Excalidraw och diagrams.net behöver var sin följecontainer, ansluten via KROKI_MERMAID_HOST, KROKI_BPMN_HOST, KROKI_EXCALIDRAW_HOST eller KROKI_DIAGRAMSNET_HOST.
Skapa en compose.yaml med avbilden yuzutech/kroki, dess port 8000 publicerad på 127.0.0.1, och de följecontainrar du behöver, som yuzutech/kroki-mermaid, anslutna via variablerna KROKI_*_HOST. Kör docker compose up -d, kontrollera /health och placera sedan en omvänd proxy med HTTPS framför port 8000.
Nej, Kroki har varken konton, administrationssida eller databas. Dess konfiguration är en uppsättning miljövariabler KROKI_*, och åtkomsten till API:et styrs i den omvända proxyn, via IP-adress eller med grundläggande autentisering.
Behåll läget SECURE, som är aktivt som standard och hindrar biblioteken från att läsa filer eller nätverket. Låt gränserna för tid och storlek vara kvar, uppdatera så snart en version åtgärdar en sårbarhet, och godta bara din publiceringskedjas adress i proxyn om det bara är den som anropar Kroki.
Med Asciidoctor sätter du attributet kroki-server-url till din servers URL, och kroki-fetch-diagram för att hämta bilderna vid bygget. Med MkDocs sätter du server_url i konfigurationen av insticksprogrammet kroki, och http_method: POST för att spara bilderna med webbplatsen.
Bara dess konfiguration: compose.yaml, en eventuell fil .env och den omvända proxyns konfiguration. Kroki behåller inga data, och dess Docker-avbilder hämtas igen med docker compose pull.
En Managed VPS täcker servern: system, säkerhet, övervakning och säkerhetskopior. Våra team följer också din instans proaktivt och rekommenderar de rättelser som är till nytta, som du genomför själv. Ett ingrepp i själva applikationen faktureras per timme eller som fast pris.
Simafri
Låt oss prata om din webbplats
Berätta om ditt projekt med några ord: vi återkommer snabbt.
Tack! Din förfrågan har skickats. Vi återkommer till dig inom kort.
Föredrar du e-post? Skriv till oss på support@simafri.com.