From 8a9d007a6ffc7ff8576809369967940465a4a193 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bernhard=20Rosenkr=C3=A4nzer?= <bero@federated.computer>
Date: Mon, 17 Feb 2025 21:09:11 +0100
Subject: [PATCH] [check] documentation

---
 bin/check | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/bin/check b/bin/check
index 646491f..da298f6 100755
--- a/bin/check
+++ b/bin/check
@@ -1,4 +1,20 @@
 #!/bin/bash
+#
+# Check if a service is running/working properly
+#
+# The script checks that the internal IP is reachable, the service
+# replies on expected ports, and any public ports are reachable on
+# the external IP.
+#
+# Further checks can be added by adding a
+# /federated/services/$SERVICE/check file
+#
+
+if [ "$#" != 1 ]; then
+	echo "Usage: $0 <service>"
+	exit 1
+fi
+
 SERVICE="$1"
 
 . /federated/lib/functions.sh