trustchain-oc1-orchestral
/
authentik
Archived
10
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

webiste/docs: use autogenerated pages and categories (#3102) 

Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
This commit is contained in:
Jens L 2022-06-15 20:56:27 +02:00 committed by Jens Langhammer
parent b33bff92ee
commit 440cacbafe
6 changed files with 177 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
website/docs/installation/index.md
View File

@ -1,7 +0,0 @@
---
title: Installation
---
If you want to try out authentik, or only want a small deployment you should use [docker-compose](./docker-compose).
If you want a larger deployment, or you want High-Availability, you should use [Kubernetes](./kubernetes).

0
website/docs/providers/proxy/proxy.md → website/docs/providers/proxy/index.md
View File

6
website/integrations/index.md
View File

@ -1,6 +0,0 @@
---
title: Integrations
slug: /
---
Here you can find a full list of applications that have been documented to work with authentik. If you find any mistake or a step does not work for you, open a GitHub issue [here](https://github.com/goauthentik/authentik/issues/new/choose).

3
website/integrations/sources/index.md → website/integrations/sources/general.md
View File

@ -1,5 +1,6 @@
--- ---
title: Overview title: General
slug: general
--- ---
Sources allow you to connect authentik to an existing user directory. They can also be used for social logins, using external providers such as Facebook, Twitter, etc. Sources allow you to connect authentik to an existing user directory. They can also be used for social logins, using external providers such as Facebook, Twitter, etc.

72
website/sidebars.js
View File

@ -7,8 +7,14 @@ module.exports = {
{ {
type: "category", type: "category",
label: "Installation", label: "Installation",
link: {
type: "generated-index",
title: "Installation",
slug: "installation",
description:
"Everything you need to get authentik up and running!",
},
items: [ items: [
"installation/index",
"installation/docker-compose", "installation/docker-compose",
"installation/kubernetes", "installation/kubernetes",
"installation/beta", "installation/beta",
@ -36,17 +42,21 @@ module.exports = {
{ {
type: "category", type: "category",
label: "OAuth2 Provider", label: "OAuth2 Provider",
items: [ link: {
"providers/oauth2/index", type: "doc",
"providers/oauth2/client_credentials", id: "providers/oauth2/index",
], },
items: ["providers/oauth2/client_credentials"],
}, },
"providers/saml", "providers/saml",
{ {
type: "category", type: "category",
label: "Proxy Provider", label: "Proxy Provider",
link: {
type: "doc",
id: "providers/proxy/index",
},
items: [ items: [
"providers/proxy/proxy",
"providers/proxy/custom_headers", "providers/proxy/custom_headers",
"providers/proxy/forward_auth", "providers/proxy/forward_auth",
], ],
@ -57,8 +67,11 @@ module.exports = {
{ {
type: "category", type: "category",
label: "Outposts", label: "Outposts",
link: {
type: "doc",
id: "outposts/index",
},
items: [ items: [
"outposts/index",
"outposts/embedded/embedded", "outposts/embedded/embedded",
{ {
type: "category", type: "category",
@ -82,8 +95,11 @@ module.exports = {
{ {
type: "category", type: "category",
label: "Flows", label: "Flows",
link: {
type: "doc",
id: "flow/index",
},
items: [ items: [
"flow/index",
"flow/layouts", "flow/layouts",
"flow/inspector", "flow/inspector",
"flow/examples", "flow/examples",
@ -101,6 +117,12 @@ module.exports = {
{ {
type: "category", type: "category",
label: "Stages", label: "Stages",
link: {
type: "generated-index",
title: "Stages",
slug: "flow/stages",
description: "Overview of all available stages",
},
items: [ items: [
"flow/stages/authenticator_duo/index", "flow/stages/authenticator_duo/index",
"flow/stages/authenticator_sms/index", "flow/stages/authenticator_sms/index",
@ -124,21 +146,29 @@ module.exports = {
{ {
type: "category", type: "category",
label: "Policies", label: "Policies",
items: ["policies/index", "policies/expression"], link: {
type: "doc",
id: "policies/index",
},
items: ["policies/expression"],
}, },
{ {
type: "category", type: "category",
label: "Property Mappings", label: "Property Mappings",
items: ["property-mappings/index", "property-mappings/expression"], link: {
type: "doc",
id: "property-mappings/index",
},
items: ["property-mappings/expression"],
}, },
{ {
type: "category", type: "category",
label: "Events", label: "Events",
items: [ link: {
"events/index", type: "doc",
"events/notifications", id: "events/index",
"events/transports", },
], items: ["events/notifications", "events/transports"],
}, },
{ {
type: "category", type: "category",
@ -164,6 +194,12 @@ module.exports = {
{ {
type: "category", type: "category",
label: "Release Notes", label: "Release Notes",
link: {
type: "generated-index",
title: "Releases",
slug: "releases",
description: "Release notes for recent authentik versions",
},
items: [ items: [
"releases/v2022.6", "releases/v2022.6",
"releases/v2022.5", "releases/v2022.5",
@ -198,6 +234,12 @@ module.exports = {
{ {
type: "category", type: "category",
label: "Troubleshooting", label: "Troubleshooting",
link: {
type: "generated-index",
title: "Troubleshooting",
slug: "troubleshooting",
description: "Troubleshooting various issues",
},
items: [ items: [
"troubleshooting/access", "troubleshooting/access",
"troubleshooting/emails", "troubleshooting/emails",

175
website/sidebarsIntegrations.js
View File

@ -1,76 +1,137 @@
module.exports = { module.exports = {
integrations: [ integrations: [
{
type: "doc",
id: "index",
},
{ {
type: "category", type: "category",
label: "Applications", label: "Applications",
link: {
type: "generated-index",
title: "Applications",
slug: "/",
description: "Applications which integrate with authentik",
},
items: [ items: [
"services/apache-guacamole/index", {
"services/aws/index", type: "category",
"services/awx-tower/index", label: "Monitoring & Infarstructure",
"services/bookstack/index", items: [
"services/budibase/index", {
"services/fortimanager/index", type: "category",
"services/gitea/index", label: "Hypervisors / Orchestrators",
"services/gitlab/index", items: [
"services/grafana/index", "services/portainer/index",
"services/harbor/index", "services/proxmox-ve/index",
"services/hashicorp-vault/index", "services/rancher/index",
"services/hedgedoc/index", "services/vmware-vcenter/index",
],
},
{
type: "category",
label: "Monitoring",
items: [
"services/grafana/index",
"services/ubuntu-landscape/index",
"services/uptime-kuma/index",
"services/zabbix/index",
],
},
"services/apache-guacamole/index",
"services/awx-tower/index",
"services/fortimanager/index",
"services/harbor/index",
"services/hashicorp-vault/index",
"services/minio/index",
"services/opnsense/index",
"services/pfsense/index",
"services/pgadmin/index",
"services/powerdns-admin/index",
"services/veeam-enterprise-manager/index",
],
},
{
type: "category",
label: "Cloud Providers",
items: ["services/aws/index"],
},
{
type: "category",
label: "Chat, Communication & Collaboration",
items: [
"services/bookstack/index",
"services/hedgedoc/index",
"services/matrix-synapse/index",
"services/nextcloud/index",
"services/onlyoffice/index",
"services/paperless-ng/index",
"services/rocketchat/index",
"services/roundcube/index",
"services/vikunja/index",
"services/wekan/index",
"services/wiki-js/index",
"services/zulip/index",
],
},
{
type: "category",
label: "Platforms",
items: [
"services/budibase/index",
"services/wordpress/index",
],
},
{
type: "category",
label: "Developer tools",
items: [
"services/gitea/index",
"services/gitlab/index",
"services/sentry/index",
"services/sssd/index",
"services/weblate/index",
],
},
"services/home-assistant/index", "services/home-assistant/index",
"services/kimai/index", "services/kimai/index",
"services/matrix-synapse/index",
"services/minio/index",
"services/nextcloud/index",
"services/onlyoffice/index",
"services/opnsense/index",
"services/paperless-ng/index",
"services/pfsense/index",
"services/pgadmin/index",
"services/portainer/index",
"services/powerdns-admin/index",
"services/proxmox-ve/index",
"services/rancher/index",
"services/rocketchat/index",
"services/roundcube/index",
"services/sentry/index",
"services/sonarr/index", "services/sonarr/index",
"services/sssd/index",
"services/tautulli/index", "services/tautulli/index",
"services/ubuntu-landscape/index",
"services/uptime-kuma/index",
"services/veeam-enterprise-manager/index",
"services/vikunja/index",
"services/vmware-vcenter/index",
"services/weblate/index",
"services/wekan/index",
"services/wiki-js/index",
"services/wordpress/index",
"services/zabbix/index",
"services/zulip/index",
], ],
}, },
{ {
type: "category", type: "category",
label: "Federation & Social login", label: "Federation & Social login",
link: {
type: "generated-index",
title: "Sources",
slug: "sources",
description:
"Sources of users which can be federated with authentik",
},
items: [ items: [
"sources/index", "sources/general",
"sources/active-directory/index", {
"sources/apple/index", type: "category",
"sources/azure-ad/index", label: "Social Logins",
"sources/discord/index", items: [
"sources/freeipa/index", "sources/apple/index",
"sources/github/index", "sources/azure-ad/index",
"sources/google/index", "sources/discord/index",
"sources/ldap/index", "sources/github/index",
"sources/mailcow/index", "sources/google/index",
"sources/oauth/index", "sources/mailcow/index",
"sources/plex/index", "sources/oauth/index",
"sources/saml/index", "sources/plex/index",
"sources/twitter/index", "sources/saml/index",
"sources/twitter/index",
],
},
{
type: "category",
label: "Directory syncronization",
items: [
"sources/active-directory/index",
"sources/freeipa/index",
"sources/ldap/index",
],
},
], ],
}, },
], ],