Skip to content

Commit

Permalink
Update README to include new install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
suyashkumar authored Mar 13, 2019
1 parent 3a79b4a commit 0419c3f
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,23 @@ ssl-proxy -cert cert.pem -key myKey.pem -from 0.0.0.0:4430 -to 127.0.0.1:8000
```
You can provide your own existing certs, of course. Jenkins still has issues serving the fullchain certs from letsencrypt properly, so this tool has come in handy for me there.

### Redirect HTTP -> HTTPS
Simply include the `-redirectHTTP` flag when running the program.

## Installation
Simply download and uncompress the proper prebuilt binary for your system from the [releases tab](https://github.com/suyashkumar/ssl-proxy/releases/). Then, add the binary to your path or start using it locally (`./ssl-proxy`).

If you're using `wget`, you can fetch and uncompress the proper binary in one command:
If you're using `wget`, you can fetch and uncompress the right binary for your OS using [`bin.suyash.io`](https://github.com/suyashkumar/bin) as follows:
```sh
wget -qO- "https://bin.suyash.io/suyashkumar/ssl-proxy" | tar xvz
```
or with `curl` (note you need to provide your os if using curl as one of `(darwin, windows, linux)` below):
```sh
wget -qO- $BINARY_RELEASE_LINK | tar xvz
curl -LJ "https://bin.suyash.io/suyashkumar/ssl-proxy?os=linux" | tar xvz
```

Shameless plug: [`suyashkumar/bin (bin.suyash.io)`](https://github.com/suyashkumar/bin) is a general tool that can fetch the latest binaries from GitHub releases for your OS. Check it out :).

### Build from source
#### Build from source using Docker
You can build `ssl-proxy` for all platforms quickly using the included Docker configurations.
Expand Down

0 comments on commit 0419c3f

Please sign in to comment.