localhost_frssoft/compy
1
0
Fork 0
mirror of https://git.phreedom.club/localhost_frssoft/compy.git synced 2024-11-23 08:31:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Expand installation instructions with dependencies

Browse source 
References #26.
This commit is contained in:
Andrew Gaul 2017-09-30 10:54:22 -07:00
parent d4d2fb19df
commit 22a5e80aae
1 changed files with 12 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -5,8 +5,8 @@ Compy is an HTTP/HTTPS forward proxy with content compression/transcoding capabi
One use case is to reduce bandwidth usage when browsing on limited mobile broadband connection.
Features:
---------
Features
--------
- HTTPS proxy (encrypted connection between client and proxy)
- man in the middle support (compress HTTPS traffic)
@ -21,9 +21,17 @@ Features:
Installation
------------
compy needs a few libraries to compile.
On Ubuntu, run `apt-get install -y libjpeg8 openssl ssl-cert`.
On macOS, run `brew install jpeg`. Then compile via:
```ShellSession
$ go get github.com/barnacs/compy
$ cd go/src/github.com/barnacs/compy/
$ go install
```
go get github.com/barnacs/compy
```
go will generate the binary at `go/bin/compy`.
### HTTPS
To use the proxy over HTTPS, you will need a certificate for your host. If you don't already have one, you can get one for [free](https://letsencrypt.org/) or you can generate a self-signed cert by running: