Skip to content

Commit

Permalink
website/docs: integrations: add what's up docker (goauthentik#10690)
Browse files Browse the repository at this point in the history
* add sidebar

Signed-off-by: 4d62 <[email protected]>

* add documentation

Signed-off-by: 4d62 <[email protected]>

* Update website/integrations/services/whats-up-docker/index.md

Co-authored-by: Tana M Berry <[email protected]>
Signed-off-by: 4d62 <[email protected]>

---------

Signed-off-by: 4d62 <[email protected]>
Co-authored-by: Tana M Berry <[email protected]>
  • Loading branch information
4d62 and tanberry authored Aug 2, 2024
1 parent 4b2b97f commit b9bf01f
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 0 deletions.
43 changes: 43 additions & 0 deletions website/integrations/services/whats-up-docker/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: What's Up Docker
---

<span class="badge badge--secondary">Support level: Community</span>

## What is What's Up Docker

> What's Up Docker (WUD) is an easy-to-use tool that alerts you whenever a new version of your Docker containers is released.
>
> -- https://fmartinou.github.io/whats-up-docker/
## Preparation

The following placeholders will be used:

- `wud.company` is the FQDN of the WUD install.
- `authentik.company` is the FQDN of the authentik install.

## WUD configuration

To configure WUD to use authentik, add the following values to your `.env` file:

```
WUD_AUTH_OIDC_AUTHENTIK_CLIENTID=<Your Client ID>
WUD_AUTH_OIDC_AUTHENTIK_CLIENTSECRET=<Your Client Secret>
WUD_AUTH_OIDC_AUTHENTIK_DISCOVERY=https://authentik.company/application/o/wud/.well-known/openid-configuration
WUD_AUTH_OIDC_AUTHENTIK_REDIRECT=true # Set to true to skip internal login page
```

After making these changes, restart your Docker containers to apply the new configuration.

## authentik configuration

1. Access the **Admin Interface** in on your authentik install.
2. Create a new **OAuth2 / OpenID Provider**.
3. Note the generated **Client ID** and **Client Secret**.
4. In the provider settings, add this redirect URL under **Redirect URIs/Origins (RegEx)**: `https://wud.company/auth/oidc/authentik/cb`
5. Ensure the `email`, `openid`, and `profile` scopes are selected under **Advanced protocol settings**.
6. Click **Finish** to save the provider configuration.
7. Create a new application associated with this provider.

Once completed, What's Up Docker should be successfully configured to use authentik as its Single Sign-On SSO provider.
1 change: 1 addition & 0 deletions website/sidebarsIntegrations.js
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ module.exports = {
"services/ubuntu-landscape/index",
"services/uptime-kuma/index",
"services/zabbix/index",
"services/whats-up-docker/index",
],
},
{
Expand Down

0 comments on commit b9bf01f

Please sign in to comment.