1 files changed, 34 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..53bbdef
--- /dev/null
+++ b/README
@@ -0,0 +1,34 @@
+ereproxy - Erlang REverse http Proxy
+====================================
+
+1. Features
+
+   - simple
+   - listen on multiple ports
+   - frontend speaks HTTP and HTTPS (backend always uses HTTP)
+   - hot update of code & config possible
+   - (obscure) custom log format
+
+
+2. Usage
+
+   1. edit ereproxy_config.erl
+   2. [optional] obtain an SSL key/cert if HTTPS support is intended
+      1. $ openssl genrsa -out key.pem 1024
+      2. $ openssl req -new -key key.pem -out cert.csr
+      3. $ openssl x509 -req -days 666 -in cert.csr -signkey key.pem -out cert.pem
+   3. $ make
+   4. $ erl -s ereproxy
+
+
+3. Redirection strategy
+
+   Ereproxy parses the _first_ HTTP header of every connection until a
+   Host line or the end of the header is found. The connection is
+   routed according to this host. No further headers or even
+   conformance to the HTTP protocoll is checked.
+
+
+4. author/contact
+
+   Jan Huwald <jh@sotun.de>