From 912b2d992532447c3337a6ab95a92ba8069345ba Mon Sep 17 00:00:00 2001 From: Eric Peterson Date: Fri, 28 Jan 2022 10:37:40 +0100 Subject: [PATCH] Note default ServerURL config in kroki how-to Signed-off-by: Eric Peterson --- docs/features/techdocs/how-to-guides.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/features/techdocs/how-to-guides.md b/docs/features/techdocs/how-to-guides.md index 1885c1a961..863b4b3ecb 100644 --- a/docs/features/techdocs/how-to-guides.md +++ b/docs/features/techdocs/how-to-guides.md @@ -496,6 +496,13 @@ plugins: - kroki ``` +> Note: you will very likely want to set a `kroki` `ServerURL` configuration in your +> `mkdocs.yml` as well. The default value is the publicly hosted `kroki.io`. If +> you have sensitive information in your organization's diagrams, you should set +> up a [server of your own](https://docs.kroki.io/kroki/setup/install/) and use it +> instead. Check out [mkdocs-kroki-plugin config](https://github.com/AVATEAM-IT-SYSTEMHAUS/mkdocs-kroki-plugin#config) +> for more plugin configuration details. + 4. **Add mermaid code into techdocs:** ````md