Skip to content

Commit 33e2916

Browse files
committed
Add details on how files are generated for basic and jwt auth
1 parent 70caae2 commit 33e2916

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/proposals/authentication-filter.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -469,6 +469,10 @@ spec:
469469
470470
#### Generated NGINX config
471471
472+
Note: For Basic Auth, NGF will store the file used by `auth_basic_user_file` in `/etc/nginx/secrets/`
473+
The full path will use the `name` and `key` of the secret referenced by `AuthenticationFilter`
474+
In this case, the full path will be `/etc/nginx/secrets/basic-auth-users/htpasswd`
475+
472476
```nginx
473477
http {
474478
upstream backend_default {
@@ -619,6 +623,10 @@ Below are `two` potential NGINX configurations based on the mode used.
619623

620624
1. NGINX Config when using `Mode: File` (i.e. locally referenced JWKS key)
621625

626+
Note: For JWT Auth, NGF will store the file used by `auth_jwt_key_file` in `/etc/nginx/keys/`
627+
The full path will use the `name` and `key` of the secret referenced by `AuthenticationFilter`
628+
In this case, the full path will be `/etc/nginx/keys/jwt-keys-secure/jwks.json`
629+
622630
```nginx
623631
http {
624632
upstream backend_default {

0 commit comments

Comments
 (0)