Skip to content

Commit fe9cfa1

Browse files
authored
Update docu for 3.1.0 release (#546)
1 parent 69f2d54 commit fe9cfa1

File tree

4 files changed

+41
-8
lines changed

4 files changed

+41
-8
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ Please remember to provide a good summary, description as well as steps to repro
2222
To run Gatekeeper, you can build it using this command:
2323

2424
```bash
25-
docker buildx build --platform linux/amd64,linux/arm64 -t quay.io/gogatekeeper/gatekeeper:3.0.2 .
25+
docker buildx build --platform linux/amd64,linux/arm64 -t quay.io/gogatekeeper/gatekeeper:3.1.0 .
2626
```
2727

2828
or you can use aleady existing Docker image by running:
2929

3030
```bash
31-
docker run -it --rm quay.io/gogatekeeper/gatekeeper:3.0.2 \
31+
docker run -it --rm quay.io/gogatekeeper/gatekeeper:3.1.0 \
3232
--listen 127.0.0.1:8080 \
3333
--upstream-url http://127.0.0.1:80 \
3434
--discovery-url https://keycloak.example.com/realms/<REALM_NAME> \

docs/content/_index.md

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -230,8 +230,41 @@ If you have roles listed in some custom claim, please see [custom claim matching
230230
You can use gatekeeper to protect APIs, frontend server applications, frontend client applications.
231231
Frontend server-side applications can be protected by Authorization Code Flow (also with PKCE), during which several redirection
232232
steps take place. For protecting APIs you can use Client Credentials Grant to avoid redirections steps
233-
involved in authorization code flow you have to use `--no-redirects=true`. For frontend applications
234-
you can use Authorization Code Flow (also with PKCE) with encrypted refresh token cookies enabled, in this case however you have to handle redirections, e.g. at token expiration.
233+
involved in authorization code flow you have to use `--no-redirects=true`.
234+
235+
From version 3.1.0 gatekeeper also supports both Authorization Code Flow and "API" mode to be configured
236+
on same gatekeeper, example:
237+
238+
```yaml
239+
# this configuration enables globally Authorization Code Flow and "API" (no-redirect=true) mode
240+
# on /api/v1/* and /api/v2*
241+
no-redirects: false
242+
resources:
243+
- uri: /api/v1/*
244+
methods:
245+
- GET
246+
no-redirect: true
247+
- uri: /api/v2/*
248+
methods:
249+
- GET
250+
no-redirect: true
251+
```
252+
253+
**IMPORTANT** - This will not work, from technical and backward compatibility reasons, you can override in
254+
resources only to no-redirect=true:
255+
256+
```yaml
257+
no-redirects: true
258+
resources:
259+
- uri: /myfrontend1
260+
methods:
261+
- GET
262+
no-redirect: false
263+
- uri: /myfrontend2
264+
methods:
265+
- GET
266+
no-redirect: false
267+
```
235268

236269
## Default Deny
237270

@@ -481,7 +514,7 @@ in Keycloak, providing granular role controls over issue tokens.
481514

482515
``` yaml
483516
- name: gatekeeper
484-
image: quay.io/gogatekeeper/gatekeeper:3.0.2
517+
image: quay.io/gogatekeeper/gatekeeper:3.1.0
485518
args:
486519
- --enable-forwarding=true
487520
- --forwarding-username=projecta
@@ -508,7 +541,7 @@ Example setup client credentials grant:
508541

509542
``` yaml
510543
- name: gatekeeper
511-
image: quay.io/gogatekeeper/gatekeeper:3.0.2
544+
image: quay.io/gogatekeeper/gatekeeper:3.1.0
512545
args:
513546
- --enable-forwarding=true
514547
- --forwarding-domains=projecta.svc.cluster.local

e2e/k8s/manifest_test_forwardauth.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2626,7 +2626,7 @@ spec:
26262626
- -c
26272627
- "while true;do sleep 10;done"
26282628
- name: proxy
2629-
image: quay.io/gogatekeeper/gatekeeper:3.0.2
2629+
image: quay.io/gogatekeeper/gatekeeper:3.1.0
26302630
imagePullPolicy: Never
26312631
args:
26322632
- --client-id=test-client

kube/reverse.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ spec:
2121
secretName: tls
2222
containers:
2323
- name: proxy
24-
image: quay.io/gogatekeeper/gatekeeper:3.0.2
24+
image: quay.io/gogatekeeper/gatekeeper:3.1.0
2525
imagePullPolicy: Always
2626
args:
2727
- --client-id=broker

0 commit comments

Comments
 (0)