website/docs: support levels (#3103)
* website/docs: add badges for integration level Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * add badge for sources Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
This commit is contained in:
Jens L
Jens Langhammer
parent
440cacbafe
commit
4b7c3c38cd
|
|
@ -43,6 +43,8 @@ If you find any documentation that doesn't match these guidelines, feel free to
|
|||
|
||||
These guidelines apply in addition to the ones above.
|
||||
|
||||
See the template in `/website/integrations/_template/service.md`.
|
||||
|
||||
- For placeholders, use angle brackets (`<placeholder-name>`).
|
||||
|
||||
Make sure to also define if the placeholder is something the user needs to define, something another system defines, or randomly generated.
|
||||
|
|
@ -52,3 +54,5 @@ These guidelines apply in addition to the ones above.
|
|||
|
||||
- For placeholder domains, use `authentik.company` and `app-name.company`, where `app-name` is the name of the application you are writing documentation for.
|
||||
- Try to order the documentation in the order that makes it easiest for the user to configure.
|
||||
|
||||
- Make sure to add the service to a fitting category in `/website/sidebarsIntegrations.js`
|
||||
|
|
|
|||
28
website/integrations/_template/service.md
Normal file
28
website/integrations/_template/service.md
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
---
|
||||
title: Service Name
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Service Name
|
||||
|
||||
From https://service.name
|
||||
|
||||
:::note
|
||||
Insert a quick overview of what Service Name is and what it does
|
||||
:::
|
||||
|
||||
## Preparation
|
||||
|
||||
The following placeholders will be used:
|
||||
|
||||
- `service.company` is the FQDN of the Service install. (Remove this for SaaS)
|
||||
- `authentik.company` is the FQDN of the authentik install.
|
||||
|
||||
## Service Configuration
|
||||
|
||||
Insert Service configuration
|
||||
|
||||
## authentik Configuration
|
||||
|
||||
Insert authentik configuration
|
||||
|
|
@ -2,6 +2,8 @@
|
|||
title: Apache Guacamole™
|
||||
---
|
||||
|
||||
<span class="badge badge--primary">Support level: authentik</span>
|
||||
|
||||
## What is Apache Guacamole™
|
||||
|
||||
From https://guacamole.apache.org/
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Amazon Web Services
|
||||
---
|
||||
|
||||
<span class="badge badge--primary">Support level: authentik</span>
|
||||
|
||||
## What is AWS
|
||||
|
||||
:::note
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Ansible Tower / AWX
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary"></span>
|
||||
|
||||
## What is Tower
|
||||
|
||||
From https://docs.ansible.com/ansible/2.5/reference_appendices/tower.html
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Bookstack
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Bookstack
|
||||
|
||||
From https://en.wikipedia.org/wiki/BookStack
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Budibase
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Budibase
|
||||
|
||||
From https://github.com/Budibase/budibase
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: FortiManager
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is FortiManager
|
||||
|
||||
From https://www.fortinet.com/products/management/fortimanager
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Gitea
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Gitea
|
||||
|
||||
From https://gitea.io/
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: GitLab
|
||||
---
|
||||
|
||||
<span class="badge badge--primary">Support level: authentik</span>
|
||||
|
||||
## What is GitLab
|
||||
|
||||
From https://about.gitlab.com/what-is-gitlab/
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Grafana
|
||||
---
|
||||
|
||||
<span class="badge badge--primary">Support level: authentik</span>
|
||||
|
||||
## What is Grafana
|
||||
|
||||
From https://en.wikipedia.org/wiki/Grafana
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Harbor
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Harbor
|
||||
|
||||
From https://goharbor.io
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Hashicorp Vault
|
||||
---
|
||||
|
||||
<span class="badge badge--primary">Support level: authentik</span>
|
||||
|
||||
## What is Vault
|
||||
|
||||
From https://vaultproject.io
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: HedgeDoc
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is HedgeDoc
|
||||
|
||||
From https://github.com/hedgedoc/hedgedoc
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Home-Assistant
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Home-Assistant
|
||||
|
||||
From https://www.home-assistant.io/
|
||||
|
|
|
|||
25
website/integrations/services/index.mdx
Normal file
25
website/integrations/services/index.mdx
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
title: Applications
|
||||
slug: /
|
||||
---
|
||||
|
||||
import DocCardList from "@theme/DocCardList";
|
||||
import { useCurrentSidebarCategory } from "@docusaurus/theme-common";
|
||||
|
||||
Below is a list of all applications that are known to work with authentik.
|
||||
|
||||
All integrations will have a combination of these badges:
|
||||
|
||||
- <span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
The integration is community maintained.
|
||||
|
||||
- <span class="badge badge--info">Support level: Vendor</span>
|
||||
|
||||
The integration is supported by the vendor.
|
||||
|
||||
- <span class="badge badge--primary">Support level: authentik</span>
|
||||
|
||||
The integration is regularly tested by the authentik team.
|
||||
|
||||
<DocCardList items={useCurrentSidebarCategory().items} />
|
||||
|
|
@ -2,6 +2,8 @@
|
|||
title: Kimai
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Kimai
|
||||
|
||||
From https://www.kimai.org/about/
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Matrix Synapse
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Matrix Synapse
|
||||
|
||||
From https://matrix.org/
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: MinIO
|
||||
---
|
||||
|
||||
<span class="badge badge--primary">Support level: authentik</span>
|
||||
|
||||
## What is MinIO
|
||||
|
||||
From https://en.wikipedia.org/wiki/MinIO
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: NextCloud
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is NextCloud
|
||||
|
||||
From https://en.wikipedia.org/wiki/Nextcloud
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: OnlyOffice
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is OnlyOffice
|
||||
|
||||
From https://en.wikipedia.org/wiki/OnlyOffice
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: OPNsense
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is OPNsense
|
||||
|
||||
From https://opnsense.org/
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Paperless-ng
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Paperless-ng
|
||||
|
||||
Modified from https://github.com/jonaswinkler/paperless-ng
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: pfSense
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is pfSense
|
||||
|
||||
From https://www.pfsense.org/
|
||||
|
|
@ -58,7 +60,7 @@ In authentik, create an outpost (under _Applications/Outposts_) of type `LDAP` t
|
|||
## pfSense unsecure setup (without SSL)
|
||||
|
||||
:::warning
|
||||
This setup should only be used for testing purpose, because passwords will be sent in clear text to authentik.
|
||||
This setup should only be used for testing purpose, because passwords will be sent in clear text to authentik.
|
||||
:::
|
||||
|
||||
Add your authentik LDAP server to pfSense by going to your pfSense Web UI and clicking the `+ Add` under _System/User Manager/Authentication Servers_.
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: pgAdmin
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is pgAdmin
|
||||
|
||||
From https://www.pgadmin.org/
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Portainer
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Portainer
|
||||
|
||||
From https://www.portainer.io/
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: PowerDNS-Admin
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is PowerDNS-Admin
|
||||
|
||||
From https://github.com/ngoduykhanh/PowerDNS-Admin
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Proxmox VE
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Proxmox VE
|
||||
|
||||
From https://pve.proxmox.com/wiki/Main_Page
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Rancher
|
||||
---
|
||||
|
||||
<span class="badge badge--primary">Support level: authentik</span>
|
||||
|
||||
## What is Rancher
|
||||
|
||||
From https://rancher.com/products/rancher
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Rocket.chat
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Rocket.chat
|
||||
|
||||
From https://github.com/RocketChat/Rocket.Chat
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Roundcube
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Roundcube
|
||||
|
||||
From https://roundcube.net
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Sentry
|
||||
---
|
||||
|
||||
<span class="badge badge--primary">Support level: authentik</span>
|
||||
|
||||
## What is Sentry
|
||||
|
||||
From https://sentry.io
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Sonarr
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
:::note
|
||||
These instructions apply to all projects in the \*arr Family. If you use multiple of these projects, you can assign them to the same Outpost.
|
||||
:::
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: sssd
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is sssd
|
||||
|
||||
From https://sssd.io/
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Tautulli
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Tautulli
|
||||
|
||||
From https://tautulli.com/
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Ubuntu Landscape
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Ubuntu Landscape
|
||||
|
||||
From https://en.wikipedia.org/wiki/Landscape_(software)
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Uptime Kuma
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Uptime Kuma
|
||||
|
||||
From https://github.com/louislam/uptime-kuma
|
||||
|
|
@ -29,7 +31,7 @@ Create an application in authentik. Create a Proxy provider with the following p
|
|||
|
||||
- External host
|
||||
|
||||
`https://uptime-kuma.company`
|
||||
`https://uptime-kuma.company`
|
||||
Set this to the external URL you will be accessing Uptime Kuma from.
|
||||
|
||||
- Skip path regex
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Veeam Enterprise Manager
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Veeam Enterprise Manager
|
||||
|
||||
From https://helpcenter.veeam.com/docs/backup/em/introduction.html?ver=100
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Vikunja
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Vikunja
|
||||
|
||||
From https://vikunja.io/
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: VMware vCenter
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is vCenter
|
||||
|
||||
From https://en.wikipedia.org/wiki/VCenter
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Weblate
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Weblate
|
||||
|
||||
From https://weblate.org/en/
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Wekan
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Wekan
|
||||
|
||||
From https://github.com/wekan/wekan/wiki
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Wiki.js
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Wiki.js
|
||||
|
||||
From https://en.wikipedia.org/wiki/Wiki.js
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Wordpress
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Wordpress
|
||||
|
||||
From https://en.wikipedia.org/wiki/WordPress
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Zabbix
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Zabbix
|
||||
|
||||
From https://www.zabbix.com/features
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Zulip
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## What is Zulip
|
||||
|
||||
From https://zulip.com
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Active Directory
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## Preparation
|
||||
|
||||
The following placeholders will be used:
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Apple
|
||||
---
|
||||
|
||||
<span class="badge badge--primary">Support level: authentik</span>
|
||||
|
||||
Allows users to authenticate using their Apple ID.
|
||||
|
||||
## Preparation
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Azure AD
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## Preparation
|
||||
|
||||
The following placeholders will be used:
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Discord
|
||||
---
|
||||
|
||||
<span class="badge badge--primary">Support level: authentik</span>
|
||||
|
||||
Allows users to authenticate using their Discord credentials
|
||||
|
||||
## Preparation
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: FreeIPA
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
## Preparation
|
||||
|
||||
The following placeholders will be used:
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Github
|
||||
---
|
||||
|
||||
<span class="badge badge--primary">Support level: authentik</span>
|
||||
|
||||
Allows users to authenticate using their Github credentials
|
||||
|
||||
## Preparation
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Google
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
Allows users to authenticate using their Google credentials
|
||||
|
||||
## Preparation
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Mailcow
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
Allows users to authenticate using their Mailcow credentials
|
||||
|
||||
## Preparation
|
||||
|
|
|
|||
|
|
@ -1,9 +1,7 @@
|
|||
---
|
||||
title: Generic OAuth Source
|
||||
title: OAuth
|
||||
---
|
||||
|
||||
## Generic OAuth Source
|
||||
|
||||
:::note
|
||||
All Integration-specific Sources are documented in the Integrations Section
|
||||
:::
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Plex
|
||||
---
|
||||
|
||||
<span class="badge badge--secondary">Support level: Community</span>
|
||||
|
||||
Allows users to authenticate using their Plex credentials
|
||||
|
||||
## Preparation
|
||||
|
|
|
|||
|
|
@ -2,8 +2,6 @@
|
|||
title: SAML
|
||||
---
|
||||
|
||||
## SAML Source
|
||||
|
||||
This source allows authentik to act as a SAML Service Provider. Just like the SAML Provider, it supports signed requests. Vendor-specific documentation can be found in the Integrations Section.
|
||||
|
||||
## Terminology
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
title: Twitter
|
||||
---
|
||||
|
||||
<span class="badge badge--primary">Support level: authentik</span>
|
||||
|
||||
Allows users to authenticate using their twitter credentials
|
||||
|
||||
## Preparation
|
||||
|
|
|
|||
|
|
@ -4,10 +4,8 @@ module.exports = {
|
|||
type: "category",
|
||||
label: "Applications",
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Applications",
|
||||
slug: "/",
|
||||
description: "Applications which integrate with authentik",
|
||||
type: "doc",
|
||||
id: "services/index",
|
||||
},
|
||||
items: [
|
||||
{
|
||||
|
|
@ -117,9 +115,7 @@ module.exports = {
|
|||
"sources/github/index",
|
||||
"sources/google/index",
|
||||
"sources/mailcow/index",
|
||||
"sources/oauth/index",
|
||||
"sources/plex/index",
|
||||
"sources/saml/index",
|
||||
"sources/twitter/index",
|
||||
],
|
||||
},
|
||||
|
|
@ -129,7 +125,15 @@ module.exports = {
|
|||
items: [
|
||||
"sources/active-directory/index",
|
||||
"sources/freeipa/index",
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Protocols",
|
||||
items: [
|
||||
"sources/ldap/index",
|
||||
"sources/oauth/index",
|
||||
"sources/saml/index",
|
||||
],
|
||||
},
|
||||
],
|
||||
|
|
|
|||
Reference in a new issue