Hosting Kroki na Managed VPS: Państwa diagramy renderowane na Państwa serwerze

Hosting Kroki na Managed VPS oznacza, że Państwa diagramy PlantUML, Mermaid, GraphViz, D2, BPMN czy Excalidraw są renderowane na maszynie, która należy do Państwa, a nasze zespoły dbają o jej aktualność i nadzorują ją dniem i nocą. Kroki to wolne oprogramowanie na licencji MIT. Ten poradnik podąża za jego oficjalną dokumentacją: brama i jej kontenery towarzyszące, instalacja przez Docker Compose, konfiguracja, HTTPS, ochrona instancji publicznej, podłączenie Asciidoctor i MkDocs, kopie zapasowe i aktualizacje.

Simon Vasconcelos Lee Autor: Opublikowano 20 listopada 2026Czas czytania: 14 minut

Wszystkie poradniki

W skrócie

  1. Licencja MIT pozwala swobodnie używać, modyfikować i rozpowszechniać Kroki, w pracy czy gdziekolwiek indziej, pod warunkiem zachowania informacji o prawach autorskich.
  2. Kroki zamienia diagram zapisany tekstem w obraz przez jedno API HTTP: PlantUML, GraphViz, D2, Structurizr i wiele innych są zawarte w obrazie yuzutech/kroki.
  3. Mermaid, BPMN, Excalidraw i diagrams.net potrzebują każdy własnego kontenera towarzyszącego, połączonego z bramą przez zmienne KROKI_*_HOST: Docker Compose uruchamia je razem.
  4. Kroki nie ma kont ani bazy danych. Startuje w trybie SECURE, który nie pozwala mu odczytywać plików ani sięgać do sieci; dostęp do instancji publicznej kontroluje się w odwrotnym proxy.
  5. Proszę wykonywać kopię konfiguracji, compose.yaml i konfiguracji proxy, a aktualizować poleceniem docker compose pull, po przeczytaniu informacji o każdym wydaniu.

Co robi Kroki

Kroki udostępnia ujednolicone API HTTP, które przyjmuje diagram opisany tekstem i zwraca obraz. Państwa dokumentacja, wiki czy platforma z repozytoriami kodu wysyła źródło diagramu; Kroki odpowiada plikiem SVG oraz, zależnie od typu diagramu, PNG, PDF lub JPEG. Jego README wymienia BlockDiag, BPMN, Bytefield, C4 z PlantUML, D2, DBML, diagrams.net, Ditaa, Erd, Excalidraw, GoAT, GraphViz, Lini, Mermaid, Nomnoml, Pikchr, PlantUML, Svgbob, Symbolator, UMLet, Vega, Vega-Lite, WaveDrom i WireViz.

Dokumentacja rozszerzenia Asciidoctor Kroki podaje trzy powody, by uruchomić własny serwer zamiast publicznej instancji kroki.io: firmowa zapora sieciowa, która ją blokuje, opóźnienie, gdy znajdują się Państwo daleko od tej europejskiej instancji, oraz poufność, gdy źródła diagramów muszą pozostać w Państwa infrastrukturze.

Na co pozwala licencja MIT

Kroki jest udostępniany na licencji MIT. Przyznaje ona bezpłatnie prawo do używania, kopiowania, modyfikowania, łączenia, publikowania, rozpowszechniania, sublicencjonowania i sprzedawania kopii oprogramowania. Mogą więc Państwo uruchomić go dla swojej firmy, zespołu lub klientów, bez zakupu licencji.

Jedynym warunkiem jest zachowanie informacji o prawach autorskich i tekstu licencji we wszystkich kopiach lub istotnych częściach oprogramowania. Tekst dostarcza oprogramowanie „w stanie, w jakim jest”, bez gwarancji. Biblioteki diagramów dołączone do Kroki zachowują każda własną licencję.

Brama i jej kontenery towarzyszące

Kroki ma architekturę modułową. Brama napisana w Javie, na Vert.x, przyjmuje każde żądanie i kieruje je do właściwej biblioteki. Obowiązkowy jest tylko obraz yuzutech/kroki: dokumentacja zaznacza, że zależnie od Państwa diagramów może on wystarczyć.

