From 2b80b8076920495c3c8abc7eb2647dd696ab2cc1 Mon Sep 17 00:00:00 2001
From: pizzapim <pim@kunis.nl>
Date: Mon, 9 Jun 2025 05:59:37 +0200
Subject: [PATCH] docs: Add NixOS example (#1131)

* Add NixOS example

* Fix link
---
 .examples/nixos/README.md |  4 ++++
 .examples/nixos/gatus.nix | 23 +++++++++++++++++++++++
 2 files changed, 27 insertions(+)
 create mode 100644 .examples/nixos/README.md
 create mode 100644 .examples/nixos/gatus.nix

diff --git a/.examples/nixos/README.md b/.examples/nixos/README.md
new file mode 100644
index 00000000..f46f1916
--- /dev/null
+++ b/.examples/nixos/README.md
@@ -0,0 +1,4 @@
+# NixOS
+
+Gatus is implemented as a NixOS module. See [gatus.nix](./gatus.nix) for example
+usage.
diff --git a/.examples/nixos/gatus.nix b/.examples/nixos/gatus.nix
new file mode 100644
index 00000000..dbc20812
--- /dev/null
+++ b/.examples/nixos/gatus.nix
@@ -0,0 +1,23 @@
+{
+  services.gatus = {
+    enable = true;
+
+    settings = {
+      web.port = 8080;
+
+      endpoints = [
+        {
+          name = "website";
+          url = "https://twin.sh/health";
+          interval = "5m";
+
+          conditions = [
+            "[STATUS] == 200"
+            "[BODY].status == UP"
+            "[RESPONSE_TIME] < 300"
+          ];
+        }
+      ];
+    };
+  };
+}