Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
bdwyertech committed Oct 17, 2019
1 parent ffdf444 commit 7706ca1
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,15 @@
This project was inspired by CNTLM & PX. Operating behind a corporate proxy can make using tooling difficult. It can also force you into putting your credentials into ENV variables, definitely not good! The goal here is to leverage the Windows SSPI subsystem to authenticate to your proxy automatically.

## Usage
TODO: Write some usage instructions
When GoNTLM-Proxy first starts, it will create a self-signed certificate, unique to your system. It is created in your home folder at `~/.gontlm-ca.pem` and `~/.gontlm-ca.key` respectively. If you want to avoid validation errors, you can add the certificate to your systems trust store.

## Install
It reads the configured proxy from the Windows Registry, or can be set via the `GONTLM_PROXY` environment variable.

By default, GoNTLM-Proxy listens locally on port 53128, however this can be set via the `GONTLM_BIND` environment variable.


## Install
Release binaries are available under the GitHub Releases page. Alternatively, you can do this the Go way.
```console
$ go get github.com/bdwyertech/gontlm-proxy
```
Expand Down
2 changes: 1 addition & 1 deletion cert.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ func setGoProxyCA() error {
if err != nil {
switch err.(type) {
case x509.UnknownAuthorityError:
log.Println("WARN: GoNTLM-Proxy certificate is not trusted... You should add it to your trusted CA store!")
log.Println("WARN: GoNTLM-Proxy certificate is not trusted... If you want to avoid validation errors, you can add the certificate to your systems trust store.")
log.Printf("WARN: GoNTLM-Proxy CA Cert Location: %s", cert)
log.Printf("WARN: %s", err)
default:
Expand Down

0 comments on commit 7706ca1

Please sign in to comment.