website/integrations: Add Provider/HedgeDoc (#1829)

* docs: add integration docs for hedgedoc

* docs: add integration docs for hedgedoc
This commit is contained in:
Lars Lehmann 2021-11-22 22:55:14 +01:00 committed by GitHub
parent f1e95b8816
commit 90ca1b8e5a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 48 additions and 0 deletions

View file

@ -0,0 +1,47 @@
---
title: HedgeDoc
---
## What is HedgeDoc
From https://github.com/hedgedoc/hedgedoc
:::note
HedgeDoc lets you create real-time collaborative markdown notes.
:::
## Preparation
The following placeholders will be used:
- `hedgedoc.company` is the FQDN of the HedgeDoc install.
- `authentik.company` is the FQDN of the authentik install.
Create an application in authentik. Create an OAuth2/OpenID provider with the following parameters:
- Client Type: `Confidential`
- JWT Algorithm: `RS256`
- Scopes: OpenID, Email and Profile
- RSA 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.
## HedgeDoc
You need to set the following `env` Variables for Docker based installations.
Set the following values:
```yaml
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'
```

View file

@ -34,6 +34,7 @@ module.exports = {
"services/gitlab/index",
"services/grafana/index",
"services/harbor/index",
"services/hedgedoc/index",
"services/home-assistant/index",
"services/matrix-synapse/index",
"services/minio/index",