This guide is intended for end-users, system administrators, and technical writers who want to use Kroki-rs to generate diagrams from textual descriptions.
What is Covered?¶
In this section, you will find:
Features: A high-level overview of the architectural advantages and capabilities of Kroki-rs.
Usage: Examples of how to formulate requests via the CLI command or the HTTP web server API.
Supported Diagrams: A comprehensive list of the active diagram types and syntaxes supported by the tool.
Configuration: How to configure runtime options like custom font URL caching and process timeouts via
kroki.toml.Docker Deployment: Guidelines for running Kroki-rs in production containers, including health monitoring and metrics.
Releases & Installation: How to obtain the latest binaries, installers, and OCI images for your platform.
Security: Best practices for safely deploying Kroki-rs in a public internet environment.
Community & Support: How to report issues, suggest features, and get help from the community.
If you are looking to contribute to the codebase or extend Kroki-rs with new providers, please proceed to the- Developer Guide