This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
authentik/website/sidebars.js

448 lines
16 KiB
JavaScript
Raw Permalink Normal View History

const generateVersionDropdown =
require("./src/utils.js").generateVersionDropdown;
const docsSidebar = {
docs: [
{
type: "html",
},
{
type: "doc",
id: "index",
},
{
type: "category",
label: "Installation",
collapsed: true,
link: {
type: "doc",
id: "installation/index",
},
items: [
"installation/docker-compose",
"installation/kubernetes",
2021-03-12 17:04:42 +00:00
"installation/beta",
"installation/configuration",
"installation/reverse-proxy",
"installation/automated-install",
"installation/air-gapped",
"installation/monitoring",
],
},
{
type: "category",
label: "Core Concepts",
collapsed: true,
items: [
"core/terminology",
"core/applications",
"core/tenants",
"core/certificates",
"core/geoip",
"core/architecture",
],
},
{
type: "category",
label: "Enterprise",
collapsed: true,
link: {
type: "doc",
id: "enterprise/index",
},
items: [
"enterprise/get-started",
"enterprise/manage-enterprise",
"enterprise/entsupport",
],
},
{
type: "category",
label: "Providers",
items: [
{
type: "category",
label: "OAuth2 Provider",
link: {
type: "doc",
id: "providers/oauth2/index",
},
items: [
"providers/oauth2/client_credentials",
"providers/oauth2/device_code",
],
},
"providers/saml/index",
"providers/radius/index",
{
type: "category",
label: "Proxy Provider",
link: {
type: "doc",
id: "providers/proxy/index",
},
items: [
"providers/proxy/custom_headers",
"providers/proxy/header_authentication",
{
type: "category",
label: "Forward authentication",
link: {
type: "doc",
id: "providers/proxy/forward_auth",
},
items: [
"providers/proxy/server_nginx",
"providers/proxy/server_traefik",
"providers/proxy/server_envoy",
"providers/proxy/server_caddy",
],
},
],
},
{
type: "category",
label: "LDAP Provider",
link: {
type: "doc",
id: "providers/ldap/index",
},
items: ["providers/ldap/generic_setup"],
},
providers: SCIM (#4835) * basic user sync Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add group sync and some refactor Signed-off-by: Jens Langhammer <jens@goauthentik.io> * start API Signed-off-by: Jens Langhammer <jens@goauthentik.io> * allow null authorization flow Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add UI Signed-off-by: Jens Langhammer <jens@goauthentik.io> * make task monitored Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add missing dependency Signed-off-by: Jens Langhammer <jens@goauthentik.io> * make authorization_flow required for most providers via API Signed-off-by: Jens Langhammer <jens@goauthentik.io> * more UI Signed-off-by: Jens Langhammer <jens@goauthentik.io> * make task result better readable, exclude anonymous user Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add task UI Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add scheduled task for all sync Signed-off-by: Jens Langhammer <jens@goauthentik.io> * make scim errors more readable Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add mappings, migrate to mappings Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add mapping UI and more Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add scim docs to web Signed-off-by: Jens Langhammer <jens@goauthentik.io> * start implementing membership Signed-off-by: Jens Langhammer <jens@goauthentik.io> * migrate signals to tasks Signed-off-by: Jens Langhammer <jens@goauthentik.io> * migrate fully to tasks Signed-off-by: Jens Langhammer <jens@goauthentik.io> * strip none keys, fix lint errors Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix things Signed-off-by: Jens Langhammer <jens@goauthentik.io> * start adding tests Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix saml Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add scim schemas and validate against it Signed-off-by: Jens Langhammer <jens@goauthentik.io> * improve error handling Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add group put support, add group tests Signed-off-by: Jens Langhammer <jens@goauthentik.io> * send correct application/scim+json headers Signed-off-by: Jens Langhammer <jens@goauthentik.io> * stop sync if no mappings are confiugred Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add test for task sync Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add membership tests Signed-off-by: Jens Langhammer <jens@goauthentik.io> * use decorator for tests Signed-off-by: Jens Langhammer <jens@goauthentik.io> * make tests better Signed-off-by: Jens Langhammer <jens@goauthentik.io> --------- Signed-off-by: Jens Langhammer <jens@goauthentik.io>
2023-03-06 18:39:08 +00:00
"providers/scim/index",
],
},
{
type: "category",
label: "Outposts",
link: {
type: "doc",
id: "outposts/index",
},
items: [
"outposts/embedded/embedded",
{
type: "category",
label: "Integrations",
items: [
"outposts/integrations/docker",
"outposts/integrations/kubernetes",
],
},
outposts: set cookies for a domain to authenticate an entire domain (#971) * outposts: initial cookie domain implementation Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * web/admin: add cookie domain setting Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * providers/proxy: replace forward_auth_mode with general mode Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * web/admin: rebuild proxy provider form Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * providers/proxy: re-add forward_auth_mode for backwards compat Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * web/admin: fix data.mode not being set Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * root: always set log level to debug when testing Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * providers/proxy: use new mode attribute Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * providers/proxy: only ingress /akprox on forward_domain Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * providers/proxy: fix lint error Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * web/admin: fix error on ProxyProviderForm when not using proxy mode Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * web/admin: fix default for outpost form's type missing Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * web/admin: add additional desc for proxy modes Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * outposts: fix service account permissions not always being updated Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * outpost/proxy: fix redirecting to incorrect host for domain mode Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * web: improve error handling for network errors Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * outpost: fix image naming not matching main imaeg Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * outposts/proxy: fix redirects for domain mode and traefik Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * web: fix colour for paragraphs Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * web/flows: fix consent stage not showing permissions correctly Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * website/docs: add domain-level docs Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * website/docs: fix broken links Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * outposts/proxy: remove dead code Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * web/flows: fix missing id for #header-text Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
2021-06-08 21:10:17 +00:00
{
type: "category",
label: "Running and upgrading",
items: [
"outposts/manual-deploy-docker-compose",
"outposts/manual-deploy-kubernetes",
"outposts/upgrading",
outposts: set cookies for a domain to authenticate an entire domain (#971) * outposts: initial cookie domain implementation Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * web/admin: add cookie domain setting Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * providers/proxy: replace forward_auth_mode with general mode Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * web/admin: rebuild proxy provider form Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * providers/proxy: re-add forward_auth_mode for backwards compat Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * web/admin: fix data.mode not being set Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * root: always set log level to debug when testing Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * providers/proxy: use new mode attribute Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * providers/proxy: only ingress /akprox on forward_domain Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * providers/proxy: fix lint error Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * web/admin: fix error on ProxyProviderForm when not using proxy mode Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * web/admin: fix default for outpost form's type missing Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * web/admin: add additional desc for proxy modes Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * outposts: fix service account permissions not always being updated Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * outpost/proxy: fix redirecting to incorrect host for domain mode Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * web: improve error handling for network errors Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * outpost: fix image naming not matching main imaeg Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * outposts/proxy: fix redirects for domain mode and traefik Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * web: fix colour for paragraphs Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * web/flows: fix consent stage not showing permissions correctly Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * website/docs: add domain-level docs Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * website/docs: fix broken links Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * outposts/proxy: remove dead code Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org> * web/flows: fix missing id for #header-text Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
2021-06-08 21:10:17 +00:00
],
},
],
},
{
type: "category",
label: "Flows",
link: {
type: "doc",
id: "flow/index",
},
items: [
2022-05-15 23:10:23 +00:00
"flow/layouts",
"flow/inspector",
"flow/context/index",
{
type: "category",
label: "Examples",
items: ["flow/examples/flows", "flow/examples/snippets"],
},
{
type: "category",
label: "Executors",
items: [
"flow/executors/if-flow",
"flow/executors/user-settings",
"flow/executors/headless",
],
},
{
type: "category",
label: "Stages",
items: [
"flow/stages/authenticator_duo/index",
"flow/stages/authenticator_sms/index",
"flow/stages/authenticator_static/index",
"flow/stages/authenticator_totp/index",
"flow/stages/authenticator_validate/index",
"flow/stages/authenticator_webauthn/index",
"flow/stages/captcha/index",
"flow/stages/deny",
"flow/stages/email/index",
"flow/stages/identification/index",
"flow/stages/invitation/index",
"flow/stages/password/index",
"flow/stages/prompt/index",
"flow/stages/user_delete",
"flow/stages/user_login",
"flow/stages/user_logout",
"flow/stages/user_write",
],
},
],
},
{
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",
"flow/stages/authenticator_static/index",
"flow/stages/authenticator_totp/index",
"flow/stages/authenticator_validate/index",
"flow/stages/authenticator_webauthn/index",
"flow/stages/captcha/index",
2021-03-02 21:25:28 +00:00
"flow/stages/deny",
"flow/stages/email/index",
"flow/stages/identification/index",
"flow/stages/invitation/index",
"flow/stages/password/index",
"flow/stages/prompt/index",
"flow/stages/user_delete",
"flow/stages/user_login/index",
"flow/stages/user_logout",
"flow/stages/user_write",
],
},
{
type: "category",
label: "Policies",
link: {
type: "doc",
id: "policies/index",
},
items: [
{
type: "category",
label: "Working with policies",
items: ["policies/working_with_policies/whitelist_email"],
link: {
type: "generated-index",
title: "Working with policies",
slug: "policies/working_with_policies",
description: "Overview of policies configuration",
},
},
"policies/expression",
],
},
{
type: "category",
label: "Property Mappings",
link: {
type: "doc",
id: "property-mappings/index",
},
items: ["property-mappings/expression"],
},
{
type: "category",
label: "Events",
link: {
type: "doc",
id: "events/index",
},
items: ["events/notifications", "events/transports"],
},
{
type: "category",
label: "Interfaces",
items: [
{
type: "category",
label: "Flow",
items: ["interfaces/flow/customization"],
},
{
type: "category",
label: "User",
items: ["interfaces/user/customization"],
},
{
type: "category",
label: "Admin",
items: ["interfaces/admin/customization"],
},
],
},
{
type: "category",
label: "Users, Groups, & Roles",
items: [
{
type: "category",
label: "Users",
link: {
type: "doc",
id: "user-group-role/user/index",
},
items: [
"user-group-role/user/user_basic_operations",
"user-group-role/user/user_ref",
"user-group-role/user/invitations",
],
},
{
type: "category",
label: "Groups",
link: {
type: "doc",
id: "user-group-role/groups/index",
},
items: ["user-group-role/groups/manage_groups"],
},
{
type: "category",
label: "Roles",
link: {
type: "doc",
id: "user-group-role/roles/index",
},
items: ["user-group-role/roles/manage_roles"],
},
{
type: "category",
label: "Access control",
link: {
type: "doc",
id: "user-group-role/access-control/index",
},
items: [
"user-group-role/access-control/permissions",
"user-group-role/access-control/manage_permissions",
],
},
],
},
{
type: "category",
label: "Release Notes",
link: {
type: "generated-index",
title: "Releases",
slug: "releases",
description: "Release notes for recent authentik versions",
},
items: [
"releases/2023/v2023.10",
"releases/2023/v2023.8",
"releases/2023/v2023.6",
{
type: "category",
label: "Previous versions",
items: [
"releases/2023/v2023.5",
"releases/2023/v2023.4",
"releases/2023/v2023.3",
"releases/2023/v2023.2",
"releases/2023/v2023.1",
"releases/2022/v2022.12",
"releases/2022/v2022.11",
"releases/2022/v2022.10",
2023-01-04 18:45:31 +00:00
"releases/2022/v2022.9",
"releases/2022/v2022.8",
"releases/2022/v2022.7",
"releases/2022/v2022.6",
"releases/2022/v2022.5",
"releases/2022/v2022.4",
"releases/2022/v2022.2",
"releases/2022/v2022.1",
"releases/2021/v2021.12",
"releases/2021/v2021.10",
"releases/2021/v2021.9",
"releases/2021/v2021.8",
"releases/2021/v2021.7",
"releases/2021/v2021.6",
"releases/2021/v2021.5",
"releases/2021/v2021.4",
"releases/2021/v2021.3",
"releases/2021/v2021.2",
"releases/2021/v2021.1",
"releases/old/v0.14",
"releases/old/v0.13",
"releases/old/v0.12",
"releases/old/v0.11",
"releases/old/v0.10",
"releases/old/v0.9",
],
},
],
},
{
type: "category",
label: "Troubleshooting",
link: {
type: "generated-index",
title: "Troubleshooting",
slug: "troubleshooting",
description: "Troubleshooting various issues",
},
items: [
{
type: "category",
label: "Forward auth",
items: ["troubleshooting/forward_auth/general"],
link: {
type: "generated-index",
title: "Forward auth troubleshooting",
slug: "troubleshooting/forward_auth",
description:
"Steps to help debug forward auth setups with various reverse proxies.",
},
},
core: bump django from 4.1.7 to 4.2 (#5238) * core: bump django from 4.1.7 to 4.2 (#5151) * core: bump django from 4.1.7 to 4.2 Bumps [django](https://github.com/django/django) from 4.1.7 to 4.2. - [Release notes](https://github.com/django/django/releases) - [Commits](https://github.com/django/django/compare/4.1.7...4.2) --- updated-dependencies: - dependency-name: django dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * upgrade to psycopg3, use custom engine for prometheus metrics See https://github.com/korfuri/django-prometheus/issues/350 Signed-off-by: Jens Langhammer <jens@goauthentik.io> * make scripts use pscopg3 Signed-off-by: Jens Langhammer <jens@goauthentik.io> --------- Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: Jens Langhammer <jens@goauthentik.io> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Jens Langhammer <jens@goauthentik.io> Signed-off-by: Jens Langhammer <jens@goauthentik.io> * start changelog Signed-off-by: Jens Langhammer <jens@goauthentik.io> * initial postgres upgrade guide Signed-off-by: Jens Langhammer <jens@goauthentik.io> * Apply suggestions from code review Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com> Signed-off-by: Jens L. <jens@beryju.org> Signed-off-by: Jens Langhammer <jens@goauthentik.io> * update header Signed-off-by: Jens Langhammer <jens@goauthentik.io> --------- Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: Jens Langhammer <jens@goauthentik.io> Signed-off-by: Jens L. <jens@beryju.org> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
2023-08-01 17:30:28 +00:00
{
type: "category",
label: "PostgreSQL",
items: ["troubleshooting/postgres/upgrade_kubernetes"],
},
"troubleshooting/access",
2021-02-27 15:00:05 +00:00
"troubleshooting/login",
"troubleshooting/image_upload",
"troubleshooting/missing_permission",
"troubleshooting/missing_admin_group",
"troubleshooting/csrf",
"troubleshooting/emails",
"troubleshooting/ldap_source",
],
},
{
type: "category",
label: "Security",
link: {
type: "generated-index",
title: "Security",
slug: "security",
},
items: [
"security/policy",
"security/GHSA-rjvp-29xq-f62w",
"security/CVE-2023-39522",
"security/CVE-2023-36456",
security: cure53 fix (#6039) * ATH-01-001: resolve path and check start before loading blueprints This is even less of an issue since 411ef239f63e4d3beacd8297d4be54b29fb30127, since with that commit we only allow files that the listing returns Signed-off-by: Jens Langhammer <jens@goauthentik.io> * ATH-01-010: fix missing user filter for webauthn device This prevents an attack that is only possible when an attacker can intercept HTTP traffic and in the case of HTTPS decrypt it. * ATH-01-008: fix web forms not submitting correctly when pressing enter When submitting some forms with the Enter key instead of clicking "Confirm"/etc, the form would not get submitted correctly This would in the worst case is when setting a user's password, where the new password can end up in the URL, but the password was not actually saved to the user. * ATH-01-004: remove env from admin system endpoint this endpoint already required admin access, but for debugging the env variables are used very little Signed-off-by: Jens Langhammer <jens@goauthentik.io> * ATH-01-003 / ATH-01-012: disable htmlLabels in mermaid Signed-off-by: Jens Langhammer <jens@goauthentik.io> * ATH-01-005: use hmac.compare_digest for secret_key authentication Signed-off-by: Jens Langhammer <jens@goauthentik.io> * ATH-01-009: migrate impersonation to use API Signed-off-by: Jens Langhammer <jens@goauthentik.io> * ATH-01-010: rework Signed-off-by: Jens Langhammer <jens@goauthentik.io> * ATH-01-014: save authenticator validation state in flow context Signed-off-by: Jens Langhammer <jens@goauthentik.io> bugfixes Signed-off-by: Jens Langhammer <jens@goauthentik.io> * ATH-01-012: escape quotation marks Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add website Signed-off-by: Jens Langhammer <jens@goauthentik.io> * update release ntoes Signed-off-by: Jens Langhammer <jens@goauthentik.io> * update with all notes Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix format Signed-off-by: Jens Langhammer <jens@goauthentik.io> --------- Signed-off-by: Jens Langhammer <jens@goauthentik.io>
2023-06-22 20:25:04 +00:00
"security/2023-06-cure53",
"security/CVE-2023-26481",
"security/CVE-2022-23555",
"security/CVE-2022-46145",
"security/CVE-2022-46172",
],
},
],
};
docsSidebar.docs[0].value = generateVersionDropdown(docsSidebar);
module.exports = docsSidebar;