From 90ca1b8e5a5f9232fdf6ab4cc666104acfd7573c Mon Sep 17 00:00:00 2001 From: Lars Lehmann <33843261+larslehmann-net@users.noreply.github.com> Date: Mon, 22 Nov 2021 22:55:14 +0100 Subject: [PATCH] website/integrations: Add Provider/HedgeDoc (#1829) * docs: add integration docs for hedgedoc * docs: add integration docs for hedgedoc --- .../integrations/services/hedgedoc/index.md | 47 +++++++++++++++++++ website/sidebarsIntegrations.js | 1 + 2 files changed, 48 insertions(+) create mode 100644 website/integrations/services/hedgedoc/index.md diff --git a/website/integrations/services/hedgedoc/index.md b/website/integrations/services/hedgedoc/index.md new file mode 100644 index 000000000..e586608b5 --- /dev/null +++ b/website/integrations/services/hedgedoc/index.md @@ -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: '' +CMD_OAUTH2_CLIENT_SECRET: '' +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' +``` \ No newline at end of file diff --git a/website/sidebarsIntegrations.js b/website/sidebarsIntegrations.js index 157d792b3..27d958be5 100644 --- a/website/sidebarsIntegrations.js +++ b/website/sidebarsIntegrations.js @@ -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",