XiaoMo/anyproxy
1
0
Fork 0
mirror of https://github.com/alibaba/anyproxy.git synced 2025-04-23 15:51:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

update doc

Browse Source
This commit is contained in:
加里 2014-09-22 14:17:18 +08:00
parent e2ee6c996a
commit ee5917391b
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -184,6 +184,7 @@ module.exports = {
Using https features Using https features
---------------- ----------------
#### step 1 - install openssl #### 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) * 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. * 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** * **[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. * when debug https requests, you have to trust this rootCA on all of your clients.
#### done! #### to intercept(decrypt) https requests
* start your anyproxy, it will intercept all the https requests for you * 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 #### to start an https proxy
* ``anyproxy --type https --host my.domain.com`` * ``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. * 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 #### others
* root certs and temperary certs are stored at ``path.join(util.getUserHome(),"/.anyproxy_certs/")`` * root certs and temperary certs are stored at ``path.join(util.getUserHome(),"/.anyproxy_certs/")``