From 146cc6a0216009d266457d1ba5a980b2861d67d7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=8A=A0=E9=87=8C?= Date: Sat, 9 Aug 2014 11:41:02 +0800 Subject: [PATCH] update README --- README.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ce058cd..210ee9d 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,28 @@ http-proxy ========== -A nodejs proxy which supports HTTPS request with auto-signing, just like fiddler or charles +A nodejs proxy like charles/fiddler, which generates child certificates for all domains automatically. Any https requests can easily go through this proxy. + +## how to use +### step 0 - setup env +* install NodeJS +* install [openssl](http://www.openssl.org/) , i.e. the command ``openssl`` should be exposed to your shell + +### step 1 - clone codes +* Clone repo with ``git clone https://github.com/ottomao/http-proxy`` +* change working directory to http-proxy ``cd http-proxy`` + +### step 2 - generate a rootCA and trust it +* ``cd cert`` +* run ``./gen-rootCA`` ,filling the necessary info according to the tip +* trust this rootCA. In OSX, just double-click rootCA.crt and add to system keychain +* ``cd ..`` + +### start server +* ``node index.js`` -##Contact + +## Contact Otto Mao ottomao@gmail.com