Initial commit

README.md

@@ -0,0 +1,21 @@
+# check_mirotalksfu.py - Nagios plugin for MirotalkSFU server
+
+This Nagios plugin will query a MirotalkSFU server and report on its status.
+The "MIROTALKSFU OK" message will include the roundtrip response time, the
+number of rooms open, and the number of users connected.
+
+## Usage
+
+The following parameters are supported by the plugin:
+- `-H HOST` or `--hostname HOST`: specify the `HOST` or IP address of the
+  server to query
+- `-p PORT` or `--port PORT`: specify the connection `PORT` of the server
+- `-t SECONDS` or `--timeout SECONDS`: specify the timeout of the request in
+  `SECONDS` seconds
+- `-S` or `--https`: connect using HTTPS
+- `-A` or `--apikey`: API key for HTTP endpoints
+
+Note that if running on LibreNMS in the official Docker container, then you must
+first install the `requests` module by running `apk add py3-requests` inside the
+container. The full command, assuming your container is named `librenms`, is
+`docker exec -it librenms apk add py3-requests`.