path: root/README
diff options
Diffstat (limited to 'README')
1 files changed, 21 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..57d9ac6
--- /dev/null
+++ b/README
@@ -0,0 +1,21 @@
+This is a very basic HTTP server, designed for real-time server sent
+event streams. BEWARE: the server offers little to no security
+The server supports:
+- the standard HTTP "GET" method for retrieval of events.
+- a custom "UPDATE" method to send events.
+- HTTP 1.0 and 1.1 connections. HTTP 1.1 uses chunked mode.
+The server is hard-coded to listen on TCP *:1180.
+The design concept is:
+public ------ apache reverse ----- event ------ data gathering
+internet proxy httpd server application
+The reverse proxy is responsible for controlling public access to the
+event streams served by the mini-httpd event server; the event server
+itself should not be publically accessible.