--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_http_host_status_check/README.markdown	Tue Jun 28 22:33:13 2016 +0100
@@ -0,0 +1,33 @@
+---
+labels: Stage-Beta
+description: HTTP Host Status Check
+...
+
+Introduction
+============
+
+This module exposes serves over HTTP the information collected by mod\_host\_status\_check and
+mod\_host\_status\_heartbeat in a convenient format for automated monitoring tools.
+
+Configuration
+=============
+
+mod\_http\_status\_check relies on Prosodys HTTP server and mod\_http for
+serving HTTP requests. See [Prosodys HTTP server
+documentation](https://prosody.im/doc/http) for information about how to
+configure ports, HTTP Host names etc.
+
+Simply add this module to modules\_enabled for the host you would like to serve it from.
+
+There is a single configuration option:
+
+``` {.lua}
+    -- The maximum number of seconds that a host can go without sending a heartbeat,
+    -- before we mark it as TIMEOUT (default: 5)
+    status_check_heartbeat_threshold = 5;
+```
+
+Compatibility
+=============
+
+Works with Prosody 0.9.x and later.