From 33e3510fbaa1b9e2f7ee80f126a301035d81dffd Mon Sep 17 00:00:00 2001 From: Dewi Roberts Date: Fri, 9 May 2025 09:51:11 +0100 Subject: [PATCH] website/integrations: update integration template (#14432) * Updated indentation and service name formatting. * Angle brackets for mentions of service name * Update website/integrations/template/service.md Signed-off-by: Tana M Berry * Fixes issues with being read as a tag. * Update website/integrations/template/service.md Co-authored-by: Tana M Berry Signed-off-by: Dewi Roberts --------- Signed-off-by: Tana M Berry Signed-off-by: Dewi Roberts Co-authored-by: Tana M Berry --- website/integrations/template/service.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/website/integrations/template/service.md b/website/integrations/template/service.md index 298f2520f5..7ccbe3e36b 100644 --- a/website/integrations/template/service.md +++ b/website/integrations/template/service.md @@ -6,7 +6,7 @@ support_level: community ## What is Service-Name -> Insert a quick overview of what Service Name is and what it does. Simply describe the product and what it is, how it is used, and do not include marketing or sales-oriented content. +> Insert a quick overview of what `` is and what it does. Simply describe the product and what it is, how it is used, and do not include marketing or sales-oriented content. > > -- https://service.xyz @@ -14,7 +14,7 @@ support_level: community The following placeholders are used in this guide: -- `service.company` is the FQDN of the Service installation. (Remove this for SaaS) +- `service.company` is the FQDN of the `` installation. (Remove this for SaaS) - `authentik.company` is the FQDN of the authentik installation. :::note @@ -23,7 +23,7 @@ This documentation lists only the settings that you need to change from their de ## authentik configuration -To support the integration of _Service_ with authentik, you need to create an application/provider pair in authentik. +To support the integration of `` with authentik, you need to create an application/provider pair in authentik. _Any specific info about this integration can go here._ @@ -32,13 +32,12 @@ _Any specific info about this integration can go here._ 1. Log in to authentik as an admin, 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. - - _If there are any specific settings required, list them here. Refer to the [ownCloud integration documentation](https://github.com/goauthentik/authentik/blob/main/website/integrations/services/owncloud/index.md) for a complex requirements example._ -- **Choose a Provider type** - - _If there is a specific provider type required, state that here._ -- **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. - - _If there are any specific settings required, list them here. Refer to the [ownCloud integration documentation](https://github.com/goauthentik/authentik/blob/main/website/integrations/services/owncloud/index.md) for a complex requirements example._ -- **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. + - **Application**: provide a descriptive name, an optional group for the type of application, the policy engine mode, and optional UI settings. + - _If there are any specific settings required, list them here. Refer to the [ownCloud integration documentation](https://github.com/goauthentik/authentik/blob/main/website/integrations/services/owncloud/index.md) for a complex requirements example._ + - **Choose a Provider type**: _If there is a specific provider type required, state that here._ + - **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. + - _If there are any specific settings required, list them here. Refer to the [ownCloud integration documentation](https://github.com/goauthentik/authentik/blob/main/website/integrations/services/owncloud/index.md) for a complex requirements example._ + - **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. @@ -52,6 +51,6 @@ Insert Service configuration ## Configuration verification -Template sentence that you can typically use here: "To confirm that authentik is properly configured with _Service Name_, log out and log back in via authentik." +Template sentence that you can typically use here: "To confirm that authentik is properly configured with ``, log out and log back in via authentik." If there are more specific validation methods for the Service (e.g., clicking a button), include these instructions for clarity.