ObrazCo renderujeObowiązkowy
yuzutech/krokiBramę, a także ActDiag, BlockDiag, Bytefield, D2, Ditaa, Erd, GoAT, GraphViz, Lini, Nomnoml, NwDiag, PacketDiag, Pikchr, PlantUML i C4, RackDiag, SeqDiag, Structurizr, Svgbob, Symbolator, UMLet, Vega, Vega-Lite, WaveDrom i WireVizTak
yuzutech/kroki-mermaidMermaid: schematy blokowe, diagramy sekwencji i wykresy GanttaNie
yuzutech/kroki-bpmnBPMN, za pomocą bpmn-jsNie
yuzutech/kroki-excalidrawExcalidraw, styl odręcznyNie
yuzutech/kroki-diagramsnetdiagrams.net, wciąż eksperymentalnyNie

Dobór serwera

Dokumentacja nie podaje żadnej wartości dla pamięci ani procesora. Wskazuje natomiast, co obciąża najbardziej: kontenery towarzyszące Mermaid, BPMN, Excalidraw i diagrams.net renderują każdy diagram w przeglądarce Chromium działającej bez interfejsu (headless). Aby seria konwersji nie przekroczyła pamięci kontenera, każdy z nich ogranicza liczbę jednoczesnych renderowań: domyślnie 6 dla Mermaid, BPMN i diagrams.net, 4 dla Excalidraw. Kolejne żądania czekają na swoją kolej w kolejce.

Na Managed VPS wystarczy opisać nam swoje diagramy, potrzebne im kontenery towarzyszące i oczekiwany ruch, a polecimy odpowiedni rozmiar.

Instalacja przez Docker Compose

Dokumentacja zaleca kontenery, Docker lub Podman, aby nie trzeba było instalować każdej biblioteki ręcznie. Na serwerze z zainstalowanym Dockerem proszę utworzyć katalog i umieścić w nim ten compose.yaml, zaczerpnięty z dokumentacji:

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"
Terminal
docker compose up -d

Dla diagrams.net, wciąż eksperymentalnego, README dodaje czwarty kontener towarzyszący. Proszę dodać tę usługę oraz zmienną KROKI_DIAGRAMSNET_HOST=diagramsnet do sekcji environment usługi kroki:

compose.yaml, usługa do dodania
  diagramsnet:
    image: yuzutech/kroki-diagramsnet:0.36.0
    restart: unless-stopped
    expose:
      - "8005"

Sprawdzenie, czy wszystko odpowiada

Z poziomu serwera trasa /health zwraca stan bramy i wersje dołączonych do niej bibliotek. Kolejne dwa żądania renderują diagram GraphViz przez bramę, a następnie diagram Mermaid przez jego kontener towarzyszący:

Terminal, na serwerze
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'

Bez Dockera: samodzielny plik jar

Druga droga z dokumentacji to samodzielny serwer, publikowany na stronie wydań repozytorium jako kroki-standalone-server-v0.36.0.jar. Wymaga Javy 21 lub nowszej i nie zawiera żadnych bibliotek diagramów: każdą instaluje się osobno, a jej ścieżkę ustawia się zmienną, taką jak KROKI_DOT_BIN_PATH, gdy plik wykonywalny nie znajduje się w PATH. Dla adresu nasłuchiwania lepiej użyć KROKI_LISTEN, ponieważ dokumentacja konfiguracji zapowiada usunięcie KROKI_PORT:

Terminal
KROKI_LISTEN=127.0.0.1:8000 java -jar kroki-standalone-server-v0.36.0.jar

Konfiguracja: zmienne, bez kont i bez bazy danych

Kroki nie ma strony administracyjnej, kont użytkowników ani bazy danych: jego konfiguracja to zestaw zmiennych środowiskowych albo, w przypadku pliku jar, właściwości systemowych Javy. W Docker Compose umieszcza się je w bloku environment danej usługi, a następnie docker compose up -d odtwarza kontener. Ustawienia najważniejsze dla serwera:

