Add config section to docs

jamesread · Jan 30, 2025 · b1859b4 · b1859b4
1 parent fddadae
commit b1859b4
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -0,0 +1,9 @@
+# Configuration
+
+UAR is designed so that it very much works "out of the box" and with zero configuration. However, it's entirely possible that people might want to tweak things, so there are some configuration options provided.
+
+## Configuration options
+
+### `ALERTMANAGER_HOST` Environment Variable
+
+This is the browser URL to get to alertmanager. If you set this, alert links will be clickable. eg: `https://am.webapps.example.com`.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -59,3 +59,4 @@ extra:
 nav:
   - Welcome: index.md
   - User Guide: userguide.md
+  - Configuration: configuration.md