* website: integrations-all: update doc titles to start with "integrate with" * website/integrations-all: cleanup script * start ??? will do the rest in a sec * website/integrations-all: fix broken script website/integrations-all: fix website/integrations-all: fix website/integrations-all: fix website/integrations-all: fix
1.6 KiB
1.6 KiB
title, sidebar_label
| title | sidebar_label |
|---|---|
| Integrate with HedgeDoc | HedgeDoc |
Integrate with HedgeDoc
Support level: Community
What is HedgeDoc
HedgeDoc lets you create real-time collaborative markdown notes.
Preparation
The following placeholders are used in this guide:
hedgedoc.companyis the FQDN of the HedgeDoc installation.authentik.companyis the FQDN of the authentik installation.
Create an OAuth2/OpenID provider with the following parameters:
- Client Type:
Confidential - Scopes: OpenID, Email and Profile
- Signing Key: Select any available key
- Redirect URIs:
https://hedgedoc.company/auth/oauth2/callback
Note the Client ID and Client Secret values. Create an application, using the provider you've created above. To be logged in immediately if you click on the application, set:
- Launch URL:
https://hedgedoc.company/auth/oauth2
HedgeDoc
You need to set the following env Variables for Docker based installations.
Set the following values:
CMD_OAUTH2_PROVIDERNAME: "authentik"
CMD_OAUTH2_CLIENT_ID: "<Client ID from above>"
CMD_OAUTH2_CLIENT_SECRET: "<Client Secret from above>"
CMD_OAUTH2_SCOPE: "openid email profile"
CMD_OAUTH2_USER_PROFILE_URL: "https://authentik.company/application/o/userinfo/"
CMD_OAUTH2_TOKEN_URL: "https://authentik.company/application/o/token/"
CMD_OAUTH2_AUTHORIZATION_URL: "https://authentik.company/application/o/authorize/"
CMD_OAUTH2_USER_PROFILE_USERNAME_ATTR: "preferred_username"
CMD_OAUTH2_USER_PROFILE_DISPLAY_NAME_ATTR: "name"
CMD_OAUTH2_USER_PROFILE_EMAIL_ATTR: "email"