summaryrefslogtreecommitdiff
path: root/docs/guides/auth/keycloak.md
diff options
context:
space:
mode:
authorDavid Mehren2020-11-15 21:02:36 +0100
committerGitHub2020-11-15 21:02:36 +0100
commit4c0efe1237bc33b52d06eaf86a28adad9a041ec2 (patch)
treefa068d16074645b7b6d8d88b78724b9cd82dd879 /docs/guides/auth/keycloak.md
parent299301f0fe5bea41b4407bbbc03932fc4dd1c1d3 (diff)
parent9898ab3ca5fa226967d8a3aca8e6e752554ed64d (diff)
Merge pull request #453 from hedgedoc/misc/renaming
Diffstat (limited to 'docs/guides/auth/keycloak.md')
-rw-r--r--docs/guides/auth/keycloak.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/guides/auth/keycloak.md b/docs/guides/auth/keycloak.md
index 16e24bc5..82f6d321 100644
--- a/docs/guides/auth/keycloak.md
+++ b/docs/guides/auth/keycloak.md
@@ -1,4 +1,4 @@
-OAuth with Keycloak/Red Hat SSO (self-hosted)
+# OAuth with Keycloak/Red Hat SSO (self-hosted)
## Prerequisites
@@ -13,7 +13,7 @@ Where HTTPS is specified throughout, use HTTP instead. You may also have to spec
You may note that a separate realm is specified throughout this tutorial. It is best practice not to use the master realm, as it normally contains the realm-management client that federates access using the policies and permissions you can create.
2. Navigate to the client management page at `https://keycloak.example.com/auth/admin/master/console/#/realms/your-realm/clients` (admin permissions required)
-3. Click **Create** to create a new client and fill out the registration form. You should set the Root URL to the fully qualified public URL of your CodiMD instance.
+3. Click **Create** to create a new client and fill out the registration form. You should set the Root URL to the fully qualified public URL of your HedgeDoc instance.
4. Click **Save**
5. Set the **Access Type** of the client to `confidential`. This will make your client require a client secret upon authentication.
@@ -24,7 +24,7 @@ You may note that a separate realm is specified throughout this tutorial. It is
1. Select Client Scopes from the sidebar, and begin to create a new client scope using the Create button.
2. Ensure that the **Name** field is set to `id`.
3. Create a new mapper under the Mappers tab. This should reference the User Property `id`. `Claim JSON Type` should be String and all switches below should be enabled. Save the mapper.
-4. Go to the client you set up in the previous steps using the Clients page, then choose the Client Scopes tab. Apply the scope you've created. This should mitigate errors as seen in [codimd/server#56](https://github.com/codimd/server/issues/56), as the `/userinfo` endpoint should now bring back the user's ID under the `id` key as well as `sub`.
+4. Go to the client you set up in the previous steps using the Clients page, then choose the Client Scopes tab. Apply the scope you've created. This should mitigate errors as seen in [hedgedoc/hedgedoc#56](https://github.com/hedgedoc/hedgedoc/issues/56), as the `/userinfo` endpoint should now bring back the user's ID under the `id` key as well as `sub`.
---
@@ -40,10 +40,10 @@ CMD_OAUTH2_AUTHORIZATION_URL=https://keycloak.example.com/auth/realms/your-realm
CMD_OAUTH2_CLIENT_ID=<your client ID>
CMD_OAUTH2_CLIENT_SECRET=<your client secret, which you can find under the Credentials tab for your client>
CMD_OAUTH2_PROVIDERNAME=Keycloak
-CMD_DOMAIN=<codimd.example.com>
+CMD_DOMAIN=<hedgedoc.example.com>
CMD_PROTOCOL_USESSL=true
CMD_URL_ADDPORT=false
```
6. Run `docker-compose up -d` to apply your settings.
-7. Sign in to your CodiMD using your Keycloak ID
+7. Sign in to your HedgeDoc using your Keycloak ID