From cfc065b41bb472916fa0231ab1fc4c08390b585f Mon Sep 17 00:00:00 2001 From: Tana M Berry Date: Tue, 12 Mar 2024 10:36:30 -0500 Subject: [PATCH] website/docs: new landing page for Providers (#8879) * stub file * draft content * edit sidebar * info re metadata SAML * fix links * polish --------- Co-authored-by: Tana M Berry --- website/docs/outposts/index.mdx | 4 ++-- website/docs/policies/index.md | 2 +- website/docs/providers/index.md | 24 ++++++++++++++++++++++++ website/sidebars.js | 4 ++++ 4 files changed, 31 insertions(+), 3 deletions(-) create mode 100644 website/docs/providers/index.md diff --git a/website/docs/outposts/index.mdx b/website/docs/outposts/index.mdx index b5ffe1c254..a0cc412560 100644 --- a/website/docs/outposts/index.mdx +++ b/website/docs/outposts/index.mdx @@ -1,5 +1,5 @@ --- -title: Overview +title: Outposts --- An outpost is a single deployment of an authentik component, which can be deployed in a completely separate environment: @@ -15,7 +15,7 @@ Upon creation, a service account and a token is generated. The service account o authentik can manage the deployment, updating and general lifecycle of an Outpost. To communicate with the underlying platforms on which the outpost is deployed, authentik has several built-in integrations. -- If you've deployed authentik on docker-compose, authentik automatically creates an integration for the local docker socket (See [Docker](./integrations/docker.md)). +- If you've deployed authentik on Docker Compose, authentik automatically creates an integration for the local docker socket (See [Docker](./integrations/docker.md)). - If you've deployed authentik on Kubernetes, with `kubernetesIntegration` set to true (default), authentik automatically creates an integrations for the local Kubernetes Cluster (See [Kubernetes](./integrations/kubernetes.md)). To deploy an outpost with these integrations, simply select them during the creation of an Outpost. A background task is started, which creates the container/deployment. You can see that Status on the System Tasks page. diff --git a/website/docs/policies/index.md b/website/docs/policies/index.md index 25bb7f36a6..502a1e1114 100644 --- a/website/docs/policies/index.md +++ b/website/docs/policies/index.md @@ -1,5 +1,5 @@ --- -title: Overview +title: Policies --- ## Event-matcher policy diff --git a/website/docs/providers/index.md b/website/docs/providers/index.md new file mode 100644 index 0000000000..4ca6e45aa0 --- /dev/null +++ b/website/docs/providers/index.md @@ -0,0 +1,24 @@ +--- +title: Providers +slug: /providers +--- + +A Provider is an authentication method, a service that is used by authentik to authenticate the user for the associated application. Common Providers are OpenID Connect (OIDC)/OAuth2, LDAP, SAML, and generic proxy provider, and others. + +Providers are the "other half" of [applications](../applications/index.md). They typically exist in a 1-to-1 relationship; each application needs a provider and every provider can be used with one application. + +Applications can use additional providers to augment the functionality of the main provider. For more information, see [Backchannel providers](../applications/manage_apps.md#backchannel-providers). + +You can create a new provider in the Admin interface, or you can use the [Application wizard](../applications/manage_apps.md#instructions) to create a new application and its provider at the same time. + +Refer to the documentation for each provider: + +- [LDAP](./ldap/index.md) +- [OAuth2/OpenID](./oauth2/index.md) +- [Proxy provider](./proxy/index.md) +- [RAC (Remote Access Control)](./rac/index.md) +- [Radius](./radius/index.md) +- [SAML](./saml/index.md) +- [SCIM](./scim/index.md) + +You can also create a SAML provider by uploading an SP metadata XML file that contains the service provider's configuration data. SAML metadata is used to share configuration information between the Identity Provider (IdP) and the Service Provider (SP). An SP metadata XML file typically contains the SP certificate, the entity ID, the Assertion Consumer Service URL (ACS URL), and a log out URL (SingleLogoutService). diff --git a/website/sidebars.js b/website/sidebars.js index 44ef192a17..9f1babaf02 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -68,6 +68,10 @@ const docsSidebar = { { type: "category", label: "Providers", + link: { + type: "doc", + id: "providers/index", + }, items: [ { type: "category",