Skip to content

Commit

Permalink
udpated oauth docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sinamics committed Aug 9, 2024
1 parent 13e1752 commit 9189764
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions docs/docs/Authentication/oauth.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,19 @@ Standard OAuth 2.0 is used by various providers, including GitHub and Facebook.

## Examples

### Authentik Configuration

docker-compose.yml
```yml
ztnet:
image: sinamics/ztnet:latest
...
environment:
OAUTH_ID: "your-client-id"
OAUTH_SECRET: "your-client-secret"
OAUTH_WELLKNOWN: "http://{PROVIDER_URL}/application/o/oauth-provider/.well-known/openid-configuration"
```
### Keycloak Configuration
docker-compose.yml
Expand All @@ -59,7 +72,6 @@ ztnet:
environment:
OAUTH_ID: "your-client-id"
OAUTH_SECRET: "your-client-secret"
OAUTH_ALLOW_DANGEROUS_EMAIL_LINKING: "true"
OAUTH_WELLKNOWN: "http://{PROVIDER_URL}/auth/realms/{REALM}/.well-known/openid-configuration"
```
Expand Down Expand Up @@ -108,7 +120,6 @@ ztnet:
image: sinamics/ztnet:latest
...
environment:
OAUTH_ALLOW_DANGEROUS_EMAIL_LINKING: "true"
OAUTH_ID: "your-discord-client-id"
OAUTH_SECRET: "your-discord-client-secret"
OAUTH_ACCESS_TOKEN_URL: "https://discord.com/api/oauth2/token"
Expand Down Expand Up @@ -144,7 +155,6 @@ ztnet:
image: sinamics/ztnet:latest
...
environment:
OAUTH_ALLOW_DANGEROUS_EMAIL_LINKING: "true"
OAUTH_ID: "<copy Application (client) ID here>"
OAUTH_SECRET: "<copy generated client secret value here>"
OAUTH_WELLKNOWN: "https://login.microsoftonline.com/<tentant_id>/v2.0/.well-known/openid-configuration"
Expand All @@ -153,6 +163,7 @@ ztnet:


## Troubleshooting

If you are having trouble with OAuth, please check the docker server logs:
```bash
docker logs ztnet
Expand Down

0 comments on commit 9189764

Please sign in to comment.