From 270c9661a14a1bac7f831edb5f8be5733e4d550e Mon Sep 17 00:00:00 2001 From: NiceDevil <17103076+nicedevil007@users.noreply.github.com> Date: Sun, 28 Jul 2024 22:40:50 +0200 Subject: [PATCH] website/integrations: add engomo (#10538) * First try on documentation for engomo :) Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * index.md aktualisieren Co-authored-by: Tana M Berry Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * index.md aktualisieren Co-authored-by: Tana M Berry Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * index.md aktualisieren Co-authored-by: Tana M Berry Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * index.md aktualisieren Co-authored-by: Tana M Berry Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * index.md aktualisieren Co-authored-by: Tana M Berry Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * index.md aktualisieren Co-authored-by: Tana M Berry Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * index.md aktualisieren Co-authored-by: Tana M Berry Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * index.md aktualisieren Co-authored-by: Tana M Berry Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * index.md aktualisieren Co-authored-by: Tana M Berry Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * index.md aktualisieren Co-authored-by: Tana M Berry Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * index.md aktualisieren Co-authored-by: Tana M Berry Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * index.md aktualisieren Co-authored-by: Tana M Berry Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * index.md aktualisieren Co-authored-by: Tana M Berry Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * index.md aktualisieren Co-authored-by: Tana M Berry Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * index.md aktualisieren Co-authored-by: Tana M Berry Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * index.md aktualisieren Co-authored-by: Tana M Berry Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * Update index.md Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * condensed scopes and redirect URIs ty @4d62 Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * testing added Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * added engomo Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * test with prettier? * Revert "test with prettier?" This reverts commit 44c2eb33cd58bb5d6b1cb158a304530da672fe87. * index.md aktualisieren Co-authored-by: Tana M Berry Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * index.md aktualisieren Co-authored-by: Tana M Berry Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * Update website/integrations/services/engomo/index.md Co-authored-by: 4d62 Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * Update website/integrations/services/engomo/index.md Co-authored-by: 4d62 Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * Update website/integrations/services/engomo/index.md Co-authored-by: 4d62 Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * Update website/integrations/services/engomo/index.md Co-authored-by: 4d62 Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * Update website/integrations/services/engomo/index.md Co-authored-by: 4d62 Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * Update website/integrations/services/engomo/index.md Co-authored-by: 4d62 Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * Update website/integrations/services/engomo/index.md Co-authored-by: 4d62 Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * Update website/integrations/services/engomo/index.md Co-authored-by: 4d62 Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * tanberry's descriptions added :) Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * engomo is always lower case Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * suggestions from @4d62 Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * bold headings Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * Update website/integrations/services/engomo/index.md Co-authored-by: 4d62 Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> * p --------- Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com> Co-authored-by: Tana M Berry Co-authored-by: 4d62 Co-authored-by: root --- website/integrations/services/engomo/index.md | 88 +++++++++++++++++++ website/sidebarsIntegrations.js | 1 + 2 files changed, 89 insertions(+) create mode 100644 website/integrations/services/engomo/index.md diff --git a/website/integrations/services/engomo/index.md b/website/integrations/services/engomo/index.md new file mode 100644 index 0000000000..19537a06e9 --- /dev/null +++ b/website/integrations/services/engomo/index.md @@ -0,0 +1,88 @@ +--- +title: 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 will be used: + +- `engomo.company` is the FQDN of the engomo install. +- `authentik.company` is the FQDN of the authentik install. +- `engomo.mapping` is the name of the Scope Mapping. +- `ak.cert` is the self-signed certificate that will be used for the service provider. + +## 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/sidebarsIntegrations.js b/website/sidebarsIntegrations.js index f416771437..b6be696716 100644 --- a/website/sidebarsIntegrations.js +++ b/website/sidebarsIntegrations.js @@ -118,6 +118,7 @@ module.exports = { type: "category", label: "Miscellaneous", items: [ + "services/engomo/index", "services/freshrss/index", "services/gravitee/index", "services/home-assistant/index",