Update docs for 1.7.0 (#211)

gogatekeeper · Sep 12, 2022 · b4db9ed · b4db9ed
1 parent 5c13a19
commit b4db9ed
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ Please remember to provide a good summary, description as well as steps to repro
 
 To run Gatekeeper, please refer to our [building and working with the code base](docs/building.md) guide. Alternatively, you can use the Docker image by running:
 
-    docker run -it --rm quay.io/gogatekeeper/gatekeeper:1.6.1 \
+    docker run -it --rm quay.io/gogatekeeper/gatekeeper:1.7.0 \
       --listen 127.0.0.1:8080 \
       --upstream-url http://127.0.0.1:80 \
       --discovery-url https://keycloak.example.com/auth/realms/<REALM_NAME> \
@@ -35,16 +35,16 @@ Beside links to archives of binaries we provide also checksum file containing ch
 for archives. You can download file gatekeeper-checksum.txt, it contains sha512 checksums e.g.:
 
 ```
-324b34ece86b6214f835ba9fd79e185864a9005f514458796c22c053de63f428235d2d2a04864065a49c090ad81d2daeb45546544fdd9531a8dea1a43145b8f0  gatekeeper_1.6.1_windows_amd64.zip
-38759e75a94d130758cd26958bd9a66b261be8d58a6c7a0fc04845157649aaf628d22a115c95285b405f8e4d6afa8bd78ca8677d1304faf06db93a0cbbc831a6  gatekeeper_1.6.1_linux_amd64.tar.gz
-f5322e41b3d78017191246bdd54f99e9b3dd8d5ff9d224e7e81b678a952c1d5aae125ea4c251928969b0a0ea0dc59724308c918993c8227f384f61896f58cbd0  gatekeeper_1.6.1_macOS_amd64.tar.gz
+324b34ece86b6214f835ba9fd79e185864a9005f514458796c22c053de63f428235d2d2a04864065a49c090ad81d2daeb45546544fdd9531a8dea1a43145b8f0  gatekeeper_1.7.0_windows_amd64.zip
+38759e75a94d130758cd26958bd9a66b261be8d58a6c7a0fc04845157649aaf628d22a115c95285b405f8e4d6afa8bd78ca8677d1304faf06db93a0cbbc831a6  gatekeeper_1.7.0_linux_amd64.tar.gz
+f5322e41b3d78017191246bdd54f99e9b3dd8d5ff9d224e7e81b678a952c1d5aae125ea4c251928969b0a0ea0dc59724308c918993c8227f384f61896f58cbd0  gatekeeper_1.7.0_macOS_amd64.tar.gz
 ```
 
 After you download archive of binary you can calculate it's checksum by using e.g. sha512sum Linux utility:
 
 ```
-sha512sum /my/path/gatekeeper_1.6.1_linux_amd64.tar.gz
-38759e75a94d130758cd26958bd9a66b261be8d58a6c7a0fc04845157649aaf628d22a115c95285b405f8e4d6afa8bd78ca8677d1304faf06db93a0cbbc831a6  gatekeeper_1.6.1_linux_amd64.tar.g
+sha512sum /my/path/gatekeeper_1.7.0_linux_amd64.tar.gz
+38759e75a94d130758cd26958bd9a66b261be8d58a6c7a0fc04845157649aaf628d22a115c95285b405f8e4d6afa8bd78ca8677d1304faf06db93a0cbbc831a6  gatekeeper_1.7.0_linux_amd64.tar.g
 ```
 
 As you can see output of command is checksum, you can compare it with the one in gatekeeper-checksum.txt.

diff --git a/doc.go b/doc.go
@@ -28,7 +28,7 @@ import (
 )
 
 var (
-	release  = "1.6.1"
+	release  = "1.7.0"
 	gitsha   = "no gitsha provided"
 	compiled = "0"
 	version  = ""

diff --git a/docs/settings.md b/docs/settings.md
@@ -85,6 +85,7 @@
 |    --hostnames value                       | list of hostnames the service will respond to | |
 |    --store-url value                       | url for the storage subsystem, e.g redis://127.0.0.1:6379, file:///etc/tokens.file | | PROXY_STORE_URL
 |    --encryption-key value                  | encryption key used to encryption the session state | | PROXY_ENCRYPTION_KEY
+|    --no-proxy value                        | do not proxy requests to upstream, useful for forward-auth usage (with nginx, traefik) | | PROXY_NO_PROXY
 |    --no-redirects                          | do not have back redirects when no authentication is present, 401 them | false | PROXY_NO_REDIRECTS
 |    --skip-token-verification               | TESTING ONLY; bypass token verification, only expiration and roles enforced | false | PROXY_SKIP_TOKEN_VERIFICATION
 |    --skip-access-token-issuer-check        | according RFC issuer should not be checked on access token, this will be default true in future | false | PROXY_SKIP_ACCESS_TOKEN_ISSUER_CHECK

diff --git a/docs/user-guide.md b/docs/user-guide.md
@@ -252,7 +252,7 @@ in Keycloak, providing granular role controls over issue tokens.
 
 ``` yaml
 - name: gatekeeper
-  image: quay.io/gogatekeeper/gatekeeper:1.6.1
+  image: quay.io/gogatekeeper/gatekeeper:1.7.0
   args:
   - --enable-forwarding=true
   - --forwarding-username=projecta
@@ -279,7 +279,7 @@ Example setup client credentials grant:
 
 ``` yaml
 - name: gatekeeper
-  image: quay.io/gogatekeeper/gatekeeper:1.6.1
+  image: quay.io/gogatekeeper/gatekeeper:1.7.0
   args:
   - --enable-forwarding=true
   - --forwarding-domains=projecta.svc.cluster.local

diff --git a/kube/reverse.yml b/kube/reverse.yml
@@ -21,7 +21,7 @@ spec:
           secretName: tls
       containers:
         - name: proxy
-          image: quay.io/gogatekeeper/gatekeeper:1.6.1
+          image: quay.io/gogatekeeper/gatekeeper:1.7.0
           imagePullPolicy: Always
           args:
             - --client-id=broker