From a010c91a5262342d728a3a91e9faec4509a06091 Mon Sep 17 00:00:00 2001 From: Jens Langhammer Date: Mon, 13 Dec 2021 11:56:26 +0100 Subject: [PATCH] website/docs: update references for new docusaurus version Signed-off-by: Jens Langhammer --- website/docs/core/terminology.md | 8 ++++---- website/docs/flow/{flows.md => index.md} | 0 website/docs/outposts/{outposts.md => index.md} | 0 website/docs/providers/ldap.md | 4 ++-- website/docs/releases/v0.10.md | 2 +- website/integrations/services/home-assistant/index.md | 2 +- website/integrations/services/sonarr/index.md | 2 +- website/integrations/services/sssd/index.md | 2 +- website/integrations/sources/apple/index.md | 2 +- website/integrations/sources/azure-ad/index.md | 2 +- website/integrations/sources/discord/index.md | 2 +- website/integrations/sources/github/index.md | 2 +- website/integrations/sources/google/index.md | 2 +- website/integrations/sources/ldap/index.md | 6 +++--- website/sidebars.js | 4 ++-- 15 files changed, 20 insertions(+), 20 deletions(-) rename website/docs/flow/{flows.md => index.md} (100%) rename website/docs/outposts/{outposts.md => index.md} (100%) diff --git a/website/docs/core/terminology.md b/website/docs/core/terminology.md index b8569b8a6..95e6c27a9 100644 --- a/website/docs/core/terminology.md +++ b/website/docs/core/terminology.md @@ -26,7 +26,7 @@ A Provider is a way for other applications to authenticate against authentik. Co At a base level a policy is a yes/no gate. It will either evaluate to True or False depending on the Policy Kind and settings. For example, a "Group Membership Policy" evaluates to True if the user is member of the specified Group and False if not. This can be used to conditionally apply Stages, grant/deny access to various objects, and for other custom logic. -See [Policies](./policies/index.md) +See [Policies](./policies/) ### Stages & Stages @@ -34,13 +34,13 @@ Flows are an ordered sequence of stages. These flows can be used to define how a A stage represents a single verification or logic step. They are used to authenticate users, enroll users, and more. These stages can optionally be applied to a flow via policies. -See [Flows](./flow/flows.md) +See [Flows](./flow/) ### Property Mappings Property Mappings allow you to make information available for external applications. For example, if you want to login to AWS with authentik, you'd use Property Mappings to set the user's roles in AWS based on their group memberships in authentik. -See [Property Mappings](./property-mappings/index.md) +See [Property Mappings](./property-mappings/) ### Outpost @@ -48,4 +48,4 @@ An outpost is a separate component of authentik, which can be deployed anywhere, Currently there is only a reverse-proxy outpost, in the future there will be more different outpost types. -See [Outposts](./outposts/outposts.md) +See [Outposts](./outposts/) diff --git a/website/docs/flow/flows.md b/website/docs/flow/index.md similarity index 100% rename from website/docs/flow/flows.md rename to website/docs/flow/index.md diff --git a/website/docs/outposts/outposts.md b/website/docs/outposts/index.md similarity index 100% rename from website/docs/outposts/outposts.md rename to website/docs/outposts/index.md diff --git a/website/docs/providers/ldap.md b/website/docs/providers/ldap.md index 5cfdd0897..94e738eaf 100644 --- a/website/docs/providers/ldap.md +++ b/website/docs/providers/ldap.md @@ -9,7 +9,7 @@ This feature is still in technical preview, so please report any Bugs you run in You can configure an LDAP Provider for applications that don't support any newer protocols or require LDAP. :::info -Note: This provider requires the deployment of the [LDAP Outpost](../outposts/outposts.md) +Note: This provider requires the deployment of the [LDAP Outpost](../outposts/) ::: All users and groups in authentik's database are searchable. Currently, there is limited support for filters (you can only search for objectClass), but this will be expanded in further releases. @@ -76,5 +76,5 @@ This enables you to bind on port 636 using LDAPS, StartTLS is not supported. ## Integrations -See the integration guide for [sssd](../../integrations/services/sssd/index) for +See the integration guide for [sssd](../../integrations/services/sssd/) for an example guide. diff --git a/website/docs/releases/v0.10.md b/website/docs/releases/v0.10.md index 4ba536734..996a1683b 100644 --- a/website/docs/releases/v0.10.md +++ b/website/docs/releases/v0.10.md @@ -19,7 +19,7 @@ This update brings a lot of big features, such as: This is a new Object type, currently used only by the Proxy Provider. It manages the creation and permissions of service accounts, which are used by the outposts to communicate with authentik. - See [Outposts](../outposts/outposts.md) + See [Outposts](../outposts/) - Flow Import/Export diff --git a/website/integrations/services/home-assistant/index.md b/website/integrations/services/home-assistant/index.md index a245f6fdb..68af89647 100644 --- a/website/integrations/services/home-assistant/index.md +++ b/website/integrations/services/home-assistant/index.md @@ -60,6 +60,6 @@ Create an application in authentik and select the provider you've created above. ## Deployment -Create an outpost deployment for the provider you've created above, as described [here](../../../docs/outposts/outposts). Deploy this Outpost either on the same host or a different host that can access Home-Assistant. +Create an outpost deployment for the provider you've created above, as described [here](../../../docs/outposts/). Deploy this Outpost either on the same host or a different host that can access Home-Assistant. The outpost will connect to authentik and configure itself. diff --git a/website/integrations/services/sonarr/index.md b/website/integrations/services/sonarr/index.md index 81ab9afe3..3afc3e1ea 100644 --- a/website/integrations/services/sonarr/index.md +++ b/website/integrations/services/sonarr/index.md @@ -37,6 +37,6 @@ Create an application in authentik and select the provider you've created above. ## Deployment -Create an outpost deployment for the provider you've created above, as described [here](../../../docs/outposts/outposts). Deploy this Outpost either on the same host or a different host that can access Sonarr. +Create an outpost deployment for the provider you've created above, as described [here](../../../docs/outposts/). Deploy this Outpost either on the same host or a different host that can access Sonarr. The outpost will connect to authentik and configure itself. diff --git a/website/integrations/services/sssd/index.md b/website/integrations/services/sssd/index.md index 7e4221890..4fb1baa6f 100644 --- a/website/integrations/services/sssd/index.md +++ b/website/integrations/services/sssd/index.md @@ -50,7 +50,7 @@ to `ldap.searchGroup`. ## Deployment -Create an outpost deployment for the provider you've created above, as described [here](../../../docs/outposts/outposts). Deploy this Outpost either on the same host or a different host that your +Create an outpost deployment for the provider you've created above, as described [here](../../../docs/outposts/). Deploy this Outpost either on the same host or a different host that your host(s) running sssd can access. The outpost will connect to authentik and configure itself. diff --git a/website/integrations/sources/apple/index.md b/website/integrations/sources/apple/index.md index 4e0e3ff3f..4950d5225 100644 --- a/website/integrations/sources/apple/index.md +++ b/website/integrations/sources/apple/index.md @@ -63,5 +63,5 @@ The following placeholders will be used: Save, and you now have Apple as a source. :::note -For more details on how-to have the new source display on the Login Page see [here](../index). +For more details on how-to have the new source display on the Login Page see [here](../). ::: diff --git a/website/integrations/sources/azure-ad/index.md b/website/integrations/sources/azure-ad/index.md index d9942b2bb..2a0b4db84 100644 --- a/website/integrations/sources/azure-ad/index.md +++ b/website/integrations/sources/azure-ad/index.md @@ -44,5 +44,5 @@ If you kept the default *Supported account types* selection of *Single tenant*, Save, and you now have Azure AD as a source. :::note -For more details on how-to have the new source display on the Login Page see [here](../index). +For more details on how-to have the new source display on the Login Page see [here](../). ::: diff --git a/website/integrations/sources/discord/index.md b/website/integrations/sources/discord/index.md index bd243417b..8cc550cd1 100644 --- a/website/integrations/sources/discord/index.md +++ b/website/integrations/sources/discord/index.md @@ -50,5 +50,5 @@ Here is an example of a complete authentik Discord OAuth Source Save, and you now have Discord as a source. :::note -For more details on how-to have the new source display on the Login Page see [here](../index). +For more details on how-to have the new source display on the Login Page see [here](../). ::: diff --git a/website/integrations/sources/github/index.md b/website/integrations/sources/github/index.md index 953d03411..0e5e84bab 100644 --- a/website/integrations/sources/github/index.md +++ b/website/integrations/sources/github/index.md @@ -56,5 +56,5 @@ Here is an example of a complete authentik Github OAuth Source Save, and you now have Github as a source. :::note -For more details on how-to have the new source display on the Login Page see [here](../index). +For more details on how-to have the new source display on the Login Page see [here](../). ::: diff --git a/website/integrations/sources/google/index.md b/website/integrations/sources/google/index.md index 156c99236..dc752ddbc 100644 --- a/website/integrations/sources/google/index.md +++ b/website/integrations/sources/google/index.md @@ -79,5 +79,5 @@ Here is an example of a complete authentik Google OAuth Source Save, and you now have Google as a source. :::note -For more details on how-to have the new source display on the Login Page see [here](../index). +For more details on how-to have the new source display on the Login Page see [here](../). ::: diff --git a/website/integrations/sources/ldap/index.md b/website/integrations/sources/ldap/index.md index d373af381..c0129b24d 100644 --- a/website/integrations/sources/ldap/index.md +++ b/website/integrations/sources/ldap/index.md @@ -9,9 +9,9 @@ Sources allow you to connect authentik to an existing user directory. They can a This source allows you to import users and groups from an LDAP Server. :::info -For Active Directory, follow the [Active Directory Integration](../active-directory/index.md) +For Active Directory, follow the [Active Directory Integration](../active-directory/) -For FreeIPA, follow the [FreeIPA Integration](../freeipa/index.md) +For FreeIPA, follow the [FreeIPA Integration](../freeipa/) ::: - Server URI: URI to your LDAP server/Domain Controller. @@ -32,4 +32,4 @@ For FreeIPA, follow the [FreeIPA Integration](../freeipa/index.md) - Object uniqueness field: This field contains a unique identifier. - Sync groups: Enable/disable group synchronization. Groups are synced in the background every 5 minutes. - Sync parent group: Optionally set this group as the parent group for all synced groups. An example use case of this would be to import Active Directory groups under a root `imported-from-ad` group. -- Property mappings: Define which LDAP properties map to which authentik properties. The default set of property mappings is generated for Active Directory. See also [LDAP Property Mappings](../../../docs/property-mappings/index#ldap-property-mapping) +- Property mappings: Define which LDAP properties map to which authentik properties. The default set of property mappings is generated for Active Directory. See also [LDAP Property Mappings](../../../docs/property-mappings/#ldap-property-mapping) diff --git a/website/sidebars.js b/website/sidebars.js index 7d6b9fd0d..9fd588767 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -51,7 +51,7 @@ module.exports = { type: "category", label: "Outposts", items: [ - "outposts/outposts", + "outposts/index", "outposts/embedded/embedded", { type: "category", @@ -75,7 +75,7 @@ module.exports = { { type: "category", label: "Flows", - items: ["flow/flows", "flow/examples"], + items: ["flow/index", "flow/examples"], }, { type: "category",