diff --git a/readme.txt b/readme.md similarity index 76% rename from readme.txt rename to readme.md index 30a96e5..ededd3a 100644 --- a/readme.txt +++ b/readme.md @@ -1,21 +1,29 @@ +# Node Proxy + Nodejs-proxy is a simple HTTP reverse proxy server written in node.js. It currently allows some mid-complexity to handle the reverse proxy magic take place. -Nodejs-proxy was written by Peteris Krumins (peter@catonmat.net). -His blog is at http://www.catonmat.net -- good coders code, great reuse. +Nodejs-proxy was written by **Peteris Krumins** (peter@catonmat.net). +His blog is at http://www.catonmat.net -- good coders code, great reuse. + +--- ------------------------------------------------------------------------------- +## Overview You'll need node.js to run it. Get it at www.nodejs.org, then compile and install it: +``` $ ./configure $ make $ make install +``` Next, run proxy.js through node program: +``` $ node proxy.js +``` And that's it! @@ -23,7 +31,9 @@ I have also added ip-based access control. As long as no ip is explicitly denied all will be allowed. If you need a specic access list just echo it to 'allow_ip_list' file: +``` $ echo '1.2.3.4' >> config/allow_ip_list +``` And you don't need to restart the server, it will see the changes and update itself. @@ -31,17 +41,16 @@ itself. You can also block hosts based on a regex pattern, to do that, echo the hosts you don't wish the proxy to serve to 'black_list' file: +``` $ echo 'facebook.com' >> config/black_list - +``` More features coming later! - ------------------------------------------------------------------------------- +--- Happy proxying! Sincerely, Peteris Krumins http://www.catonmat.net -