From bb7338f5c1274473cab9300a98102ac6f8e94e2a Mon Sep 17 00:00:00 2001 From: Tana M Berry Date: Wed, 8 Jan 2025 18:34:44 -0600 Subject: [PATCH] website/docs: update customer portal (#12603) * add note about license to access Support center * more tweaks * polish --------- Co-authored-by: Tana M Berry --- website/docs/enterprise/entsupport.md | 6 ++++- website/docs/enterprise/get-started.md | 8 ++++-- website/docs/enterprise/index.md | 2 +- website/docs/enterprise/manage-enterprise.md | 28 +++++++++++--------- 4 files changed, 27 insertions(+), 17 deletions(-) diff --git a/website/docs/enterprise/entsupport.md b/website/docs/enterprise/entsupport.md index 42c1503188..cc53fab055 100644 --- a/website/docs/enterprise/entsupport.md +++ b/website/docs/enterprise/entsupport.md @@ -4,6 +4,10 @@ title: Support Enterprise authentik provides expert support, with a Support center where you can open a request and view the progress and communications for your current requests. +:::info +Only licensed instances of authentik can access the Support center. +::: + ### Managing tickets and requests To access the Support center, where you can open a request and view current requests, go to the Customer Portal and then click **Support** in the top menu. @@ -16,4 +20,4 @@ You can also always reach out to us via email, using hello@goauthentik.io email ### Product version support -We [support](../security/policy.mdx) the current, released version of authentik and one version back (including all major, minor, and patch versions). +We [support](../security/policy#supported-versions) the current, released version of authentik and one version back (including all major, minor, and patch versions). diff --git a/website/docs/enterprise/get-started.md b/website/docs/enterprise/get-started.md index ee7cea2a08..1e4bc2dd00 100644 --- a/website/docs/enterprise/get-started.md +++ b/website/docs/enterprise/get-started.md @@ -17,9 +17,9 @@ If this is a fresh install, refer to our [technical documentation](../install-co Access your Enterprise features by first [purchasing a license](./manage-enterprise.md#buy-a-license) for the organization. -To open the Customer portal and buy a license, go to the Admin interface and in the left pane, navigate to **Enterprise -> Licenses**, and then click **Go to Customer portal**. +To open the Customer Portal and buy a license, go to the Admin interface and in the left pane, navigate to **Enterprise -> Licenses**, and then click **Go to Customer Portal**. -The license key provides direct access to the Customer portal, where you define your organization and its members, manage billing, and access our Support center. +In the Customer Portal you define your organization and its members, manage your licenses and billing, and access our Support center. :::info A license is associated with a specific Organization in the customer portal and a specific authentik instance (with a unique Install ID), and not with individual users. A single license is purchased for a specified number of users. Additional users can be added to a license, or additional licenses purchased for the same instance, if more users need to be added later. @@ -29,4 +29,8 @@ A license is associated with a specific Organization in the customer portal and Enterprise authentik provides dedicated support, with a Support center where you can open a request and view the progress and communications for your current requests. +:::info +Access to the Support Center and the ticketing system requires a licensed instance of authentik. +::: + To learn about our Support center, see ["Enterprise support"](./entsupport.md). diff --git a/website/docs/enterprise/index.md b/website/docs/enterprise/index.md index 5d94b0be2f..7e94b39727 100644 --- a/website/docs/enterprise/index.md +++ b/website/docs/enterprise/index.md @@ -10,4 +10,4 @@ Refer to our Enterprise documentation for information about creating and managin - [Manage your Enterprise account](./manage-enterprise.md) - [Support for Enterprise accounts](./entsupport.md) -Our standard technical documentation covers how to configure, customize, and use authentik, whether the open source version that we have built our reputation on, or our Enterprise version with dedicated support. +Our standard technical documentation covers how to configure, customize, and use authentik, whether the open source version that we have built our reputation on or our Enterprise version with dedicated support. diff --git a/website/docs/enterprise/manage-enterprise.md b/website/docs/enterprise/manage-enterprise.md index 53d2af5ec4..8a02774019 100644 --- a/website/docs/enterprise/manage-enterprise.md +++ b/website/docs/enterprise/manage-enterprise.md @@ -8,7 +8,7 @@ Your organization defines the members, their roles, the licenses associated with ### Create an Organization -1. To create a new organization, log in to the [Customer portal](./get-started.md#access-enterprise). +1. To create a new organization, log in to the [Customer Portal](./get-started.md#access-enterprise). 2. On the **My organizations** page, click **Create an organization**. @@ -22,12 +22,12 @@ If you need to delete an organization open a ticket in the Support center. ### Add/remove members of an organization -In the Customer portal you can remove members and invite new members to the organization. When you invite new members, you can specify the role for the new member. +In the Customer Portal you can remove members and invite new members to the organization. When you invite new members, you can specify the role for the new member. - **Member**: can view licenses, including the license key. - **Owner**: can do everything the Member role can do, plus: add and remove members, order and renew licenses, and edit the organization. -1. To manage membership in an organization, log in to the [Customer portal](./get-started.md#access-enterprise). +1. To manage membership in an organization, log in to the [Customer Portal](./get-started.md#access-enterprise). 2. On the **My organizations** page, click the name of the organization you want to edit membership in. @@ -41,7 +41,7 @@ In the Customer portal you can remove members and invite new members to the orga ## License management -Note that a license is associated with a specific Organization in the customer portal and a specific authentik instance (with a unique Install ID), and not with individual users. A single license is purchased for a specified number of users. Additional users can be added to a license, or additional licenses purchased for the same instance, if more users need to be added later. +Note that a license is associated with a specific Organization in the Customer Portal and a specific authentik instance (with a unique Install ID), and not with individual users. A single license is purchased for a specified number of users. Additional users can be added to a license, or additional licenses purchased for the same instance, if more users need to be added later. ### Buy a license @@ -53,7 +53,7 @@ Note that a license is associated with a specific Organization in the customer p !["Admin interface licenses page"](./licenses-page-admin.png) -2. On the **Admin interface**, navigate to **Enterprise → Licenses** in the left menu, and then click **Go to Customer portal** under the **Get a license** section. +2. On the **Admin interface**, navigate to **Enterprise → Licenses** in the left menu, and then click **Go to Customer Portal** under the **Get a license** section. 3. In the Authentik login screen, sign up and then log in to the Customer Portal. @@ -74,7 +74,7 @@ Note that a license is associated with a specific Organization in the customer p When ready, the license displays on the organization's page. :::info -If you access the checkout page directly from the Customer portal, and not through the admin interface, you are prompted to provide the Install ID for your authentik installation. This ID can be found in the Admin interface on the **Licenses** page; click **Install** to view the **Install ID** number. +If you access the checkout page directly from the Customer Portal, and not through the admin interface, you are prompted to provide the Install ID for your authentik installation. This ID can be found in the Admin interface on the **Licenses** page; click **Install** to view the **Install ID** number. ::: 8. To retrieve your license key, click on **Details** beside the license name and copy the key to your clipboard. @@ -87,7 +87,11 @@ To verify that the license was successfully installed, confirm that the expriry ### How to view your license key -You can view the list of licenses that are applied to your organization on either the Admin interface, on the **Enterprise -> Licenses** page, or in the Customer portal, under your organization's page. +You can view the list of licenses that are applied to your organization on either the Admin interface, on the **Enterprise -> Licenses** page, or in the Customer Portal, under your organization's page. + +### Update your license + +If you purchase a new license, or receive a new one due to a change in the number of users, you will need to remove the old license and add the new one. To do so open the Admin interface, navigate to **Enterprise -> Licenses** page, click on **Install**, paste the new key, and then click **Install**. ### About the license expiry date @@ -97,11 +101,9 @@ The **Enterprise -> Licenses** page shows your current licenses' **Cumulative li The following events occur when a license expires or the internal/external user count is over the licensed user count for the time period below. -- After 2 weeks of the expiry date administrators see a warning banner on the Admin interface - -- After another 2 weeks, users get a warning banner - -- After another 2 weeks, the authentik Enterprise instance becomes "read-only" + - After 2 weeks of the expiry date administrators see a warning banner on the Admin interface + - After another 2 weeks, users get a warning banner + - After another 2 weeks, the authentik Enterprise instance becomes "read-only" When an authentik instance is in read-only mode, the following actions are still possible: @@ -129,7 +131,7 @@ The second way is to [open a support ticket](./entsupport.md) with us and we'll Billing is based on each individual organization. -1. To manage your billing, go to the Customer portal and click "My organizations" in the top menu bar. +1. To manage your billing, go to the Customer Portal and click "My organizations" in the top menu bar. 2. Select the organization for which you want to manage bulling.