aboutsummaryrefslogtreecommitdiffstats
path: root/www/gatus/pkg/README
diff options
context:
space:
mode:
Diffstat (limited to 'www/gatus/pkg/README')
-rw-r--r--www/gatus/pkg/README9
1 files changed, 9 insertions, 0 deletions
diff --git a/www/gatus/pkg/README b/www/gatus/pkg/README
new file mode 100644
index 0000000..f8ce48c
--- /dev/null
+++ b/www/gatus/pkg/README
@@ -0,0 +1,9 @@
++-------------------------------------------------------------------------------
+| Running ${PKGSTEM} on OpenBSD
++-------------------------------------------------------------------------------
+
+By default gatus reads a config file from ${SYSCONFDIR}/gatus/gatus.yaml.
+This file is provided as an example, so one need to tweak it to their own needs.
+
+See https://github.com/TwiN/gatus#configuration for detailed description on how
+to structure a usable configuration file.