ZmiennaWartość domyślnaDo czego służy
KROKI_SAFE_MODEsecurePoziom bezpieczeństwa, opisany niżej
KROKI_LISTENWszystkie interfejsy, port 8000Adres i port nasłuchiwania; przyjmuje też gniazdo UNIX, unix:// i ścieżkę
KROKI_MERMAID_HOST, KROKI_BPMN_HOST, KROKI_EXCALIDRAW_HOST127.0.0.1Adres, pod którym brama dociera do każdego kontenera towarzyszącego; odpowiadające im zmienne _PORT ustawiają port, a KROKI_DIAGRAMSNET_HOST obsługuje diagrams.net
KROKI_COMMAND_TIMEOUT5 sekundMaksymalny czas oczekiwania na plik wykonywalny diagramu, taki jak dot
KROKI_CONVERT_TIMEOUT20 sekundMaksymalny czas oczekiwania na bibliotekę Javy, taką jak PlantUML
KROKI_DELEGATE_TIMEOUT_MS30 000Maksymalny czas oczekiwania na kontener towarzyszący, w milisekundach
KROKI_MAX_URI_LENGTH4096Długość adresu URL akceptowana dla GET, powyżej której Kroki odpowiada kodem 414
KROKI_CONTENT_SECURITY_POLICYscript-src 'none'; object-src 'none'Nagłówek Content-Security-Policy wysyłany z każdą odpowiedzią
KROKI_CORS_ALLOWED_HEADERSBrak dodatkowychDodatkowe nagłówki dozwolone dla wywołań z innej witryny

Diagramy Excalidraw tworzą długie adresy URL. Jeśli podnoszą Państwo KROKI_MAX_URI_LENGTH, dokumentacja zaleca pozostanie przy 8192 znakach lub mniej, choć większość przeglądarek akceptuje więcej w znaczniku <img>. W przypadku największych diagramów żądanie POST przenosi źródło w treści, a nie w adresie URL.

Kroki nie potrzebuje do działania żadnego sekretu. Dwa opcjonalne ustawienia go zawierają: token KROKI_COMPANION_REGISTRATION_TOKEN, przydatny, jeśli włączą Państwo rejestrację zewnętrznych kontenerów towarzyszących, omówioną w części o ochronie, oraz klucz prywatny certyfikatu, jeśli powierzą Państwo obsługę HTTPS samemu Kroki. Proszę przechowywać je poza wszelkimi repozytoriami kodu.

HTTPS: odwrotne proxy

Brama udostępnia swoje API przez HTTP. Odwrotne proxy umieszczone przed nią nasłuchuje na portach 80 i 443, uzyskuje certyfikat Let’s Encrypt, szyfruje ruch i przekazuje go do Kroki na 127.0.0.1:8000. To również w nim filtruje się dostęp, jak pokazuje następna część.

Z Caddy

Caddy sam uzyskuje i odnawia certyfikat dla podanej nazwy, a jego dyrektywa reverse_proxy przekazuje nagłówki X-Forwarded-For, X-Forwarded-Proto i X-Forwarded-Host bez dodatkowych ustawień:

Caddyfile
diagrams.example.com {
	encode gzip
	reverse_proxy 127.0.0.1:8000
}

Z Nginx

Ten blok serwera nasłuchuje na porcie 80, aby Certbot mógł zainstalować HTTPS. Dwa limity Nginx spotykają się z limitami Kroki: treść żądania większa niż 1 MB jest domyślnie odrzucana z kodem 413, co client_max_body_size dostosowuje do dużych diagramów wysyłanych przez POST; wiersz żądania dłuższy niż 8 KB otrzymuje kod 414, co large_client_header_buffers dostosowuje, jeśli podniosą Państwo KROKI_MAX_URI_LENGTH powyżej tej wartości.

Blok Nginx
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;
    }
}
Terminal
sudo nginx -t
sudo certbot --nginx

HTTPS bez proxy

Dokumentacja opisuje też szyfrowanie przez sam Kroki: KROKI_SSL=true, z certyfikatem i kluczem prywatnym w formacie PEM, jako tekst przez KROKI_SSL_CERT i KROKI_SSL_KEY albo jako pliki przez KROKI_SSL_CERT_PATH i KROKI_SSL_KEY_PATH. Odnawianie certyfikatu odbywa się wtedy ręcznie, podczas gdy przy proxy zajmują się nim samodzielnie Caddy lub Certbot.

Ochrona instancji otwartej na internet

Kroki nie ma uwierzytelniania: każdy, kto dotrze do API, może zlecić mu renderowanie diagramów. Jego ochrona opiera się więc na trzech elementach, opisanych w dokumentacji i informacjach o wydaniach: trybie bezpieczeństwa, limitach rozmiaru i czasu oraz tym, co przepuszcza proxy. Proszę zacząć od ustalenia, kto musi mieć dostęp do Państwa serwera.

Kto wywołuje Państwa serwer?

Tryb bezpieczeństwa

