Skip to content

Commit

Permalink
Merge pull request sinamics#601 from sinamics/keycloak
Browse files Browse the repository at this point in the history
Updated docs for keycloak oauth
  • Loading branch information
sinamics authored Dec 7, 2024
2 parents 8fbb7f2 + 46e628e commit 38a5c9d
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions docs/docs/Authentication/oauth.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,17 +64,31 @@ ztnet:
### Keycloak Configuration
docker-compose.yml
Keycloak can be configured to provide authentication for ZTNet using OpenID Connect. Below are the configuration details and important notes about URL structures.
#### Docker Configuration
```yml
ztnet:
image: sinamics/ztnet:latest
...
environment:
OAUTH_ID: "your-client-id"
OAUTH_SECRET: "your-client-secret"
OAUTH_WELLKNOWN: "http://{PROVIDER_URL}/auth/realms/{REALM}/.well-known/openid-configuration"
OAUTH_WELLKNOWN: "http://{PROVIDER_URL}/realms/{REALM}/.well-known/openid-configuration"
```
#### Important Notes
1. **URL Structure Changes**
- For Keycloak versions 17 and newer:
```
http://{PROVIDER_URL}/realms/{REALM}/.well-known/openid-configuration
```
- For older Keycloak versions (pre-17):
```
http://{PROVIDER_URL}/auth/realms/{REALM}/.well-known/openid-configuration
```

### GitHub Configuration


Expand Down

0 comments on commit 38a5c9d

Please sign in to comment.