Η φιλοξενία του Kroki σε ένα Managed VPS σημαίνει ότι δημιουργείτε τα διαγράμματά σας PlantUML, Mermaid, GraphViz, D2, BPMN ή Excalidraw σε ένα δικό σας μηχάνημα, που οι ομάδες μας κρατούν ενημερωμένο και επιτηρούν μέρα και νύχτα. Το Kroki είναι ελεύθερο λογισμικό με άδεια MIT. Ο οδηγός αυτός ακολουθεί την επίσημη τεκμηρίωσή του: την πύλη και τα συνοδευτικά της κοντέινερ, την εγκατάσταση με Docker Compose, τις ρυθμίσεις, το HTTPS, την προστασία ενός δημόσιου στιγμιοτύπου, τη σύνδεση του Asciidoctor και του MkDocs, τα αντίγραφα ασφαλείας και τις ενημερώσεις.
Συντάκτης: Simon Vasconcelos Lee
Δημοσιεύθηκε στις 20 Νοεμβρίου 2026Χρόνος ανάγνωσης: 14 λεπτά
yuzutech/kroki.KROKI_*_HOST: το Docker Compose τα εκκινεί μαζί.SECURE, που το εμποδίζει να διαβάζει αρχεία ή το δίκτυο· η πρόσβαση σε ένα δημόσιο στιγμιότυπο ελέγχεται στον reverse proxy.compose.yaml και του proxy, και στη συνέχεια ενημερώνετε με docker compose pull, αφού διαβάσετε πρώτα τις σημειώσεις κάθε έκδοσης.Το Kroki προσφέρει ένα ενιαίο HTTP API που δέχεται ένα διάγραμμα περιγραμμένο ως κείμενο και επιστρέφει μια εικόνα. Η τεκμηρίωσή σας, το wiki σας ή η πλατφόρμα κώδικά σας στέλνει την πηγή του διαγράμματος· το Kroki απαντά με ένα SVG και, ανάλογα με τον τύπο του διαγράμματος, με ένα PNG, ένα PDF ή ένα JPEG. Το README του αναφέρει τα BlockDiag, BPMN, Bytefield, C4 με PlantUML, D2, DBML, diagrams.net, Ditaa, Erd, Excalidraw, GoAT, GraphViz, Lini, Mermaid, Nomnoml, Pikchr, PlantUML, Svgbob, Symbolator, UMLet, Vega, Vega-Lite, WaveDrom και WireViz.
/plantuml/svg/SyfFKj2rKt3CoKnELR1Io4ZDoSa70000. Μια ιστοσελίδα το εμφανίζει τότε όπως κάθε άλλη εικόνα./graphviz/svg, ή στο σώμα JSON.Kroki-Diagram-Options-*.Η τεκμηρίωση της επέκτασης Asciidoctor Kroki δίνει τρεις λόγους για να τρέχετε τον δικό σας διακομιστή αντί για το δημόσιο στιγμιότυπο kroki.io: ένα εταιρικό τείχος προστασίας που το μπλοκάρει, την καθυστέρηση όταν βρίσκεστε μακριά από αυτό το ευρωπαϊκό στιγμιότυπο, και το απόρρητο, όταν οι πηγές των διαγραμμάτων πρέπει να μένουν μέσα στην υποδομή σας.
Το Kroki διατίθεται με την άδεια MIT. Η άδεια παραχωρεί δωρεάν το δικαίωμα να χρησιμοποιείτε, να αντιγράφετε, να τροποποιείτε, να συγχωνεύετε, να δημοσιεύετε, να διανέμετε, να παραχωρείτε υποάδειες και να πουλάτε αντίγραφα του λογισμικού. Μπορείτε επομένως να το τρέχετε για την επιχείρησή σας, την ομάδα σας ή τους πελάτες σας, χωρίς να αγοράσετε άδεια.
Η μόνη προϋπόθεση είναι να διατηρείτε τη σημείωση πνευματικών δικαιωμάτων και το κείμενο της άδειας σε όλα τα αντίγραφα ή σε ουσιώδη τμήματα του λογισμικού. Το κείμενο παρέχει το λογισμικό «ως έχει», χωρίς εγγύηση. Οι βιβλιοθήκες διαγραμμάτων που ενσωματώνει το Kroki διατηρούν η καθεμία τη δική της άδεια.
Το Kroki έχει αρθρωτή αρχιτεκτονική. Μια πύλη (gateway) γραμμένη σε Java, πάνω στο Vert.x, δέχεται κάθε αίτημα και το δρομολογεί στη σωστή βιβλιοθήκη. Μόνο η εικόνα yuzutech/kroki είναι υποχρεωτική: η τεκμηρίωση σημειώνει ότι, ανάλογα με τα διαγράμματά σας, μπορεί να αρκεί.
| Εικόνα | Τι δημιουργεί | Υποχρεωτική |
|---|---|---|
yuzutech/kroki | Την πύλη, καθώς και τα ActDiag, BlockDiag, Bytefield, D2, Ditaa, Erd, GoAT, GraphViz, Lini, Nomnoml, NwDiag, PacketDiag, Pikchr, PlantUML και C4, RackDiag, SeqDiag, Structurizr, Svgbob, Symbolator, UMLet, Vega, Vega-Lite, WaveDrom και WireViz | Ναι |
yuzutech/kroki-mermaid | Mermaid: διαγράμματα ροής, ακολουθίας και Gantt | Όχι |
yuzutech/kroki-bpmn | BPMN, με το bpmn-js | Όχι |
yuzutech/kroki-excalidraw | Excalidraw, το στυλ «σχεδιασμένο στο χέρι» | Όχι |
yuzutech/kroki-diagramsnet | diagrams.net, ακόμη πειραματικό | Όχι |
Η τεκμηρίωση δεν δίνει αριθμούς για τη μνήμη ή την CPU. Λέει όμως τι βαραίνει περισσότερο: τα συνοδευτικά κοντέινερ Mermaid, BPMN, Excalidraw και diagrams.net δημιουργούν κάθε διάγραμμα σε έναν περιηγητή Chromium χωρίς γραφικό περιβάλλον (headless). Για να μην ξεπεράσει μια ριπή μετατροπών τη μνήμη του κοντέινερ, το καθένα περιορίζει τις ταυτόχρονες δημιουργίες του: 6 εξ ορισμού για τα Mermaid, BPMN και diagrams.net, 4 για το Excalidraw. Τα επόμενα αιτήματα περιμένουν τη σειρά τους σε μια ουρά.
yuzutech/kroki 0.36.0 ζυγίζει περίπου 1 GB συμπιεσμένη. Το Kroki δεν γράφει δεδομένα: δεν κρατά τίποτα από το ένα αίτημα στο άλλο.amd64 και arm64.depends_on και KROKI_*_HOST.Σε ένα Managed VPS, πείτε μας για τα διαγράμματά σας, τα συνοδευτικά κοντέινερ που χρειάζονται και την κίνηση που περιμένετε, και θα σας προτείνουμε το κατάλληλο μέγεθος.
Η τεκμηρίωση συνιστά τα κοντέινερ, Docker ή Podman, ώστε να μη χρειάζεται να εγκαταστήσετε κάθε βιβλιοθήκη με το χέρι. Σε έναν διακομιστή με εγκατεστημένο Docker, δημιουργήστε έναν φάκελο και βάλτε μέσα αυτό το compose.yaml, παρμένο από την τεκμηρίωση:
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: είναι η πρώτη αλλαγή σε σχέση με το παράδειγμα της τεκμηρίωσης, που δημοσιεύει 8000:8000. Το Kroki ακούει εξ ορισμού σε όλες τις διεπαφές, και το Docker δημοσιεύει μια θύρα σε κάθε διεύθυνση του διακομιστή όταν δεν του δίνεται καμία. Εδώ, το API είναι προσβάσιμο μόνο μέσω του reverse proxy.expose: μένει στο εσωτερικό δίκτυο του Compose, όπου η πύλη τα βρίσκει με το όνομα της υπηρεσίας. Οι μεταβλητές KROKI_MERMAID_HOST, KROKI_BPMN_HOST και KROKI_EXCALIDRAW_HOST δίνουν αυτό το όνομα· οι προεπιλεγμένες θύρες τους, 8002, 8003 και 8004, δεν χρειάζεται να επαναληφθούν.0.36.0 είναι η δεύτερη αλλαγή: το παράδειγμα της τεκμηρίωσης ακολουθεί την πιο πρόσφατη έκδοση. Οι τέσσερις εικόνες δημοσιεύονται μαζί με την ίδια ετικέτα, κάτι που κλειδώνει μια συνεπή έκδοση και κάνει κάθε ενημέρωση συνειδητή.Για το diagrams.net, ακόμη πειραματικό, το README προσθέτει ένα τέταρτο συνοδευτικό κοντέινερ. Προσθέστε αυτή την υπηρεσία, καθώς και τη μεταβλητή KROKI_DIAGRAMSNET_HOST=diagramsnet στο environment του kroki:
diagramsnet:
image: yuzutech/kroki-diagramsnet:0.36.0
restart: unless-stopped
expose:
- "8005"
Από τον διακομιστή, η διαδρομή /health επιστρέφει την κατάσταση της πύλης και τις εκδόσεις των βιβλιοθηκών που ενσωματώνει. Τα δύο επόμενα αιτήματα δημιουργούν ένα διάγραμμα GraphViz μέσω της πύλης και στη συνέχεια ένα διάγραμμα Mermaid μέσω του συνοδευτικού του κοντέινερ:
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'
Ο άλλος δρόμος της τεκμηρίωσης είναι ο αυτόνομος διακομιστής, που δημοσιεύεται στη σελίδα εκδόσεων του αποθετηρίου ως kroki-standalone-server-v0.36.0.jar. Απαιτεί Java 21 ή νεότερη, και δεν περιλαμβάνει καμία βιβλιοθήκη διαγραμμάτων: η καθεμία εγκαθίσταται χωριστά, και η διαδρομή της ορίζεται με μια μεταβλητή όπως η KROKI_DOT_BIN_PATH όταν το εκτελέσιμο δεν βρίσκεται στο PATH. Για τη διεύθυνση ακρόασης, προτιμήστε την KROKI_LISTEN, αφού η τεκμηρίωση των ρυθμίσεων ανακοινώνει ότι η KROKI_PORT θα αφαιρεθεί:
KROKI_LISTEN=127.0.0.1:8000 java -jar kroki-standalone-server-v0.36.0.jar
Το Kroki δεν έχει σελίδα διαχείρισης, λογαριασμούς χρηστών ούτε βάση δεδομένων: οι ρυθμίσεις του είναι ένα σύνολο μεταβλητών περιβάλλοντος, ή ιδιοτήτων συστήματος Java με το jar. Στο Docker Compose, μπαίνουν στο μπλοκ environment της σχετικής υπηρεσίας, και στη συνέχεια το docker compose up -d αναδημιουργεί το κοντέινερ. Οι ρυθμίσεις που μετρούν περισσότερο για έναν διακομιστή:
| Μεταβλητή | Προεπιλογή | Τι κάνει |
|---|---|---|
KROKI_SAFE_MODE | secure | Το επίπεδο ασφάλειας, που περιγράφεται παρακάτω |
KROKI_LISTEN | Όλες οι διεπαφές, θύρα 8000 | Η διεύθυνση και η θύρα ακρόασης· δέχεται επίσης ένα UNIX socket, unix:// ακολουθούμενο από μια διαδρομή |
KROKI_MERMAID_HOST, KROKI_BPMN_HOST, KROKI_EXCALIDRAW_HOST | 127.0.0.1 | Πού βρίσκει η πύλη κάθε συνοδευτικό κοντέινερ· οι αντίστοιχες μεταβλητές _PORT ορίζουν τη θύρα, και η KROKI_DIAGRAMSNET_HOST εξυπηρετεί το diagrams.net |
KROKI_COMMAND_TIMEOUT | 5 δευτερόλεπτα | Η μέγιστη αναμονή για ένα εκτελέσιμο διαγραμμάτων, όπως το dot |
KROKI_CONVERT_TIMEOUT | 20 δευτερόλεπτα | Η μέγιστη αναμονή για μια βιβλιοθήκη Java, όπως το PlantUML |
KROKI_DELEGATE_TIMEOUT_MS | 30.000 | Η μέγιστη αναμονή για ένα συνοδευτικό κοντέινερ, σε χιλιοστά του δευτερολέπτου |
KROKI_MAX_URI_LENGTH | 4.096 | Το μήκος URL που γίνεται δεκτό με GET, πέρα από το οποίο το Kroki απαντά 414 |
KROKI_CONTENT_SECURITY_POLICY | script-src 'none'; object-src 'none' | Η κεφαλίδα Content-Security-Policy που στέλνεται με κάθε απάντηση |
KROKI_CORS_ALLOWED_HEADERS | Καμία επιπλέον | Πρόσθετες κεφαλίδες που επιτρέπονται για κλήσεις από άλλον ιστότοπο |
Τα διαγράμματα Excalidraw παράγουν μακριά URL. Αν αυξήσετε την KROKI_MAX_URI_LENGTH, η τεκμηρίωση συνιστά να μείνετε στους 8.192 χαρακτήρες ή λιγότερο, παρόλο που οι περισσότεροι περιηγητές δέχονται περισσότερους σε μια ετικέτα <img>. Για τα μεγαλύτερα διαγράμματα, ένα αίτημα POST μεταφέρει την πηγή στο σώμα αντί για το URL.
Το Kroki δεν χρειάζεται κανένα μυστικό για να λειτουργήσει. Δύο προαιρετικές ρυθμίσεις περιέχουν ένα: το token KROKI_COMPANION_REGISTRATION_TOKEN, χρήσιμο αν ενεργοποιήσετε την καταχώριση συνοδευτικών κοντέινερ τρίτων, που καλύπτεται στην ενότητα για την προστασία, και το ιδιωτικό κλειδί ενός πιστοποιητικού, αν αφήσετε το Kroki να χειρίζεται μόνο του το HTTPS. Κρατήστε τα εκτός κάθε αποθετηρίου κώδικα.
Η πύλη εξυπηρετεί το API της σε HTTP. Ένας reverse proxy μπροστά της ακούει στις θύρες 80 και 443, αποκτά το πιστοποιητικό Let’s Encrypt, κρυπτογραφεί την κίνηση και τη διαβιβάζει στο Kroki στο 127.0.0.1:8000. Εκεί φιλτράρεται επίσης η πρόσβαση, όπως δείχνει η επόμενη ενότητα.
Το Caddy αποκτά και ανανεώνει μόνο του το πιστοποιητικό για το όνομα που του δίνεται, και η οδηγία του reverse_proxy περνά τις κεφαλίδες X-Forwarded-For, X-Forwarded-Proto και X-Forwarded-Host χωρίς επιπλέον ρύθμιση:
diagrams.example.com {
encode gzip
reverse_proxy 127.0.0.1:8000
}
Αυτό το μπλοκ server ακούει στη θύρα 80 ώστε το Certbot να μπορεί να ρυθμίσει το HTTPS. Δύο όρια του Nginx συναντούν εκείνα του Kroki: ένα σώμα αιτήματος πάνω από 1 MB απορρίπτεται εξ ορισμού με 413, κάτι που προσαρμόζει το client_max_body_size για μεγάλα διαγράμματα που στέλνονται με POST· μια γραμμή αιτήματος μεγαλύτερη από 8 KB παίρνει 414, κάτι που προσαρμόζει το large_client_header_buffers αν αυξήσετε την KROKI_MAX_URI_LENGTH πέρα από αυτό.
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
Η τεκμηρίωση περιγράφει επίσης την κρυπτογράφηση από το ίδιο το Kroki: KROKI_SSL=true, με το πιστοποιητικό και το ιδιωτικό κλειδί σε μορφή PEM, ως κείμενο μέσω των KROKI_SSL_CERT και KROKI_SSL_KEY, ή ως αρχεία μέσω των KROKI_SSL_CERT_PATH και KROKI_SSL_KEY_PATH. Η ανανέωση του πιστοποιητικού γίνεται τότε με το χέρι, ενώ μπροστά από έναν proxy το Caddy ή το Certbot τη φροντίζουν μόνα τους.
Το Kroki δεν έχει έλεγχο ταυτότητας: όποιος φτάνει στο API μπορεί να του ζητήσει να δημιουργήσει διαγράμματα. Η προστασία του στηρίζεται επομένως σε τρία στοιχεία, που περιγράφονται στην τεκμηρίωση και στις σημειώσεις των εκδόσεων: τη λειτουργία ασφάλειας, τα όρια μεγέθους και χρόνου, και ό,τι αφήνει να περάσει ο proxy. Ξεκινήστε προσδιορίζοντας ποιος χρειάζεται να φτάνει στον διακομιστή σας.
kroki-fetch-diagram, το πρόσθετο MkDocs με το http_method: POST: οι εικόνες αποθηκεύονται μαζί με τον ιστότοπο, και ο διακομιστής Kroki δεν χρειάζεται πια να είναι δημόσιος.Η KROKI_SAFE_MODE ορίζει τρία επίπεδα, καθένα από τα οποία περιλαμβάνει τους περιορισμούς του προηγούμενου. Η τεκμηρίωση εξηγεί ότι ορισμένες βιβλιοθήκες μπορούν να διαβάζουν αρχεία ή URL, όπως οι οδηγίες !include του PlantUML, και ότι το Kroki, που δεν ελέγχει τον κώδικά τους, μπλοκάρει εξ ορισμού αυτή την πρόσβαση. Καλεί όποιον τρέχει έναν διακομιστή να επιλέξει το επίπεδο που ταιριάζει στη χρήση του.
| Επίπεδο | Τι κάνει |
|---|---|
SECURE, η προεπιλογή | Αποτρέπει κάθε απόπειρα ανάγνωσης αρχείων από το σύστημα αρχείων ή πόρων από το δίκτυο |
SAFE | Βασίζεται στον καθαρισμό των αιτημάτων που κάνει η ίδια η ασφαλής λειτουργία κάθε βιβλιοθήκης |
UNSAFE | Απενεργοποιεί όλες τις λειτουργίες ασφάλειας |
SECURE, οι !include και !includeurl του απορρίπτονται, και το προφίλ ασφάλειάς του είναι SANDBOX. Σε SAFE, το προφίλ γίνεται ALLOWLIST, και οι KROKI_PLANTUML_ALLOWLIST_URL ή KROKI_PLANTUML_ALLOWLIST_PATH ορίζουν τι μπορεί να συμπεριληφθεί.UNSAFE, ο περιηγητής τους φορτώνει μόνο τοπικούς πόρους. Για να επιτρέψετε μια εσωτερική τράπεζα εικόνων χωρίς να βγείτε από αυτή τη λειτουργία, η τεκμηρίωση προτείνει την KROKI_ALLOWED_ORIGINS, ή τη μορφή της για κάθε συνοδευτικό κοντέινερ όπως η KROKI_MERMAID_ALLOWED_ORIGINS, στο συνοδευτικό κοντέινερ.UNSAFE: χωρίς !include για το Structurizr, χωρίς εξωτερική εικόνα για το BlockDiag, χωρίς ανάγνωση αρχείων για το Lini.KROKI_STRUCTURIZR_SAFE_MODE ή KROKI_MERMAID_SAFE_MODE, αντί να χαμηλώσει το επίπεδο ολόκληρου του διακομιστή.Σε ένα δημόσιο στιγμιότυπο, κρατήστε το SECURE. Η κεφαλίδα Content-Security-Policy, που στέλνεται εξ ορισμού από την 0.36.0, συμπληρώνει αυτή την άμυνα: ένα script κρυμμένο σε ένα SVG δεν εκτελείται στην προέλευση του Kroki, ακόμη κι όταν η εικόνα ανοίγει απευθείας.
Οι χρόνοι αναμονής του πίνακα ρυθμίσεων οριοθετούν κάθε μετατροπή. Τα συνοδευτικά κοντέινερ προσθέτουν τα δικά τους, σχεδιασμένα κατά της εξάντλησης πόρων:
KROKI_MERMAID_MAX_TEXT_SIZE) ή με περισσότερες από 500 ακμές, με 400, και διακόπτει μια δημιουργία μετά από 10 δευτερόλεπτα, με 408. Αυτά τα όρια δεν μπορούν να παρακαμφθούν μέσω των παραμέτρων ενός αιτήματος.KROKI_MAX_BODY_SIZE).Όταν μόνο η αλυσίδα δημοσίευσής σας καλεί το Kroki, η απλούστερη επιλογή είναι να δέχεστε μόνο τη διεύθυνση IP της. Με το Caddy, ο matcher remote_ip ξεχωρίζει τις άλλες διευθύνσεις, και το respond τους στέλνει ένα 403:
diagrams.example.com {
@external not remote_ip 203.0.113.10
respond @external 403
reverse_proxy 127.0.0.1:8000
}
Με το Nginx, οι οδηγίες allow και deny του μπλοκ location κάνουν την ίδια δουλειά, με τον πρώτο κανόνα που ταιριάζει να υπερισχύει:
allow 203.0.113.10;
deny all;
Ο βασικός έλεγχος ταυτότητας του proxy είναι ο άλλος δρόμος: basic_auth με το Caddy, του οποίου ο κωδικός πρόσβασης κατακερματίζεται με το caddy hash-password, ή auth_basic και ένα αρχείο που δημιουργείται με το htpasswd με το Nginx. Ταιριάζει σε πελάτες που στέλνουν τα διαπιστευτήρια σε κάθε κλήση, όπως το curl -u· για μια αλυσίδα τεκμηρίωσης, ελέγξτε ότι το εργαλείο της μπορεί να τα μεταβιβάσει. Για ένα στιγμιότυπο που μένει δημόσιο, το Nginx μπορεί επίσης να περιορίσει τον αριθμό αιτημάτων ανά διεύθυνση IP με το module του limit_req, ρυθμισμένο στον αριθμό των διαγραμμάτων των σελίδων σας.
Το Kroki μπορεί να φιλοξενεί συνοδευτικά κοντέινερ τρίτων που καταχωρίζονται μέσω του API /services. Αυτή η ανακάλυψη είναι απενεργοποιημένη εξ ορισμού, και μένει πάντα κλειστή σε λειτουργία SECURE. Αν την ενεργοποιήσετε με KROKI_ENABLE_COMPANION_DISCOVERY=true, η τεκμηρίωση σας ζητά να κρατήσετε το /services σε ένα έμπιστο δίκτυο, και συνιστά ένθερμα το token KROKI_COMPANION_REGISTRATION_TOKEN: χωρίς αυτό, το Kroki προειδοποιεί κατά την εκκίνηση ότι κάθε πελάτης της πύλης μπορεί να καταχωρίσει ένα συνοδευτικό κοντέινερ.
Το Asciidoctor Kroki και το πρόσθετο MkDocs στοχεύουν εξ ορισμού το https://kroki.io. Το μόνο που χρειάζονται είναι το URL του διακομιστή σας, μαζί με το πρόθεμα https://.
Η επέκταση Asciidoctor Kroki διαβάζει το χαρακτηριστικό kroki-server-url, στην κεφαλίδα του εγγράφου, στη γραμμή εντολών ή στο playbook του Antora. Προσθέστε το kroki-fetch-diagram για να κατεβάζετε τις εικόνες κατά το build αντί η HTML να παραπέμπει στον διακομιστή σας· αυτή η επιλογή απαιτεί ασφαλή λειτουργία Asciidoctor server ή χαμηλότερη.
:kroki-server-url: https://diagrams.example.com
:kroki-fetch-diagram:
Το πρόσθετο mkdocs-kroki-plugin διαβάζει το server_url, που παίρνει εξ ορισμού την τιμή της μεταβλητής περιβάλλοντος KROKI_SERVER_URL. Με http_method: POST, οι εικόνες αποθηκεύονται δίπλα σε κάθε σελίδα του παραγόμενου ιστότοπου και κρατιούνται στην cache από το ένα build στο άλλο:
plugins:
- kroki:
server_url: https://diagrams.example.com
http_method: POST
Η σελίδα εργαλείων τρίτων της τεκμηρίωσης αναφέρει επίσης το GitLab, που δημιουργεί διαγράμματα Kroki σε Markdown, AsciiDoc, reST και Textile, τα Sphinx, Jekyll, Hugo, Remark, Python-Markdown, MediaWiki, επεκτάσεις για το Visual Studio Code και το IntelliJ, και το Kroki.jl για τη Julia. Οποιοσδήποτε πελάτης HTTP λειτουργεί επίσης, όπως σε αυτό το παράδειγμα της τεκμηρίωσης:
curl https://diagrams.example.com/erd/svg --data-binary '@project.erd'
Το Kroki είναι χωρίς κατάσταση (stateless): δεν κρατά τίποτα από το ένα αίτημα στο άλλο, και ακόμη και το μητρώο των συνοδευτικών κοντέινερ τρίτων χάνεται μετά από μια επανεκκίνηση. Οι πηγές των διαγραμμάτων σας ζουν στα αποθετήρια της τεκμηρίωσής σας, και οι εικόνες τους στους παραγόμενους ιστότοπούς σας. Στον διακομιστή Kroki, αυτό που αποθηκεύεται είναι οι ρυθμίσεις του:
| Στοιχείο | Τι περιέχει | Αντίγραφο ασφαλείας |
|---|---|---|
compose.yaml | Τις εικόνες, τις ετικέτες τους και τις μεταβλητές KROKI_* | Ναι |
Αρχείο .env, αν υπάρχει | Μεταβλητές που κρατιούνται εκτός του compose.yaml, όπως ένα token ή ένα πιστοποιητικό | Ναι, σε ασφαλές μέρος |
| Ρυθμίσεις του proxy | Το Caddyfile ή το μπλοκ Nginx, και το αρχείο κωδικών πρόσβασης | Ναι |
| Εικόνες Docker | Το ίδιο το λογισμικό | Όχι: το docker compose pull τις κατεβάζει ξανά |
tar -czf kroki-config-$(date +%F).tar.gz compose.yaml /etc/caddy/Caddyfile
Προσαρμόστε τη λίστα στον proxy σας, φτιάξτε ένα νέο αντίγραφο μετά από κάθε αλλαγή ρυθμίσεων, και στείλτε το εκτός του διακομιστή. Αποθηκευμένο στον δίσκο του, περιλαμβάνεται επίσης στα νυχτερινά του αντίγραφα ασφαλείας. Μια επαναφορά σημαίνει να βάλετε πίσω αυτά τα αρχεία και να εκτελέσετε docker compose up -d.
Με κλειδωμένες ετικέτες, αλλάξτε την έκδοση των τεσσάρων εικόνων στο compose.yaml και, στη συνέχεια, από τον φάκελό του:
docker compose pull
docker compose up -d
Το Kroki ακολουθεί τη σημασιολογική αρίθμηση εκδόσεων, και κάθε έκδοση δημοσιεύει τις αλλαγές της στο CHANGELOG.md και στη σελίδα της έκδοσης. Διαβάστε τες πριν από την ενημέρωση, ιδίως την ενότητά τους «Security»: η 0.35.0 της 5ης Νοεμβρίου 2026 και η 0.36.0 της 9ης Νοεμβρίου 2026 διορθώνουν εκτελέσεις κώδικα εξ αποστάσεως μέσω διαγραμμάτων Bytefield και TikZ, ευπάθειες XSS στα GoAT και DBML, και πλαστογράφηση αιτημάτων από την πλευρά του διακομιστή μέσω του BlockDiag και των συνοδευτικών κοντέινερ. Σε ένα ανοιχτό στιγμιότυπο, εγκαταστήστε αυτές τις εκδόσεις χωρίς καθυστέρηση.
Η έκδοση 0.36.0 προσθέτει επίσης την προεπιλεγμένη κεφαλίδα Content-Security-Policy και τη μηχανή διάταξης TALA για το D2. Για τη χειροκίνητη εγκατάσταση, τεκμηριώνει τη Java 21 ως ελάχιστη έκδοση.
Το self-hosting απαιτεί να φροντίζετε τον διακομιστή εκτός από την εφαρμογή. Σε ένα Managed VPS, οι ομάδες μας αναλαμβάνουν τον διακομιστή και παρακολουθούν προληπτικά το στιγμιότυπό σας· το Kroki μένει δικό σας λογισμικό, με τις ρυθμίσεις του και τα συνοδευτικά του κοντέινερ.
| Θέμα | Οι ομάδες μας | Εσείς |
|---|---|---|
| Ο διακομιστής | Ενημερώσεις του συστήματος και της ασφάλειας, μαζί με τις παρεμβάσεις στον διακομιστή | Η στιγμή που ταιριάζει στη δραστηριότητά σας |
| Η επιτήρηση | Διακομιστής υπό παρακολούθηση 24 ώρες την ημέρα, 7 ημέρες την εβδομάδα, με παρέμβαση χωρίς να περιμένουμε την κλήση σας | Η ανάγνωση των αρχείων καταγραφής του στιγμιοτύπου σας |
| Kroki | Προληπτική παρακολούθηση: εντοπισμός σφαλμάτων, καθυστερήσεων, μνήμης των συνοδευτικών κοντέινερ και χώρου στον δίσκο, με πρόταση διόρθωσης | Η εγκατάσταση, οι ενημερώσεις και οι ρυθμίσεις του, που εφαρμόζετε εσείς ή ο βοηθός AI σας |
| Τα διαγράμματα και η πρόσβαση | Ο διακομιστής που τα δημιουργεί, υπό επιτήρηση και με αντίγραφα ασφαλείας | Η λειτουργία ασφάλειας, τα συνοδευτικά κοντέινερ, τα όρια και οι κανόνες πρόσβασης του proxy |
| Τα αντίγραφα ασφαλείας | Κάθε νύχτα, κρυπτογραφημένα και φυλαγμένα εκτός του μηχανήματος· η επαναφορά περιλαμβάνεται | Τα αντίγραφα των ρυθμίσεών σας που κρατάτε αλλού, και το αίτημα επαναφοράς, όταν το χρειαστείτε |
| Η μετάπτωση | Μετάπτωση του τρέχοντος διακομιστή σας, δωρεάν | Η στιγμή της μετάβασης |
Αν προτιμάτε να παρεμβαίνουν οι ομάδες μας μέσα στην ίδια την εφαρμογή, η υπηρεσία αυτή χρεώνεται ανά ώρα ή κατ’ αποκοπή, με κοστολόγηση που σας ανακοινώνεται πριν από την παρέμβαση.
Με ένα Managed VPS της Simafri, οι ομάδες μας κρατούν ενημερωμένο τον διακομιστή του στιγμιοτύπου σας Kroki, τον παρακολουθούν μέρα και νύχτα και παρεμβαίνουν χωρίς να περιμένουν την κλήση σας· παρακολουθούν επίσης προληπτικά το στιγμιότυπό σας και σας προτείνουν τις χρήσιμες διορθώσεις, που εφαρμόζετε εσείς ή ο βοηθός AI σας. Τα αντίγραφα ασφαλείας κρυπτογραφούνται κάθε νύχτα και φυλάσσονται εκτός του μηχανήματος, η επαναφορά τους περιλαμβάνεται, και η μετάπτωση από τον τρέχοντα διακομιστή σας είναι δωρεάν.
Ναι. Το Kroki έχει άδεια MIT: μπορείτε να το χρησιμοποιείτε, να το τροποποιείτε και να το αναδιανέμετε σε μια επιχείρηση χωρίς να αγοράσετε άδεια, με την προϋπόθεση ότι διατηρείτε τη σημείωση πνευματικών δικαιωμάτων του. Μένει το κόστος του διακομιστή που το τρέχει.
Μόνο για τα διαγράμματα που δημιουργούν. Η εικόνα yuzutech/kroki αρκεί για τα PlantUML, GraphViz, D2, Structurizr και τις περισσότερες μορφές. Τα Mermaid, BPMN, Excalidraw και diagrams.net χρειάζονται το καθένα το συνοδευτικό του κοντέινερ, συνδεδεμένο μέσω των KROKI_MERMAID_HOST, KROKI_BPMN_HOST, KROKI_EXCALIDRAW_HOST ή KROKI_DIAGRAMSNET_HOST.
Δημιουργήστε ένα compose.yaml με την εικόνα yuzutech/kroki, τη θύρα της 8000 δημοσιευμένη στο 127.0.0.1, και τα συνοδευτικά κοντέινερ που χρειάζεστε, όπως το yuzutech/kroki-mermaid, συνδεδεμένα μέσω των μεταβλητών KROKI_*_HOST. Εκτελέστε docker compose up -d, ελέγξτε το /health και στη συνέχεια βάλτε έναν reverse proxy σε HTTPS μπροστά από τη θύρα 8000.
Όχι, το Kroki δεν έχει λογαριασμούς, σελίδα διαχείρισης ούτε βάση δεδομένων. Οι ρυθμίσεις του είναι ένα σύνολο μεταβλητών περιβάλλοντος KROKI_*, και η πρόσβαση στο API ελέγχεται στον reverse proxy, με βάση τη διεύθυνση IP ή με βασικό έλεγχο ταυτότητας.
Κρατήστε τη λειτουργία SECURE, ενεργή εξ ορισμού, που εμποδίζει τις βιβλιοθήκες να διαβάζουν αρχεία ή το δίκτυο. Αφήστε στη θέση τους τα όρια χρόνου και μεγέθους, ενημερώνετε μόλις μια έκδοση διορθώνει μια ευπάθεια και, αν μόνο η αλυσίδα δημοσίευσής σας καλεί το Kroki, δεχτείτε στον proxy μόνο τη διεύθυνσή της.
Με το Asciidoctor, δώστε στο χαρακτηριστικό kroki-server-url το URL του διακομιστή σας, και προσθέστε το kroki-fetch-diagram για να κατεβάζετε τις εικόνες κατά το build. Με το MkDocs, ορίστε το server_url στις ρυθμίσεις του πρόσθετου kroki, και το http_method: POST για να αποθηκεύετε τις εικόνες μαζί με τον ιστότοπο.
Μόνο τις ρυθμίσεις του: το compose.yaml, ένα ενδεχόμενο αρχείο .env και τις ρυθμίσεις του reverse proxy. Το Kroki δεν κρατά δεδομένα, και οι εικόνες Docker του κατεβαίνουν ξανά με docker compose pull.
Ένα Managed VPS καλύπτει τον διακομιστή: σύστημα, ασφάλεια, επιτήρηση και αντίγραφα ασφαλείας. Οι ομάδες μας παρακολουθούν επίσης προληπτικά το στιγμιότυπό σας και σας προτείνουν τις χρήσιμες διορθώσεις, που εφαρμόζετε εσείς. Οι παρεμβάσεις μέσα στην εφαρμογή χρεώνονται ανά ώρα ή κατ’ αποκοπή.
Simafri
Ας μιλήσουμε για την ιστοσελίδα σας
Πείτε μας με λίγα λόγια για το έργο σας: θα επικοινωνήσουμε σύντομα μαζί σας.
Ευχαριστούμε! Το αίτημά σας εστάλη. Θα επικοινωνήσουμε σύντομα μαζί σας.
Προτιμάτε email; Γράψτε μας στο support@simafri.com.