KROKI_SAFE_MODE ustala trzy poziomy, z których każdy obejmuje ograniczenia poprzedniego. Dokumentacja wyjaśnia, że niektóre biblioteki potrafią odczytywać pliki lub adresy URL, jak dyrektywy !include PlantUML, i że Kroki, który nie weryfikuje ich kodu, domyślnie blokuje taki dostęp. Zachęca każdego, kto prowadzi serwer, do wyboru poziomu odpowiedniego do swojego zastosowania.

PoziomCo robi
SECURE, domyślnyUniemożliwia wszelkie próby odczytu plików z systemu plików lub zasobów z sieci
SAFEOpiera się na oczyszczaniu żądań przez własny tryb bezpieczny każdej biblioteki
UNSAFEWyłącza wszystkie funkcje bezpieczeństwa

Na instancji publicznej proszę zachować SECURE. Nagłówek Content-Security-Policy, wysyłany domyślnie od wersji 0.36.0, uzupełnia tę obronę: skrypt przemycony do pliku SVG nie wykonuje się pod adresem Kroki, nawet gdy obraz zostanie otwarty bezpośrednio.

Limity rozmiaru i czasu

Limity czasu z tabeli konfiguracji ograniczają każdą konwersję. Kontenery towarzyszące dodają własne, pomyślane jako ochrona przed wyczerpaniem zasobów:

Ograniczanie dostępu w proxy

Gdy Kroki wywołuje wyłącznie Państwa potok publikacji, najprostszą opcją jest dopuszczenie tylko jego adresu IP. W Caddy matcher remote_ip wyodrębnia pozostałe adresy, a respond odsyła im kod 403:

Caddyfile
diagrams.example.com {
	@external not remote_ip 203.0.113.10
	respond @external 403
	reverse_proxy 127.0.0.1:8000
}

W Nginx dyrektywy allow i deny bloku location wykonują to samo zadanie, przy czym obowiązuje pierwsza pasująca reguła:

Blok Nginx, wewnątrz location /
allow 203.0.113.10;
deny all;

Drugą drogą jest uwierzytelnianie podstawowe w proxy: basic_auth w Caddy, którego hasło haszuje się poleceniem caddy hash-password, albo auth_basic i plik utworzony przez htpasswd w Nginx. Sprawdza się ono przy klientach, które wysyłają dane logowania z każdym wywołaniem, jak curl -u; w przypadku potoku dokumentacji proszę sprawdzić, czy jego narzędzie potrafi je przekazywać. Dla instancji, która pozostaje publiczna, Nginx może też ograniczyć liczbę żądań na adres IP modułem limit_req, dostosowanym do liczby diagramów na Państwa stronach.

Zewnętrzne kontenery towarzyszące

Kroki może obsługiwać zewnętrzne kontenery towarzyszące, które rejestrują się przez API /services. To wykrywanie jest domyślnie wyłączone i zawsze pozostaje wyłączone w trybie SECURE. Jeśli włączą je Państwo przez KROKI_ENABLE_COMPANION_DISCOVERY=true, dokumentacja prosi o utrzymywanie /services w zaufanej sieci i stanowczo zaleca token KROKI_COMPANION_REGISTRATION_TOKEN: bez niego Kroki ostrzega przy starcie, że każdy klient bramy może zarejestrować kontener towarzyszący.

Podłączenie Asciidoctor, MkDocs i innych narzędzi

Asciidoctor Kroki i wtyczka MkDocs domyślnie kierują się na https://kroki.io. Wystarczy im adres URL Państwa serwera, z prefiksem https://.

Asciidoctor i Antora

Rozszerzenie Asciidoctor Kroki odczytuje atrybut kroki-server-url, w nagłówku dokumentu, w wierszu poleceń lub w playbooku Antora. Proszę dodać kroki-fetch-diagram, aby pobierać obrazy w czasie budowania, zamiast kierować HTML na Państwa serwer; ta opcja wymaga trybu bezpieczeństwa Asciidoctor server lub niższego.

Nagłówek dokumentu AsciiDoc
:kroki-server-url: https://diagrams.example.com
:kroki-fetch-diagram:

MkDocs

Wtyczka mkdocs-kroki-plugin odczytuje server_url, którego wartością domyślną jest zmienna środowiskowa KROKI_SERVER_URL. Z http_method: POST obrazy są zapisywane obok każdej strony w zbudowanej witrynie i buforowane między dwoma budowaniami:

