Skip to content

Commit

Permalink
Fixed typos
Browse files Browse the repository at this point in the history
  • Loading branch information
StiviiK committed Jun 4, 2020
1 parent 220b503 commit f7c659d
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# OIDC Forward Auth for Traefik (v2+)
An OIDC compliant traefik forward auth handler which follows the lifecycle of the token, also supports refreshing of tokens (WIP).
Supports all OIDC compliant Identity Solutions, e.g. KeyCloak, GitHub, Google, ...
# OIDC ForwardAuth for Traefik
An OIDC compliant traefik forwardauth handler which follows the lifecycle of the token, also supports refreshing of tokens (WIP).
Supports all OIDC compliant Identity Solutions, e.g. KeyCloak, GitHub, Google, ...
Code was also built with the Idea to be as simple and minimal as possible.

# Configuration
Configuration is currently only via environmnet variables supported:
Expand All @@ -18,13 +19,14 @@ The authenticated user is set in the `X-Forwarded-User` header.
See more in the [Examples](#Examples) section.

# Examples
Following examples are currently avaiable:
Following examples are currently available:
- [Google Authentication](./examples/google.md)

# Future Features
- Refresh Token support
- Add option to only allow Users with verfied Mails
- Add Mail whitelist, also domain based
- Add option to only allow Users with verfied mails
- Add mail whitelist
- _Your Idea here_

# Cookie Domains
You can supply a comma separated list of cookie domains, if the host of the original request is a subdomain of any given cookie domain, the authentication cookie will set with the given domain.
Expand Down
5 changes: 2 additions & 3 deletions examples/google.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
middlewares:
keycloak:
forwardAuth:
address: "http://traefik-forward-auth:4181" # Note: You need to use the internal DNS name (e.g. docker container nmae)
address: "http://traefik-forward-auth:4181" # Note: You need to use the internal DNS name (e.g. docker container name)
trustForwardHeader: true
authResponseHeaders: [ "X-Forwarded-User" ]
```
Expand Down Expand Up @@ -82,8 +82,7 @@
- traefik.http.routers.keycloak-forward.tls.domains[0].main=*.yourdomain.tld
- traefik.http.routers.keycloak-forward.tls.domains[0].sans=yourdomain.tld
- traefik.http.routers.keycloak-forward.entrypoints=https
- traefik.http.routers.keycloak-forward.middlewares=rate-limit@file
- traefik.http.services.keycloak-forward.loadbalancer.server.port=4181
- traefik.http.routers.keycloak-forward.middlewares=keycloak@file # Note: The forwardauth handler itself requires the forwardauth middleware
````
10. When you now browse to `whoami.yourdomain.tld` you will be redirected to the Google Auth and after successfully authentication you will be redirected back to the application.
10. When you now browse to `whoami.yourdomain.tld` you will be redirected to the Google Auth and after a successfully authentication you will be redirected back to the application.
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ func main() {
// Configure an OpenID Connect aware OAuth2 client.
fw, err := forwardauth.Create(ctx, options)
if err != nil {
logrus.Errorf("failed to create forward auth client: %s", err)
logrus.Errorf("failed to create forwardauth client: %s", err)
logrus.Exit(1)
}

Expand Down

0 comments on commit f7c659d

Please sign in to comment.