habsi/authentik
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source 
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 GitHub
parent 6d9579d3e6
commit e17f7020e6
6 changed files with 177 additions and 86 deletions
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.

72
website/sidebars.js
View File

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

147
website/sidebarsIntegrations.js
View File

@ -1,71 +1,121 @@
module.exports = {
integrations: [
{
type: "doc",
id: "index",
type: "category",
label: "Applications",
link: {
type: "generated-index",
title: "Applications",
slug: "/",
description: "Applications which integrate with authentik",
},
items: [
{
type: "category",
label: "Monitoring & Infarstructure",
items: [
{
type: "category",
label: "Hypervisors / Orchestrators",
items: [
"services/portainer/index",
"services/proxmox-ve/index",
"services/rancher/index",
"services/vmware-vcenter/index",
],
},
{
type: "category",
label: "Applications",
label: "Monitoring",
items: [
"services/apache-guacamole/index",
"services/aws/index",
"services/awx-tower/index",
"services/bookstack/index",
"services/budibase/index",
"services/fortimanager/index",
"services/gitea/index",
"services/gitlab/index",
"services/grafana/index",
"services/harbor/index",
"services/hashicorp-vault/index",
"services/hedgedoc/index",
"services/home-assistant/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/sssd/index",
"services/tautulli/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/vmware-vcenter/index",
"services/weblate/index",
"services/wekan/index",
"services/wiki-js/index",
"services/wordpress/index",
"services/zabbix/index",
"services/zulip/index",
],
},
{
type: "category",
label: "Federation & Social login",
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/kimai/index",
"services/sonarr/index",
"services/tautulli/index",
],
},
{
type: "category",
label: "Federation & Social login",
link: {
type: "generated-index",
title: "Sources",
slug: "sources",
description:
"Sources of users which can be federated with authentik",
},
items: [
"sources/general",
{
type: "category",
label: "Social Logins",
items: [
"sources/index",
"sources/active-directory/index",
"sources/apple/index",
"sources/azure-ad/index",
"sources/discord/index",
"sources/freeipa/index",
"sources/github/index",
"sources/google/index",
"sources/ldap/index",
"sources/mailcow/index",
"sources/oauth/index",
"sources/plex/index",
@ -73,5 +123,16 @@ module.exports = {
"sources/twitter/index",
],
},
{
type: "category",
label: "Directory syncronization",
items: [
"sources/active-directory/index",
"sources/freeipa/index",
"sources/ldap/index",
],
},
],
},
],
};