mkdocs.yml
plugins:
  - kroki:
      server_url: https://diagrams.example.com
      http_method: POST

Inne integracje

Strona dokumentacji o narzędziach zewnętrznych wymienia też GitLab, który renderuje diagramy Kroki w Markdown, AsciiDoc, reST i Textile, a także Sphinx, Jekyll, Hugo, Remark, Python-Markdown, MediaWiki, rozszerzenia do Visual Studio Code i IntelliJ oraz Kroki.jl dla Julii. Działa też każdy klient HTTP, jak w tym przykładzie z dokumentacji:

Terminal
curl https://diagrams.example.com/erd/svg --data-binary '@project.erd'

Kopie zapasowe: konfiguracja, bez danych

Kroki jest bezstanowy: niczego nie przechowuje między dwoma żądaniami, a nawet rejestr zewnętrznych kontenerów towarzyszących znika po ponownym uruchomieniu. Źródła Państwa diagramów znajdują się w repozytoriach dokumentacji, a ich obrazy w zbudowanych witrynach. Na serwerze Kroki kopię zapasową wykonuje się z jego konfiguracji:

ElementCo zawieraKopia zapasowa
compose.yamlObrazy, ich tagi i zmienne KROKI_*Tak
Plik .env, jeśli istniejeZmienne trzymane poza compose.yaml, takie jak token czy certyfikatTak, w bezpiecznym miejscu
Konfiguracja proxyCaddyfile lub blok Nginx oraz plik z hasłamiTak
Obrazy DockerSamo oprogramowanieNie: docker compose pull pobiera je ponownie
Terminal, w katalogu z compose.yaml
tar -czf kroki-config-$(date +%F).tar.gz compose.yaml /etc/caddy/Caddyfile

Proszę dostosować listę do swojego proxy, wykonywać nową kopię po każdej zmianie konfiguracji i wysyłać ją poza serwer. Umieszczona na jego dysku, trafia także do jego nocnych kopii zapasowych. Przywrócenie polega na odłożeniu tych plików na miejsce i uruchomieniu docker compose up -d.

Aktualizacje

Przy przypiętych tagach proszę zmienić wersję czterech obrazów w compose.yaml, a następnie, z jego katalogu:

Terminal
docker compose pull
docker compose up -d

Kroki stosuje wersjonowanie semantyczne, a każda wersja publikuje swoje zmiany w CHANGELOG.md i na swojej stronie wydania. Proszę je przeczytać przed aktualizacją, zwłaszcza część „Security”: wersje 0.35.0 z 5 listopada 2026 roku i 0.36.0 z 9 listopada 2026 roku naprawiają zdalne wykonanie kodu przez diagramy Bytefield i TikZ, luki XSS w GoAT i DBML oraz fałszowanie żądań po stronie serwera przez BlockDiag i kontenery towarzyszące. Na otwartej instancji proszę wdrożyć te wersje bez zwłoki.

Wersja 0.36.0 dodaje też domyślny nagłówek Content-Security-Policy i silnik układu TALA dla D2. Dla instalacji ręcznej dokumentuje Javę 21 jako wersję minimalną.

Kto za co odpowiada na Managed VPS

Samodzielny hosting wymaga prowadzenia serwera, oprócz samej aplikacji. Na Managed VPS nasze zespoły przejmują serwer i proaktywnie czuwają nad Państwa instancją; Kroki pozostaje Państwa oprogramowaniem, z jego konfiguracją i kontenerami towarzyszącymi.

TematNasze zespołyPaństwo
SerwerAktualizacje systemu i zabezpieczeń, w tym interwencje na serwerzeMoment dogodny dla Państwa działalności
NadzórSerwer pod opieką całą dobę, 7 dni w tygodniu, z interwencją bez czekania na Państwa telefonCzytanie dzienników Państwa instancji
KrokiProaktywna opieka: wychwytujemy błędy, spowolnienia, zużycie pamięci przez kontenery towarzyszące i brak miejsca na dysku oraz polecamy poprawkęInstalacja, aktualizacje i ustawienia, które wdrażają Państwo sami albo Państwa asystent AI
Diagramy i dostępSerwer, który je renderuje, nadzorowany i objęty kopiami zapasowymiTryb bezpieczeństwa, kontenery towarzyszące, limity i reguły dostępu w proxy
Kopie zapasoweCo noc, szyfrowane i przechowywane poza maszyną; przywracanie w cenieKopie Państwa konfiguracji przechowywane w innym miejscu oraz zgłoszenie prośby o przywrócenie, gdy będzie potrzebne
MigracjaMigracja Państwa obecnego serwera, bezpłatnaMoment przełączenia

