website/docs: add wekan (#1032)
* Create index.mdx Add Wekan example * updated to include wekan entry
This commit is contained in:
		
							
								
								
									
										80
									
								
								website/docs/integrations/services/wekan/index.mdx
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										80
									
								
								website/docs/integrations/services/wekan/index.mdx
									
									
									
									
									
										Normal file
									
								
							@ -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';
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					<Tabs
 | 
				
			||||||
 | 
					  defaultValue="docker"
 | 
				
			||||||
 | 
					  values={[
 | 
				
			||||||
 | 
					    {label: 'Docker', value: 'docker'},
 | 
				
			||||||
 | 
					    {label: 'Standalone', value: 'standalone'},
 | 
				
			||||||
 | 
					  ]}>
 | 
				
			||||||
 | 
					  <TabItem value="docker">
 | 
				
			||||||
 | 
					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=<Client ID from above>
 | 
				
			||||||
 | 
					      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=<Client Secret from above>
 | 
				
			||||||
 | 
					      OAUTH2_ID_MAP=preferred_username
 | 
				
			||||||
 | 
					      OAUTH2_USERNAME_MAP=preferred_username
 | 
				
			||||||
 | 
					      OAUTH2_FULLNAME_MAP=given_name
 | 
				
			||||||
 | 
					      OAUTH2_EMAIL_MAP=email
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					  </TabItem>
 | 
				
			||||||
 | 
					  <TabItem value="standalone">
 | 
				
			||||||
 | 
					    
 | 
				
			||||||
 | 
					edit `.env` and add the following:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```ini
 | 
				
			||||||
 | 
					     # Authentik OAUTH Config
 | 
				
			||||||
 | 
					      OAUTH2_ENABLED='true'
 | 
				
			||||||
 | 
					      OAUTH2_LOGIN_STYLE='redirect'
 | 
				
			||||||
 | 
					      OAUTH2_CLIENT_ID='<Client ID from above>'
 | 
				
			||||||
 | 
					      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='<Client Secret from above>'
 | 
				
			||||||
 | 
					      OAUTH2_ID_MAP='preferred_username'
 | 
				
			||||||
 | 
					      OAUTH2_USERNAME_MAP='preferred_username'
 | 
				
			||||||
 | 
					      OAUTH2_FULLNAME_MAP='given_name'
 | 
				
			||||||
 | 
					      OAUTH2_EMAIL_MAP='email'
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					  </TabItem>
 | 
				
			||||||
 | 
					</Tabs>
 | 
				
			||||||
@ -89,6 +89,7 @@ module.exports = {
 | 
				
			|||||||
                        "integrations/services/ubuntu-landscape/index",
 | 
					                        "integrations/services/ubuntu-landscape/index",
 | 
				
			||||||
                        "integrations/services/veeam-enterprise-manager/index",
 | 
					                        "integrations/services/veeam-enterprise-manager/index",
 | 
				
			||||||
                        "integrations/services/vmware-vcenter/index",
 | 
					                        "integrations/services/vmware-vcenter/index",
 | 
				
			||||||
 | 
					                        "integrations/services/wekan/index",
 | 
				
			||||||
                        "integrations/services/wiki-js/index",
 | 
					                        "integrations/services/wiki-js/index",
 | 
				
			||||||
                        "integrations/services/zabbix/index",
 | 
					                        "integrations/services/zabbix/index",
 | 
				
			||||||
                    ],
 | 
					                    ],
 | 
				
			||||||
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user