This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
authentik/website/integrations/sources/mailcow/index.md
Dorian Zedler e9064509fe
sources/oauth: Add Mailcow oauth source (#2380)
* Feat: Add Mailcow oauth source

* Feat: Add mailcow icon

* Run make

* Feat: Add tests

* Fix: Remainder from discord test

* Docs: Add mailcow oauth source docs

* Docs: add mailcow source to menu

* Fix: Mailcow provider type in test

* Fix: Formatting

* Fix: Doc file name
2022-02-27 15:06:02 +01:00

1.5 KiB

title
Mailcow

Allows users to authenticate using their Mailcow credentials

Preparation

The following placeholders will be used:

  • authentik.company is the FQDN of the authentik install.
  • mailcow.company is the FQDN of the mailcow install.

Mailcow

  1. Log into mailcow as an admin and navigate to the OAuth2 Apps settings

OAuth2 Apps menu

  1. Click "Add OAuth2 Client"

  2. Insert the redirect URL: https://authentik.company/source/oauth/callback/mailcow

Add OAuth2 CLient

  1. Copy the Client ID and Client secret and save it for later

ClientID and Secret

Authentik

  1. Under Directory -> Federation & Social login Click Create > Mailcow OAuth Source

Mailcow OAuth Source

  1. Name: Choose a name (For the example I used Mailcow)
  2. Slug: mailcow (You can choose a different slug, if you do you will need to update the Mailcow redirect URL and point it to the correct slug.)
  3. Consumer Key: Client ID from step 4
  4. Consumer Secret: Client Secret from step 4
  5. Authorization URL: https://mailcow.company/oauth/authorize
  6. Access token URL: https://mailcow.company/oauth/token
  7. Profile URL: https://mailcow.company/oauth/profile

Here is an example of a complete authentik Mailcow OAuth Source

Example Screen

Save, and you now have Mailcow as a source.

:::note For more details on how-to have the new source display on the Login Page see here. :::