Jeśli wolą Państwo, aby nasze zespoły interweniowały w samej aplikacji, usługa ta jest rozliczana godzinowo lub ryczałtowo, z wyceną przekazaną przed interwencją.

Kroki na serwerze prowadzonym za Państwa

Z Managed VPS od Simafri nasze zespoły utrzymują serwer Państwa instancji Kroki w aktualności, nadzorują go dniem i nocą i interweniują bez czekania na Państwa telefon; proaktywnie czuwają także nad Państwa instancją i polecają przydatne poprawki, które wdrażają Państwo sami albo Państwa asystent AI. Kopie zapasowe są szyfrowane co noc i przechowywane poza maszyną, ich przywracanie jest w cenie, a migracja obecnego serwera jest bezpłatna.

Poznaj Managed VPS

Częste pytania

Czy Kroki jest bezpłatny dla firmy?

Tak. Kroki jest udostępniany na licencji MIT: mogą Państwo używać go, modyfikować i rozpowszechniać w firmie bez zakupu licencji, pod warunkiem zachowania informacji o prawach autorskich. Pozostaje koszt serwera, na którym działa.

Czy kontenery towarzyszące Kroki są potrzebne?

Tylko dla diagramów, które renderują. Obraz yuzutech/kroki wystarcza dla PlantUML, GraphViz, D2, Structurizr i większości formatów. Mermaid, BPMN, Excalidraw i diagrams.net potrzebują każdy własnego kontenera towarzyszącego, podłączonego przez KROKI_MERMAID_HOST, KROKI_BPMN_HOST, KROKI_EXCALIDRAW_HOST lub KROKI_DIAGRAMSNET_HOST.

Jak zainstalować Kroki przez Docker Compose?

Proszę utworzyć compose.yaml z obrazem yuzutech/kroki, jego portem 8000 opublikowanym na 127.0.0.1 oraz potrzebnymi kontenerami towarzyszącymi, takimi jak yuzutech/kroki-mermaid, podłączonymi przez zmienne KROKI_*_HOST. Proszę uruchomić docker compose up -d, sprawdzić /health, a następnie postawić przed portem 8000 odwrotne proxy z HTTPS.

Czy Kroki ma konto administratora?

Nie, Kroki nie ma kont, strony administracyjnej ani bazy danych. Jego konfiguracja to zestaw zmiennych środowiskowych KROKI_*, a dostęp do API kontroluje się w odwrotnym proxy, według adresu IP lub uwierzytelnianiem podstawowym.

Jak chronić publiczną instancję Kroki?

Proszę zachować tryb SECURE, domyślnie włączony, który nie pozwala bibliotekom odczytywać plików ani sięgać do sieci. Proszę pozostawić limity czasu i rozmiaru, aktualizować, gdy tylko nowa wersja naprawia lukę, a jeśli Kroki wywołuje wyłącznie Państwa potok publikacji, dopuszczać w proxy tylko jego adres.

Jak używać własnego serwera Kroki z Asciidoctor lub MkDocs?

W Asciidoctor proszę ustawić atrybut kroki-server-url na adres URL swojego serwera, a kroki-fetch-diagram, aby pobierać obrazy w czasie budowania. W MkDocs proszę ustawić server_url w konfiguracji wtyczki kroki, a http_method: POST, aby zapisywać obrazy razem z witryną.

Z czego wykonać kopię zapasową na serwerze Kroki?

Tylko z jego konfiguracji: compose.yaml, ewentualnego pliku .env i konfiguracji odwrotnego proxy. Kroki nie przechowuje żadnych danych, a jego obrazy Docker pobiera się ponownie poleceniem docker compose pull.

Czy Managed VPS obejmuje Kroki?

Managed VPS obejmuje serwer: system, bezpieczeństwo, nadzór i kopie zapasowe. Nasze zespoły proaktywnie czuwają też nad Państwa instancją i polecają przydatne poprawki, które wdrażają Państwo sami. Interwencja w aplikacji jest rozliczana godzinowo lub ryczałtowo.

Źródła i oficjalna dokumentacja

Skontaktuj się z nami