Skip to content

Commit

Permalink
Fix the docs build (#904)
Browse files Browse the repository at this point in the history
  • Loading branch information
BentiGorlich authored Jul 11, 2024
1 parent b7bb142 commit 2cdaf80
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions docs/02-admin/03-optional-features/sso.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,24 +20,24 @@ and provide the app/client ID and a secret. These have to be entered in the corr
in the `.env`|`.env.local` file

### Google
<https://developers.google.com/>
https://developers.google.com/
```dotenv
OAUTH_GOOGLE_ID=AS2easdioh912 # your client ID
OAUTH_GOOGLE_SECRET=sdfpsajh329ura39ßseaoßjf30u # your client secret
```

### Facebook
<https://developers.facebook.com>
https://developers.facebook.com
```dotenv
OAUTH_FACEBOOK_ID=AS2easdioh912 # your client ID
OAUTH_FACEBOOK_SECRET=sdfpsajh329ura39ßseaoßjf30u # your client secret
```

### GitHub

You need a GitHub account, if you do no have one, yet, go and create one: <https://github.com/signup>
You need a GitHub account, if you do no have one, yet, go and create one: https://github.com/signup

1. Go to <https://github.com/settings/apps>
1. Go to https://github.com/settings/apps
2. Click on "New GitHub App"
3. Enter the app name, description and Homepage URL (just your instance URL)
4. Click the checkbox "Request user authorization (OAuth) during installation"
Expand All @@ -53,7 +53,7 @@ OAUTH_GITHUB_SECRET=sdfpsajh329ura39ßseaoßjf30u # your client secret
```

### Keycloak
Self-hosted, <https://www.keycloak.org/>
Self-hosted, https://www.keycloak.org/
```dotenv
OAUTH_KEYCLOAK_ID=AS2easdioh912 # your client ID
OAUTH_KEYCLOAK_SECRET=sdfpsajh329ura39ßseaoßjf30u # your client secret
Expand All @@ -63,7 +63,7 @@ OAUTH_KEYCLOAK_VERSION=
```

### Zitadel
Self-hosted, <https://zitadel.com/>
Self-hosted, https://zitadel.com/
```dotenv
OAUTH_ZITADEL_ID=AS2easdioh912 # your client ID
OAUTH_ZITADEL_SECRET=sdfpsajh329ura39ßseaoßjf30u # your client secret
Expand All @@ -72,9 +72,9 @@ OAUTH_ZITADEL_BASE_URL=

### SimpleLogin

You need a SimpleLogin account, if you do not have one, yet, go and create one: <https://app.simplelogin.io/auth/register>
You need a SimpleLogin account, if you do not have one, yet, go and create one: https://app.simplelogin.io/auth/register

1. Go to <https://app.simplelogin.io/developer> and click on "New website"
1. Go to https://app.simplelogin.io/developer and click on "New website"
2. Enter the name of your instance and the url to your instance
3. Choose an icon (if you want to)
4. Click on "OAuth Settings" on the right
Expand All @@ -88,9 +88,9 @@ OAUTH_SIMPLELOGIN_SECRET=fdiuasdfusdfsdfpsdagofweopf # your client secret

### Discord

You need a Discord account, if you do not have one, yet, go and create one: <https://discord.com/register>
You need a Discord account, if you do not have one, yet, go and create one: https://discord.com/register

1. Go to <https://discord.com/developers/applications> and create a new application. If you want, add an image and a description.
1. Go to https://discord.com/developers/applications and create a new application. If you want, add an image and a description.
2. Click the "OAuth2" tab on the left
3. Under "Client information" click "Reset Secret"
4. The newly generated secret and the "Client ID" need to go in our `.env` file:
Expand All @@ -104,22 +104,22 @@ OAUTH_DISCORD_SECRET=xJHGApsadOPUIAsdoih # your client secret
8. When you go to the login page you should see a button to "Continue with Discord"

### Authentik
Self-hosted, <https://goauthentik.io/>
Self-hosted, https://goauthentik.io/
```dotenv
OAUTH_AUTHENTIK_ID=3245498543 # your client ID
OAUTH_AUTHENTIK_SECRET=xJHGApsadOPUIAsdoih # your client secret
OAUTH_AUTHENTIK_BASE_URL=
```

### Privacy Portal
<https://privacyportal.org>
https://privacyportal.org
```dotenv
OAUTH_PRIVACYPORTAL_ID=3245498543 # your client ID
OAUTH_PRIVACYPORTAL_SECRET=xJHGApsadOPUIAsdoih # your client secret
```

### Azure
<https://login.microsoftonline.com>
https://login.microsoftonline.com
```dotenv
OAUTH_AZURE_ID=3245498543 # your client ID
OAUTH_AZURE_SECRET=xJHGApsadOPUIAsdoih # your client secret
Expand Down

0 comments on commit 2cdaf80

Please sign in to comment.