From 8962081d929b7db28499304126883b8a77a70a87 Mon Sep 17 00:00:00 2001 From: Ernie Date: Wed, 16 Jun 2021 17:08:58 -0400 Subject: [PATCH] website/docs: add wekan (#1032) * Create index.mdx Add Wekan example * updated to include wekan entry --- .../integrations/services/wekan/index.mdx | 80 +++++++++++++++++++ website/sidebars.js | 1 + 2 files changed, 81 insertions(+) create mode 100644 website/docs/integrations/services/wekan/index.mdx diff --git a/website/docs/integrations/services/wekan/index.mdx b/website/docs/integrations/services/wekan/index.mdx new file mode 100644 index 000000000..714e2d4b5 --- /dev/null +++ b/website/docs/integrations/services/wekan/index.mdx @@ -0,0 +1,80 @@ +--- +title: Wekan +--- + +## What is Wekan + +From https://github.com/wekan/wekan/wiki + +:::note +Wekan is an open-source kanban board which allows a card-based task and to-do management. +::: + +## Preparation + +The following placeholders will be used: + +- `wekan.company` is the FQDN of the wekan 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://wekan.company/_oauth/oidc` + +Note the Client ID and Client Secret values. Create an application, using the provider you've created above. Note the slug of the application you've created. + +## Wekan + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + +If your Wekan is running in docker, add the following environment variables for Authentik + +```yaml +environment: + OAUTH2_ENABLED=true + OAUTH2_LOGIN_STYLE=redirect + OAUTH2_CLIENT_ID= + OAUTH2_SERVER_URL=https://authentik.company + OAUTH2_AUTH_ENDPOINT=/application/o/authorize/ + OAUTH2_USERINFO_ENDPOINT=/application/o/userinfo/ + OAUTH2_TOKEN_ENDPOINT=/application/o/token/ + OAUTH2_SECRET= + OAUTH2_ID_MAP=preferred_username + OAUTH2_USERNAME_MAP=preferred_username + OAUTH2_FULLNAME_MAP=given_name + OAUTH2_EMAIL_MAP=email +``` + + + +edit `.env` and add the following: + +```ini + # Authentik OAUTH Config + OAUTH2_ENABLED='true' + OAUTH2_LOGIN_STYLE='redirect' + OAUTH2_CLIENT_ID='' + OAUTH2_SERVER_URL='https://authentik.company' + OAUTH2_AUTH_ENDPOINT='/application/o/authorize/' + OAUTH2_USERINFO_ENDPOINT='/application/o/userinfo/' + OAUTH2_TOKEN_ENDPOINT='/application/o/token/' + OAUTH2_SECRET='' + OAUTH2_ID_MAP='preferred_username' + OAUTH2_USERNAME_MAP='preferred_username' + OAUTH2_FULLNAME_MAP='given_name' + OAUTH2_EMAIL_MAP='email' +``` + + diff --git a/website/sidebars.js b/website/sidebars.js index 6b415fd74..9fb7a23a1 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -89,6 +89,7 @@ module.exports = { "integrations/services/ubuntu-landscape/index", "integrations/services/veeam-enterprise-manager/index", "integrations/services/vmware-vcenter/index", + "integrations/services/wekan/index", "integrations/services/wiki-js/index", "integrations/services/zabbix/index", ],