From ee5917391bb162dadc23b56d63c010cfa8d3f5b1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=8A=A0=E9=87=8C?= Date: Mon, 22 Sep 2014 14:17:18 +0800 Subject: [PATCH] update doc --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 63f653f..0f5221d 100644 --- a/README.md +++ b/README.md @@ -184,6 +184,7 @@ module.exports = { Using https features ---------------- + #### step 1 - install openssl * openssl is availabe here : [http://wiki.openssl.org/index.php/Compilation_and_Installation](http://wiki.openssl.org/index.php/Compilation_and_Installation) * using ``openssl version -a `` to make sure it is accessible via you command line. @@ -194,12 +195,14 @@ Using https features * **[important!]you will see some tip like *rootCA generated at : ~/.anyproxy_certs...* . ``cd`` to that directory, add/trust the rootCA.crt file to your system keychain. In OSX, you may do that by open the *crt file directly** * when debug https requests, you have to trust this rootCA on all of your clients. -#### done! -* start your anyproxy, it will intercept all the https requests for you +#### to intercept(decrypt) https requests +* start your anyproxy as normal. When rootCA is generated, it will intercept all the https requests for you automatically. +* if you get a warning like 'unsafe connection', please check if the root CA is trusted correctly. #### to start an https proxy * ``anyproxy --type https --host my.domain.com`` * the param ``host`` is required with https proxy and it should be kept exactly what it it when you config your browser. Otherwise, you may get some warning about security. +* using **https proxy** means your request towards proxy will be encrypted. Please notice that this feature has nothing to do with **intercept https requests**. #### others * root certs and temperary certs are stored at ``path.join(util.getUserHome(),"/.anyproxy_certs/")``