diff --git a/website/docs/core/terminology.md b/website/docs/core/terminology.md index 95e6c27a9..1ed5202f3 100644 --- a/website/docs/core/terminology.md +++ b/website/docs/core/terminology.md @@ -28,7 +28,7 @@ At a base level a policy is a yes/no gate. It will either evaluate to True or Fa See [Policies](./policies/) -### Stages & Stages +### Flows & Stages Flows are an ordered sequence of stages. These flows can be used to define how a user authenticates, enrolls, etc. diff --git a/website/docs/flow/index.md b/website/docs/flow/index.md index d5cad928f..83a6c4b40 100644 --- a/website/docs/flow/index.md +++ b/website/docs/flow/index.md @@ -36,16 +36,16 @@ This stage should always contain a [**User Logout**](stages/user_logout.md) stag ### Enrollment -This designates a flow for enrollment. This flow can contain any amount of verification stages, such as [**email**](stages/email/index.md) or [**captcha**](stages/captcha/index.md). At the end, to create the user, you can use the [**user_write**](stages/user_write.md) stage, which either updates the currently staged user, or if none exists, creates a new one. +This designates a flow for enrollment. This flow can contain any amount of verification stages, such as [**email**](stages/email/) or [**captcha**](stages/captcha/). At the end, to create the user, you can use the [**user_write**](stages/user_write.md) stage, which either updates the currently staged user, or if none exists, creates a new one. ### Unenrollment -This designates a flow for unenrollment. This flow can contain any amount of verification stages, such as [**email**](stages/email/index.md) or [**captcha**](stages/captcha/index.md). As a final stage, to delete the account, use the [**user_delete**](stages/user_delete.md) stage. +This designates a flow for unenrollment. This flow can contain any amount of verification stages, such as [**email**](stages/email/) or [**captcha**](stages/captcha/). As a final stage, to delete the account, use the [**user_delete**](stages/user_delete.md) stage. ### Recovery -This designates a flow for recovery. This flow normally contains an [**identification**](stages/identification/index.md) stage to find the user. It can also contain any amount of verification stages, such as [**email**](stages/email/index.md) or [**captcha**](stages/captcha/index.md). -Afterwards, use the [**prompt**](stages/prompt/index.md) stage to ask the user for a new password and the [**user_write**](stages/user_write.md) stage to update the password. +This designates a flow for recovery. This flow normally contains an [**identification**](stages/identification/) stage to find the user. It can also contain any amount of verification stages, such as [**email**](stages/email/) or [**captcha**](stages/captcha/). +Afterwards, use the [**prompt**](stages/prompt/) stage to ask the user for a new password and the [**user_write**](stages/user_write.md) stage to update the password. ### Setup diff --git a/website/docs/flow/stages/authenticator_validate/index.md b/website/docs/flow/stages/authenticator_validate/index.md index 034da1110..c710fe940 100644 --- a/website/docs/flow/stages/authenticator_validate/index.md +++ b/website/docs/flow/stages/authenticator_validate/index.md @@ -4,11 +4,11 @@ title: Authenticator Validation Stage This stage validates an already configured Authenticator Device. This device has to be configured using any of the other authenticator stages: -- [Duo authenticator stage](../authenticator_duo/index.md) -- [SMS authenticator stage](../authenticator_sms/index.md). -- [Static authenticator stage](../authenticator_static/index.md). -- [TOTP authenticator stage](../authenticator_totp/index.md) -- [WebAuth authenticator stage](../authenticator_webauthn/index.md). +- [Duo authenticator stage](../authenticator_duo/) +- [SMS authenticator stage](../authenticator_sms/). +- [Static authenticator stage](../authenticator_static/). +- [TOTP authenticator stage](../authenticator_totp/) +- [WebAuth authenticator stage](../authenticator_webauthn/). You can select which type of device classes are allowed. diff --git a/website/docs/flow/stages/invitation/index.md b/website/docs/flow/stages/invitation/index.md index a24bd4eb7..7080d04a7 100644 --- a/website/docs/flow/stages/invitation/index.md +++ b/website/docs/flow/stages/invitation/index.md @@ -10,4 +10,4 @@ To check if a user has used an invitation within a policy, you can check `reques To use an invitation, use the URL `https://authentik.tld/if/flow/your-enrollment-flow/?itoken=invitation-token`. -You can also prompt the user for an invite by using the [*Prompt stage*](../prompt/index.md) by using a field with a field key of `token`. +You can also prompt the user for an invite by using the [*Prompt stage*](../prompt/) by using a field with a field key of `token`. diff --git a/website/docs/installation/docker-compose.md b/website/docs/installation/docker-compose.md index c71681b71..a63c44af9 100644 --- a/website/docs/installation/docker-compose.md +++ b/website/docs/installation/docker-compose.md @@ -31,7 +31,7 @@ echo "AUTHENTIK_ERROR_REPORTING__ENABLED=true" >> .env ## Email configuration (optional, but recommended) -It is also recommended to configure global email credentials. These are used by authentik to notify you about alerts and configuration issues. They can also be used by [Email stages](flow/stages/email/index.md) to send verification/recovery emails. +It is also recommended to configure global email credentials. These are used by authentik to notify you about alerts and configuration issues. They can also be used by [Email stages](../flow/stages/email/) to send verification/recovery emails. Append this block to your `.env` file diff --git a/website/docs/installation/kubernetes.md b/website/docs/installation/kubernetes.md index c2998b863..225b1d60c 100644 --- a/website/docs/installation/kubernetes.md +++ b/website/docs/installation/kubernetes.md @@ -46,4 +46,4 @@ helm install authentik authentik/authentik -f values.yaml This installation automatically applies database migrations on startup. After the installation is done, navigate to the `https:///if/flow/initial-setup/`, to set a password for the akadmin user. -It is also recommended to configure global email credentials. These are used by authentik to notify you about alerts, configuration issues. They can also be used by [Email stages](flow/stages/email/index.md) to send verification/recovery emails. +It is also recommended to configure global email credentials. These are used by authentik to notify you about alerts, configuration issues. They can also be used by [Email stages](../flow/stages/email/) to send verification/recovery emails. diff --git a/website/docs/providers/oauth2.md b/website/docs/providers/oauth2.md index cf2dca183..465669acf 100644 --- a/website/docs/providers/oauth2.md +++ b/website/docs/providers/oauth2.md @@ -4,7 +4,7 @@ title: OAuth2 Provider This provider supports both generic OAuth2 as well as OpenID Connect -Scopes can be configured using Scope Mappings, a type of [Property Mappings](../property-mappings/index.md#scope-mapping). +Scopes can be configured using Scope Mappings, a type of [Property Mappings](../property-mappings/#scope-mapping). | Endpoint | URL | | -------------------- | -------------------------------------------------------------------- | diff --git a/website/docs/providers/saml.md b/website/docs/providers/saml.md index 99ffb1438..0d5351450 100644 --- a/website/docs/providers/saml.md +++ b/website/docs/providers/saml.md @@ -2,7 +2,7 @@ title: SAML Provider --- -This provider allows you to integrate enterprise software using the SAML2 Protocol. It supports signed requests and uses [Property Mappings](../property-mappings/index.md#saml-property-mapping) to determine which fields are exposed and what values they return. This makes it possible to expose vendor-specific fields. +This provider allows you to integrate enterprise software using the SAML2 Protocol. It supports signed requests and uses [Property Mappings](../property-mappings/#saml-property-mapping) to determine which fields are exposed and what values they return. This makes it possible to expose vendor-specific fields. Default fields are exposed through auto-generated Property Mappings, which are prefixed with "authentik default". | Endpoint | URL | diff --git a/website/docs/releases/v0.11.md b/website/docs/releases/v0.11.md index 1b13e4d20..0627d9f62 100644 --- a/website/docs/releases/v0.11.md +++ b/website/docs/releases/v0.11.md @@ -5,7 +5,7 @@ slug: "0.11" This update brings these headline features: -- Add Backup and Restore, currently only externally schedulable, documented [here](../maintenance/backups/index.md) +- Add Backup and Restore, currently only externally schedulable, documented [here](../maintenance/backups/) - New Admin Dashboard with more metrics and Charts Shows successful and failed logins from the last 24 hours, as well as the most used applications diff --git a/website/docs/releases/v2021.1.md b/website/docs/releases/v2021.1.md index 7061f9ba2..f9ad78941 100644 --- a/website/docs/releases/v2021.1.md +++ b/website/docs/releases/v2021.1.md @@ -8,7 +8,7 @@ slug: "2021.1" - New versioning schema (year.month.release) - Add global email settings - In previous versions, you had to configure email connection details per [Email Stage](../flow/stages/email/index.md). Now, you can (and should) configure global settings. + In previous versions, you had to configure email connection details per [Email Stage](../flow/stages/email/). Now, you can (and should) configure global settings. This is documented under the [docker-compose](../installation/docker-compose.md) and [Kubernetes](../installation/kubernetes.md) sections. diff --git a/website/docs/releases/v2021.2.md b/website/docs/releases/v2021.2.md index 5c6a158ca..8a7115bf3 100644 --- a/website/docs/releases/v2021.2.md +++ b/website/docs/releases/v2021.2.md @@ -116,11 +116,11 @@ Due to the switch to managed objects, some default property mappings are changin The change affects the "SAML Name" property, which has been changed from an oid to a Schema URI to aid readability. The integrations affected are: -- [Ansible Tower/AWX](/integrations/services/awx-tower/index) -- [GitLab](/integrations/services/gitlab/index) -- [NextCloud](/integrations/services/nextcloud/index) -- [Rancher](/integrations/services/rancher/index) -- [Sentry](/integrations/services/sentry/index) +- [Ansible Tower/AWX](/integrations/services/awx-tower/) +- [GitLab](/integrations/services/gitlab/) +- [NextCloud](/integrations/services/nextcloud/) +- [Rancher](/integrations/services/rancher/) +- [Sentry](/integrations/services/sentry/) ### docker-compose diff --git a/website/integrations/services/tautulli/index.md b/website/integrations/services/tautulli/index.md index ec26ab525..4c6f4ec68 100644 --- a/website/integrations/services/tautulli/index.md +++ b/website/integrations/services/tautulli/index.md @@ -50,4 +50,4 @@ In Tautulli, navigate to Settings and enable the "Show Advanced" option. Navigat Save the settings, and restart Tautulli if prompted. -Afterwards, you need to deploy an Outpost in front of Tautulli, as descried [here](../sonarr/index.md) +Afterwards, you need to deploy an Outpost in front of Tautulli, as descried [here](../sonarr/) diff --git a/website/src/pages/index.jsx b/website/src/pages/index.jsx index b4b61c1c1..8cc7fbe38 100644 --- a/website/src/pages/index.jsx +++ b/website/src/pages/index.jsx @@ -80,7 +80,7 @@ function Home() { "button button--outline button--secondary button--lg", styles.getStarted )} - to={useBaseUrl("docs/installation/index")} + to={useBaseUrl("docs/installation/")} > Get Started