diff --git a/website/integrations/services/engomo/index.md b/website/integrations/services/engomo/index.md deleted file mode 100644 index 2bd066da3d20..000000000000 --- a/website/integrations/services/engomo/index.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: Integrate with engomo -sidebar_label: engomo ---- - -# Integrate with engomo - -Support level: Community - -## What is engomo - -> engomo is an low-code app development platform to create enterprise apps for smartphones and tablets based on Android, iOS, or iPadOS. -> -- https://engomo.com/ -> -> This guide explains how to set up engomo to use authentik as the OAuth provider for the application login on the smartphone/tablet and login to the admin WebGUI (composer). - -## Preparation - -The following placeholders are used in this guide: - -- `engomo.company` is the FQDN of the engomo installation. -- `authentik.company` is the FQDN of the authentik installation. -- `engomo.mapping` is the name of the Scope Mapping. -- `ak.cert` is the self-signed certificate that will be used for the service provider. - -:::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 - -In authentik, create a new scope mapping. To do so, log in and navigate to the Admin interface, then go to **Customization --> Property Mapping** and click **Create**. - -- `engomo.mapping` is the value of the Mapping's name. -- `profile` is the value for the Scope name. -- `return {"preferred_username": request.user.email}` is the value for the Expression. - -Create an application and an OAuth2/OpenID provider in authentik. Use the following parameters for the OAuth2/OpenID provider: - -**Provider:** - -- Name: `SP-engomo` -- Client type: `Public` -- Redirect URIs/Origins (RegEx): `https://engomo.company/auth` and `com.engomo.engomo://callback/` -- Signing Key: `ak.cert` -- Scopes: `authentik default OAuth Mapping: OpenID 'email', 'offline_access', OpenID 'openid'` and `engomo.mapping` - -> [!IMPORTANT] -> Redirect URIs => write the values line by line. - -Leave the rest as default values. The durations can be changed as needed. - -**Application:** - -- Name: `engomo` -- Slug: `engomo` -- Launch URL: `https://engomo.company/` - -## engomo configuration - -Navigate to `https://engomo.company/composer` and log in with your admin credentials. - -- Select `Server`. -- Select `Authentication`. -- Add a new authentication method by clicking on the plus icon on the right. -- Name: `authentik` -- Type: `OpenID Connect` -- Click **Create**. -- Set the `Issuer` to the authentik FQDN `https://authentik.company/application/o/engomo`. -- Set the `Client ID` to the Client ID from the SP-engomo provider that you created in authentik. -- Set the `Client Secret` to the Client Secret from the SP-engomo provider that you created in authentik. - -Leave the rest as default. - -## engomo user creation - -engomo doesn't create users automatically when signing in. So you have to do it manually right now. -Navigate to `https://engomo.company/composer` and log in with your admin credentials. - -- Select `Users & Devices`. -- Click the plus button next in the Users section. -- Select `authentik` as the Authenticator in the dropdown. -- Create your user by typing in the email as the Username used in authentik. - -At this point you are done. - -## Test the login - -- Open a browser of your choice and open the URL `https://engomo.company`. -- Enter the created user's email address and click the small arrow icon to log in. -- You should be redirected to authentik (with the login flows you created) and then authentik should redirect you back to `https://engomo.company/composer` URL. -- If you are redirected back to the `https://engomo.company/composer` URL you did everything correct. - -> [!IMPORTANT] -> The created user will only have access to the app or composer page if you granted the permission to the user of course. diff --git a/website/integrations/services/engomo/index.mdx b/website/integrations/services/engomo/index.mdx new file mode 100644 index 000000000000..f7327c4c1142 --- /dev/null +++ b/website/integrations/services/engomo/index.mdx @@ -0,0 +1,87 @@ +--- +title: Integrate with engomo +sidebar_label: engomo +--- + +# Integrate with engomo + +Support level: Community + +## What is engomo + +> engomo is an low-code app development platform to create enterprise apps for smartphones and tablets based on Android, iOS, or iPadOS. +> +> -- https://engomo.com/ +> +> This guide explains how to set up engomo to use authentik as the OAuth provider for the application login on the smartphone/tablet and login to the admin WebGUI (composer). + +## Preparation + +The following placeholders are used in this guide: + +- `engomo.company` is the FQDN of the engomo installation. +- `authentik.company` is the FQDN of the authentik installation. +- `engomo.mapping` is the name of the Scope Mapping. + +:::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 + +In authentik, create a new scope mapping. To do so, log in and navigate to the Admin interface, then go to **Customization --> Property Mapping** and click **Create**. + +- `engomo.mapping` is the value of the Mapping's name. +- `profile` is the value for the Scope name. +- `return {"preferred_username": request.user.email}` is the value for the Expression. + +[Create](https://docs.goauthentik.io/docs/add-secure-apps/applications/manage_apps#add-new-applications) an OAuth2/OpenID provider and an application in authentik. Use the following parameters for the OAuth2/OpenID provider: + +1. In the authentik Admin interface, navigate to **Applications** -> **Applications**. +2. Use the wizard to create a new application and provider. During this process: + - Note the **Client ID**, **Client Secret**, and **slug** values for later use. + - Select implicit or explicit authorization flow as desired. + - Set Client type to `Public`. + - Set the redirect URI to https://engomo.company/auth and com.engomo.engomo://callback/. + - Select any available signing key. + - Add the `engomo.mapping` scope in addition to the default values. + +:::note +Redirect URIs => write the values line by line. +::: + +## engomo configuration + +Navigate to https://engomo.company/composer and log in with your admin credentials. + +1. Select **Server**. +2. Select **Authentication**. +3. Add a new authentication method by clicking on the plus icon on the right. +4. Name: `authentik` +5. Type: **OpenID Connect** +6. Click **Create**. +7. Configure the following values using information from the authentik provider: + - Set **Issuer** to https://authentik.company/application/o/engomo. + - Set **Client ID** to the Client ID copied from authentik. + - Set **Client secret** to the Client Secret copied from authentik. + +## engomo user creation + +engomo doesn't create users automatically when signing in. So you have to do it manually right now. +Navigate to https://engomo.company/composer and log in with your admin credentials. + +- Select **Users & Devices**. +- Click the plus button in the Users section. +- Choose `authentik` from the Authenticator dropdown. +- Create your user by entering the email address as the username. This email must match the one used for the user in authentik. + +## Test the login + +- Open a browser of your choice and open the URL https://engomo.company. +- Enter the created user's email address and click the small arrow icon to log in. +- You should be redirected to authentik (with the login flows you created) and then authentik should redirect you back to https://engomo.company/composer URL. +- If you are redirected back to the https://engomo.company/composer URL you did everything correct. + +:::note +The created user will only have access to the app or composer page if they have been granted the necessary permissions. +::: diff --git a/website/integrations/services/rustdesk-pro/index.mdx b/website/integrations/services/rustdesk-pro/index.mdx index 83c4a6b5f995..80c8306a7ed2 100644 --- a/website/integrations/services/rustdesk-pro/index.mdx +++ b/website/integrations/services/rustdesk-pro/index.mdx @@ -14,6 +14,8 @@ sidebar_label: RustDesk Server Pro > Ideal for businesses, it provides full control over data while ensuring scalable and reliable remote access. > > -- https://rustdesk.com/ +> +> This guide explains how to configure Rustdesk Server Pro to use authentik as the OAuth provider for logging in to the Web GUI. ## Preparation @@ -28,31 +30,30 @@ This documentation lists only the settings that you need to change from their de ## authentik configuration +[Create](https://docs.goauthentik.io/docs/add-secure-apps/applications/manage_apps#add-new-applications) an OAuth2/OpenID provider and an application in authentik. Use the following parameters for the OAuth2/OpenID provider: + 1. In the authentik Admin interface, navigate to **Applications** -> **Applications**. 2. Use the wizard to create a new application and provider. During this process: - Note the **Client ID**, **Client Secret**, and **slug** values for later use. - - Set the redirect URI to https://_rustdesk.company_/api/oidc/callback. + - Select implicit or explicit authorization flow as desired. + - Set the redirect URI to https://rustdesk.company/api/oidc/callback. - Select any available signing key. ## RustDesk Server Pro configuration 1. Sign in to RustDesk Server Pro using a browser. - 2. In the left menu, select **Settings** and then **OIDC**. - 3. Click **+ New Auth Provider**. - 4. In the popup window, select **custom** as the **Auth Type** and click **OK**. - 5. Configure the following values using information from the authentik provider: - - **Name**: _SSO-Login_ - - **Client ID**: _client-id_ - - **Client Secret**: _client-secret_ - - **Issuer**: https://_authentik.company_/application/o/_slug_/ - - **Authorization Endpoint**: https://_authentik.company_/application/o/authorize/ - - **Token Endpoint**: https://_authentik.company_/application/o/token/ - - **Userinfo Endpoint**: https://_authentik.company_/application/o/userinfo/ - - **JWKS Endpoint**: https://_authentik.company_/application/o/_slug_/jwks/ + - Set **Name** to `authentik` + - Set **Client ID** to the Client ID copied from authentik. + - Set **Client secret** to the Client Secret copied from authentik. + - Set **Issuer** to https://authentik.company/application/o/slug/ + - Set **Authorization Endpoint** to https://authentik.company/application/o/authorize/ + - Set **Token Endpoint** to https://authentik.company/application/o/token/ + - Set **Userinfo Endpoint** to https://authentik.company/application/o/userinfo/ + - Set **JWKS Endpoint** to https://authentik.company/application/o/slug/jwks/ :::info Users are created automatically on login. Permissions must be assigned by an administrator after user creation. @@ -60,7 +61,7 @@ Users are created automatically on login. Permissions must be assigned by an adm ## Test the Login -- Open a browser and navigate to https://_rustdesk.company_. -- Click **Continue with SSO-Login**. -- You should be redirected to authentik (with the login flows you configured). After logging in, authentik will redirect you back to https://_rustdesk.company_. -- If you are redirected back to https://_rustdesk.company_ and can read the username in the top right corner, the setup was successful. +- Open a browser and navigate to https://rustdesk.company. +- Click **Continue with authentik**. +- You should be redirected to authentik (with the login flows you configured). After logging in, authentik will redirect you back to https://rustdesk.company. +- If you are redirected back to https://rustdesk.company and can read the username in the top right corner, the setup was successful. diff --git a/website/integrations/services/semaphore/index.mdx b/website/integrations/services/semaphore/index.mdx index c43a21634f71..37ab8df3b22c 100644 --- a/website/integrations/services/semaphore/index.mdx +++ b/website/integrations/services/semaphore/index.mdx @@ -28,27 +28,14 @@ This documentation lists only the settings that you need to change from their de ## authentik configuration -Start the wizard for adding a new application. +[Create](https://docs.goauthentik.io/docs/add-secure-apps/applications/manage_apps#add-new-applications) an OAuth2/OpenID provider and an application in authentik. Use the following parameters for the OAuth2/OpenID provider: -**1. Application:** - -- Name: `Semaphore UI` -- Slug: `semaphore` - -**2. Choose a Provider** - -Select `OAuth2/OpenID Provider` - -**3. Configure Provider** - -Select implicit or explicit authorization flow as desired. - -Take note of the Client ID and Client Secret, you'll need to give them to Semaphore UI later. - -- Redirect URIs/Origins (RegEx): `https://semaphore.company/api/auth/oidc/authentik/redirect/` -- Signing Key: `authentik Self-signed Certificate` - -Leave the rest as default values. +1. In the authentik Admin interface, navigate to **Applications** -> **Applications**. +2. Use the wizard to create a new application and provider. During this process: + - Note the **Client ID**, **Client Secret**, and **slug** values for later use. + - Select implicit or explicit authorization flow as desired. + - Set the redirect URI to https://semaphore.company/api/auth/oidc/authentik/redirect/. + - Select any available signing key. ## Semaphore UI configuration @@ -60,7 +47,7 @@ Add the `oidc_providers` configuration: { "oidc_providers": { "authentik": { - "display_name": "Sign in with Authentik", + "display_name": "Sign in with authentik", "provider_url": "https://authentik.company/application/o//", "client_id": "", "client_secret": "", @@ -89,14 +76,12 @@ SEMAPHORE_WEB_ROOT: / More information on this can be found in the Semaphore documentation https://docs.semaphoreui.com/administration-guide/openid/authentik/. -Leave the rest as default. - ## Test the login -- Open a browser of your choice and open the URL `https://semaphore.company`. +- Open a browser of your choice and open the URL https://semaphore.company. - Click on the SSO-Login button. -- You should be redirected to authentik (with the login flows you created) and then authentik should redirect you back to `https://semaphore.company` URL. -- If you are redirected back to the `https://semaphore.company` URL you did everything correct. +- You should be redirected to authentik (with the login flows you created) and then authentik should redirect you back to https://semaphore.company URL. +- If you are redirected back to the https://semaphore.company URL you did everything correct. :::info Users are created upon logging in with authentik. They will not have the rights to create anything initially. These permissions must be assigned later by the local admin created during the first login to the Semaphore UI.