update readme

add description about pac files
This commit is contained in:
Barna Csorogi 2016-03-29 13:21:37 +02:00
parent 9a7aaedc56
commit 635da9b1a6
1 changed files with 15 additions and 2 deletions

View File

@ -28,6 +28,19 @@ To use the proxy over HTTPS, you will need a certificate for your host. If you d
`openssl req -x509 -newkey rsa:2048 -nodes -keyout cert.key -out cert.crt -days 3650 -subj '/CN=<your-domain>'`
then visit the proxy url and confirm that you trust your own certificate
To connect to the proxy over tls, you will need to supply a PAC (proxy auto-config) file to the browser, as most of them do not expose this option to the UI directly. Example:
function FindProxyForURL(url, host) {
if (url.substring(0, 5) == 'http:' || url.substring(0, 6) == 'https:') {
return "HTTPS <your-domain>:9999";
return "DIRECT";
This tells the browser to fetch http/https urls via the https proxy and for all other schemas (eg. websocket) connect directly.
Set the path to this file in the browser UI and you're good to go.
### MitM
To enable man-in-the-middle support, you will need to generate a root cert to sign all the certs generated by the proxy on the fly:
`openssl req -x509 -newkey rsa:2048 -nodes -keyout ca.key -out ca.crt -days 3650 -subj '/CN=<your-domain>'`
@ -50,7 +63,7 @@ Probably the best option is to run it with both tls and mitm support, combining
`compy -cert cert.crt -key cert.key -ca ca.crt -cakey ca.key`
You can also specify the listen port (defaults to 9999):
`compy -host :9999``
`compy -host :9999`
For compression, transcoding and minification options, see `compy --help`
@ -58,7 +71,7 @@ For compression, transcoding and minification options, see `compy --help`