From a4bd2cc263528809872fb0da1cbfe5a1b53772ca Mon Sep 17 00:00:00 2001 From: Dewi Roberts Date: Fri, 30 May 2025 18:10:03 +0100 Subject: [PATCH] website/integrations: add komodo (#14790) * Add doc and update sidebar * WIP * Finished Komodo configuration steps * Applied suggestions from Dominic * Missing indentation * Update website/integrations/services/komodo/index.mdx Co-authored-by: Dominic R Signed-off-by: Dewi Roberts * Applied Tana's suggestions --------- Signed-off-by: Dewi Roberts Co-authored-by: Dominic R --- .../integrations/services/komodo/index.mdx | 75 +++++++++++++++++++ website/sidebars/integrations.mjs | 1 + 2 files changed, 76 insertions(+) create mode 100644 website/integrations/services/komodo/index.mdx diff --git a/website/integrations/services/komodo/index.mdx b/website/integrations/services/komodo/index.mdx new file mode 100644 index 0000000000..3cb62d27bb --- /dev/null +++ b/website/integrations/services/komodo/index.mdx @@ -0,0 +1,75 @@ +--- +title: Integrate with Komodo +sidebar_label: Komodo +support_level: community +--- + +## What is Komodo + +> Komodo is a web-based application designed to organize and streamline the management of servers, builds, deployments, and automated tasks. +> +> -- https://komo.do/ + +## Preparation + +The following placeholders are used in this guide: + +- `komodo.company` is the FQDN of your Komodo installation. +- `authentik.company` is the FQDN of the authentik installation. + +:::note +This documentation lists only the settings that you need to change from their default values. Be aware that any changes other than those explicitly mentioned in this guide could cause issues accessing your application. +::: + +## authentik configuration + +To support the integration of Komodo with authentik, you need to create an application/provider pair in authentik. + +### Create an application and provider in authentik + +1. Log in to authentik as an administrator and open the authentik Admin interface. +2. Navigate to **Applications** > **Applications** and click **Create with Provider** to create an application and provider pair. (Alternatively you can first create a provider separately, then create the application and connect it with the provider.) + + - **Application**: provide a descriptive name, an optional group for the type of application, the policy engine mode, and optional UI settings. + - **Choose a Provider type**: select **OAuth2/OpenID Connect** as the provider type. + - **Configure the Provider**: provide a name (or accept the auto-provided name), the authorization flow to use for this provider, and the following required configurations. + - Note the **Client ID** and **Client Secret** values because they will be required later. + - Set a `Strict` redirect URI to `https://komodo.company/auth/oidc/callback`. + - Select any available signing key. + - **Configure Bindings** _(optional)_: you can create a [binding](/docs/add-secure-apps/flows-stages/bindings/) (policy, group, or user) to manage the listing and access to applications on a user's **My applications** page. + +3. Click **Submit** to save the new application and provider. + +## Komodo configuration + +### Setup OIDC connection + +1. Edit the following environment variables in your Komodo `compose.env` file, or if using a mounted config file, edit your `./komodo/core.config.toml` file: + +```yaml +KOMODO_OIDC_ENABLED=true +KOMODO_OIDC_PROVIDER=https://authentik.company/application/o/authorize +KOMODO_OIDC_CLIENT_ID= +KOMODO_OIDC_CLIENT_SECRET= +``` + +2. Redeploy Komodo for the changes to take effect. + +### User configuration + +Komodo doesn't currently have a method to provision OIDC users, therefore OIDC accounts need to be manually enabled after first login. Follow these steps to create and enable OIDC users in Komodo: + +1. Log in to Komodo via the OIDC button on the login page. +2. You will be redirected to authentik to login (if you are already logged in, you will be redirected to step 3). +3. You will be redirected back to Komodo, and receive an error message saying "User Not Enabled". +4. Log in to Komodo using a local administrator account. +5. In the sidebar click **Settings**, and under the **Users** section, click the name of your authentik user. The **User type** should be **OIDC**. +6. Click **Enable User**, and assign the desired pemissions. + +## Configuration verification + +To confirm that authentik is properly configured with Komodo, log out and attempt to log back in by clicking the OIDC button. You should be redirected to authentik to login, if successful you will be redirected to the Komodo dashboard. + +## Resources + +- [Komodo Docs - Advanced Configuration](https://komo.do/docs/setup/advanced) diff --git a/website/sidebars/integrations.mjs b/website/sidebars/integrations.mjs index b65fbf861e..d60e5832f9 100644 --- a/website/sidebars/integrations.mjs +++ b/website/sidebars/integrations.mjs @@ -86,6 +86,7 @@ const items = [ "services/hashicorp-vault/index", "services/jenkins/index", "services/knocknoc/index", + "services/komodo/index", "services/meshcentral/index", "services/minio/index", "services/netbox/index",