From 7706ca1e4ea09c50782d9260c8080c8286d136b1 Mon Sep 17 00:00:00 2001 From: Brian Dwyer Date: Thu, 17 Oct 2019 14:28:51 -0400 Subject: [PATCH] Update README --- README.md | 9 +++++++-- cert.go | 2 +- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b06b0ac..86a516c 100644 --- a/README.md +++ b/README.md @@ -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 ``` diff --git a/cert.go b/cert.go index d9dc5cf..f978768 100644 --- a/cert.go +++ b/cert.go @@ -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: