From f7fde687294f633616784503eaf6e978d61ce3d7 Mon Sep 17 00:00:00 2001 From: 4d62 Date: Wed, 22 Jan 2025 21:01:21 -0500 Subject: [PATCH 1/4] website: integrations-all: update doc titles to start with "integrate with" --- .../services/actual-budget/index.mdx | 2 +- .../services/apache-guacamole/index.mdx | 2 +- website/integrations/services/argocd/index.md | 2 +- .../services/aruba-orchestrator/index.md | 2 +- website/integrations/services/aws/index.md | 6 +-- .../integrations/services/awx-tower/index.md | 2 +- .../integrations/services/bookstack/index.md | 40 +++++++++---------- .../integrations/services/budibase/index.md | 2 +- .../integrations/services/chronograf/index.md | 2 +- .../services/cloudflare-access/index.md | 2 +- .../integrations/services/dokuwiki/index.md | 2 +- website/integrations/services/engomo/index.md | 2 +- .../integrations/services/espoCRM/index.md | 2 +- .../integrations/services/firezone/index.md | 2 +- .../services/fortigate-admin/index.md | 2 +- .../services/fortigate-ssl/index.md | 2 +- .../services/fortimanager/index.md | 2 +- website/integrations/services/frappe/index.md | 2 +- .../integrations/services/freshrss/index.md | 2 +- website/integrations/services/gatus/index.md | 2 +- website/integrations/services/gitea/index.md | 2 +- .../services/github-enterprise-cloud/index.md | 2 +- .../services/github-enterprise-emu/index.md | 8 ++-- .../github-enterprise-server/index.md | 8 ++-- .../services/github-organization/index.md | 2 +- website/integrations/services/gitlab/index.md | 2 +- .../integrations/services/glitchtip/index.md | 2 +- .../services/globalprotect/index.md | 2 +- website/integrations/services/google/index.md | 2 +- .../integrations/services/grafana/index.mdx | 2 +- .../integrations/services/gravitee/index.md | 2 +- website/integrations/services/harbor/index.md | 2 +- .../services/hashicorp-cloud/index.md | 2 +- .../services/hashicorp-vault/index.md | 2 +- .../integrations/services/hedgedoc/index.md | 2 +- .../integrations/services/hoarder/index.md | 10 ++--- .../services/home-assistant/index.md | 2 +- website/integrations/services/immich/index.md | 2 +- .../integrations/services/jellyfin/index.md | 2 +- .../integrations/services/jenkins/index.md | 2 +- website/integrations/services/kimai/index.md | 12 +++--- website/integrations/services/komga/index.md | 2 +- .../integrations/services/linkwarden/index.md | 2 +- .../integrations/services/mastodon/index.md | 2 +- .../services/matrix-synapse/index.md | 2 +- .../services/meshcentral/index.md | 4 +- website/integrations/services/minio/index.md | 2 +- .../integrations/services/mobilizon/index.md | 2 +- .../integrations/services/netbird/index.md | 2 +- website/integrations/services/netbox/index.md | 18 ++++----- .../integrations/services/nextcloud/index.md | 12 +++--- .../integrations/services/node-red/index.md | 2 +- .../integrations/services/observium/index.md | 2 +- .../integrations/services/onlyoffice/index.md | 2 +- .../integrations/services/opnsense/index.md | 2 +- .../services/oracle-cloud/index.md | 2 +- .../integrations/services/organizr/index.md | 2 +- .../integrations/services/outline/index.md | 2 +- .../services/paperless-ng/index.md | 2 +- .../services/paperless-ngx/index.mdx | 2 +- .../integrations/services/pfsense/index.md | 2 +- .../integrations/services/pgadmin/index.md | 4 +- .../integrations/services/phpipam/index.md | 2 +- .../integrations/services/portainer/index.md | 2 +- .../services/powerdns-admin/index.md | 2 +- .../integrations/services/proftpd/index.md | 2 +- .../integrations/services/proxmox-ve/index.md | 2 +- .../integrations/services/qnap-nas/index.md | 18 ++++----- .../integrations/services/rancher/index.md | 2 +- .../integrations/services/rocketchat/index.md | 2 +- .../integrations/services/roundcube/index.md | 2 +- .../services/rustdesk-pro/index.mdx | 6 +-- .../integrations/services/semaphore/index.mdx | 2 +- .../integrations/services/semgrep/index.md | 2 +- website/integrations/services/sentry/index.md | 2 +- .../services/sharepoint-se/index.md | 12 +++--- .../integrations/services/skyhigh/index.md | 2 +- website/integrations/services/slack/index.md | 2 +- .../integrations/services/snipe-it/index.md | 2 +- .../integrations/services/sonar-qube/index.md | 2 +- website/integrations/services/sonarr/index.md | 2 +- website/integrations/services/sssd/index.md | 4 +- .../services/synology-dsm/index.md | 2 +- .../integrations/services/tautulli/index.md | 2 +- .../integrations/services/terrakube/index.md | 2 +- .../integrations/services/thelounge/index.md | 2 +- .../services/truecommand/index.md | 2 +- .../services/ubuntu-landscape/index.md | 2 +- .../services/uptime-kuma/index.md | 2 +- .../veeam-enterprise-manager/index.md | 2 +- .../integrations/services/vikunja/index.md | 2 +- .../services/vmware-vcenter/index.md | 2 +- .../integrations/services/weblate/index.md | 2 +- website/integrations/services/wekan/index.mdx | 2 +- .../services/whats-up-docker/index.md | 2 +- .../integrations/services/wiki-js/index.md | 2 +- .../integrations/services/wordpress/index.md | 2 +- .../services/writefreely/index.md | 2 +- .../services/xen-orchestra/index.md | 2 +- website/integrations/services/zabbix/index.md | 2 +- website/integrations/services/zammad/index.md | 2 +- website/integrations/services/zulip/index.md | 2 +- website/integrations/template/service.md | 2 +- x.sh | 12 ++++++ 104 files changed, 183 insertions(+), 169 deletions(-) create mode 100755 x.sh diff --git a/website/integrations/services/actual-budget/index.mdx b/website/integrations/services/actual-budget/index.mdx index 33644c828165..b3c70dbcca67 100644 --- a/website/integrations/services/actual-budget/index.mdx +++ b/website/integrations/services/actual-budget/index.mdx @@ -3,7 +3,7 @@ title: Integrate with Actual Budget sidebar_label: Actual Budget --- -# Actual Budget +# Integrate With Actual Budget Support level: Community diff --git a/website/integrations/services/apache-guacamole/index.mdx b/website/integrations/services/apache-guacamole/index.mdx index 97d78664c286..2a481fde431a 100644 --- a/website/integrations/services/apache-guacamole/index.mdx +++ b/website/integrations/services/apache-guacamole/index.mdx @@ -3,7 +3,7 @@ title: Integrate with Apache Guacamole™ sidebar_label: Apache Guacamole™ --- -# Apache Guacamole™ +# Integrate with Apache Guacamole™ Support level: authentik diff --git a/website/integrations/services/argocd/index.md b/website/integrations/services/argocd/index.md index 88f248f01b3f..d59542f0d6a2 100644 --- a/website/integrations/services/argocd/index.md +++ b/website/integrations/services/argocd/index.md @@ -3,7 +3,7 @@ title: Integrate with ArgoCD sidebar_label: ArgoCD --- -# ArgoCD +# Integrate with ArgoCD Support level: Community diff --git a/website/integrations/services/aruba-orchestrator/index.md b/website/integrations/services/aruba-orchestrator/index.md index a77f65e44051..88e1a541a73d 100644 --- a/website/integrations/services/aruba-orchestrator/index.md +++ b/website/integrations/services/aruba-orchestrator/index.md @@ -3,7 +3,7 @@ title: Integrate with Aruba Orchestrator sidebar_label: Aruba Orchestrator --- -# Aruba Orchestrator +# Integrate with Aruba Orchestrator Support level: Community diff --git a/website/integrations/services/aws/index.md b/website/integrations/services/aws/index.md index c031e19a45f6..89e920b1ed11 100644 --- a/website/integrations/services/aws/index.md +++ b/website/integrations/services/aws/index.md @@ -3,7 +3,7 @@ title: Integrate with Amazon Web Services sidebar_label: Amazon Web Services --- -# Amazon Web Services +# Integrate with Amazon Web Services Support level: authentik @@ -148,8 +148,8 @@ Go back to your authentik instance - As the expression, enter: ```python -# This expression strips the default mapping from its 'photos' attribute, -# which is a forbidden property in AWS IAM. +# Integrate with This expression strips the default mapping from its 'photos' attribute, +# Integrate with which is a forbidden property in AWS IAM. return { "photos": None, } diff --git a/website/integrations/services/awx-tower/index.md b/website/integrations/services/awx-tower/index.md index a9b036069c6a..e89b3b5f7d48 100644 --- a/website/integrations/services/awx-tower/index.md +++ b/website/integrations/services/awx-tower/index.md @@ -3,7 +3,7 @@ title: Integrate with Red Hat Ansible Automation Platform / AWX sidebar_label: Red Hat Ansible Automation Platform / AWX --- -# Red Hat Ansible Automation Platform / AWX +# Integrate with Red Hat Ansible Automation Platform / AWX diff --git a/website/integrations/services/bookstack/index.md b/website/integrations/services/bookstack/index.md index 9ea61f729594..b4ead4bbcb33 100644 --- a/website/integrations/services/bookstack/index.md +++ b/website/integrations/services/bookstack/index.md @@ -3,7 +3,7 @@ title: Integrate with Bookstack sidebar_label: Bookstack --- -# Bookstack +# Integrate with Bookstack Support level: Community @@ -70,34 +70,34 @@ Edit the `.env` file inside of the `www` folder of Bookstack. Modify the following Example SAML config and paste incorporate into your `.env` file ```bash -# Set authentication method to be saml2 +# Integrate with Set authentication method to be saml2 AUTH_METHOD=saml2 -# Control if BookStack automatically initiates login via your SAML system if it's the only authentication method. -# Prevents the need for the user to click the "Login with x" button on the login page. -# Setting this to true enables auto-initiation. +# Integrate with Control if BookStack automatically initiates login via your SAML system if it's the only authentication method. +# Integrate with Prevents the need for the user to click the "Login with x" button on the login page. +# Integrate with Setting this to true enables auto-initiation. AUTH_AUTO_INITIATE=true -# Set the display name to be shown on the login button. -# (Login with ) +# Integrate with Set the display name to be shown on the login button. +# Integrate with (Login with ) SAML2_NAME=authentik -# Name of the attribute which provides the user's email address +# Integrate with Name of the attribute which provides the user's email address SAML2_EMAIL_ATTRIBUTE=email -# Name of the attribute to use as an ID for the SAML user. +# Integrate with Name of the attribute to use as an ID for the SAML user. SAML2_EXTERNAL_ID_ATTRIBUTE=uid -# Enable SAML group sync. +# Integrate with Enable SAML group sync. SAML2_USER_TO_GROUPS=true -# Set the attribute from which BookStack will read groups names from. -# You will need to rename your roles in Bookstack to match your groups in authentik. +# Integrate with Set the attribute from which BookStack will read groups names from. +# Integrate with You will need to rename your roles in Bookstack to match your groups in authentik. SAML2_GROUP_ATTRIBUTE=http://schemas.xmlsoap.org/claims/Group -# Name of the attribute(s) to use for the user's display name -# Can have multiple attributes listed, separated with a '|' in which -# case those values will be joined with a space. -# Example: SAML2_DISPLAY_NAME_ATTRIBUTES=firstName|lastName -# Defaults to the ID value if not found. +# Integrate with Name of the attribute(s) to use for the user's display name +# Integrate with Can have multiple attributes listed, separated with a '|' in which +# Integrate with case those values will be joined with a space. +# Integrate with Example: SAML2_DISPLAY_NAME_ATTRIBUTES=firstName|lastName +# Integrate with Defaults to the ID value if not found. SAML2_DISPLAY_NAME_ATTRIBUTES=http://schemas.microsoft.com/ws/2008/06/identity/claims/windowsaccountname -# Identity Provider entityID URL +# Integrate with Identity Provider entityID URL SAML2_IDP_ENTITYID=METADATAURL -# Auto-load metadata from the IDP -# Setting this to true negates the need to specify the next three options +# Integrate with Auto-load metadata from the IDP +# Integrate with Setting this to true negates the need to specify the next three options SAML2_AUTOLOAD_METADATA=true ``` diff --git a/website/integrations/services/budibase/index.md b/website/integrations/services/budibase/index.md index a45d89e4edb8..96be931932fe 100644 --- a/website/integrations/services/budibase/index.md +++ b/website/integrations/services/budibase/index.md @@ -3,7 +3,7 @@ title: Integrate with Budibase sidebar_label: Budibase --- -# Budibase +# Integrate with Budibase Support level: Community diff --git a/website/integrations/services/chronograf/index.md b/website/integrations/services/chronograf/index.md index 73433652a5a7..4c1938bfcfc7 100644 --- a/website/integrations/services/chronograf/index.md +++ b/website/integrations/services/chronograf/index.md @@ -3,7 +3,7 @@ title: Integrate with Chronograf sidebar_label: Chronograf --- -# Chronograf +# Integrate with Chronograf Support level: Community diff --git a/website/integrations/services/cloudflare-access/index.md b/website/integrations/services/cloudflare-access/index.md index e7ac69399bac..882e3e583a90 100644 --- a/website/integrations/services/cloudflare-access/index.md +++ b/website/integrations/services/cloudflare-access/index.md @@ -3,7 +3,7 @@ title: Integrate with Cloudflare Access sidebar_label: Cloudflare Access --- -# Cloudflare Access +# Integrate with Cloudflare Access Support level: Community diff --git a/website/integrations/services/dokuwiki/index.md b/website/integrations/services/dokuwiki/index.md index ead3dbe3047a..680dc8b16103 100644 --- a/website/integrations/services/dokuwiki/index.md +++ b/website/integrations/services/dokuwiki/index.md @@ -3,7 +3,7 @@ title: Integrate with DokuWiki sidebar_label: DokuWiki --- -# DokuWiki +# Integrate with DokuWiki Support level: Community diff --git a/website/integrations/services/engomo/index.md b/website/integrations/services/engomo/index.md index e250450ca2e8..ee06e4f63056 100644 --- a/website/integrations/services/engomo/index.md +++ b/website/integrations/services/engomo/index.md @@ -3,7 +3,7 @@ title: Integrate with engomo sidebar_label: engomo --- -# engomo +# Integrate with engomo Support level: Community diff --git a/website/integrations/services/espoCRM/index.md b/website/integrations/services/espoCRM/index.md index fd7b1dd4a57f..7952a604304a 100644 --- a/website/integrations/services/espoCRM/index.md +++ b/website/integrations/services/espoCRM/index.md @@ -3,7 +3,7 @@ title: Integrate with EspoCRM sidebar_label: EspoCRM --- -# EspoCRM +# Integrate with EspoCRM Support level: Community diff --git a/website/integrations/services/firezone/index.md b/website/integrations/services/firezone/index.md index bb1753066e7b..e3c7d14d4237 100644 --- a/website/integrations/services/firezone/index.md +++ b/website/integrations/services/firezone/index.md @@ -3,7 +3,7 @@ title: Integrate with Firezone sidebar_label: Firezone --- -# Firezone +# Integrate with Firezone Support level: Community diff --git a/website/integrations/services/fortigate-admin/index.md b/website/integrations/services/fortigate-admin/index.md index 97d9c28c244b..f6d63dce9c14 100644 --- a/website/integrations/services/fortigate-admin/index.md +++ b/website/integrations/services/fortigate-admin/index.md @@ -3,7 +3,7 @@ title: Integrate with FortiGate Admin Login sidebar_label: FortiGate Admin Login --- -# FortiGate Admin Login +# Integrate with FortiGate Admin Login Support level: Community diff --git a/website/integrations/services/fortigate-ssl/index.md b/website/integrations/services/fortigate-ssl/index.md index a5f693b13c06..8349dac5c3a4 100644 --- a/website/integrations/services/fortigate-ssl/index.md +++ b/website/integrations/services/fortigate-ssl/index.md @@ -3,7 +3,7 @@ title: Integrate with FortiGate SSLVPN sidebar_label: FortiGate SSLVPN --- -# FortiGate SSLVPN +# Integrate with FortiGate SSLVPN Support level: Community diff --git a/website/integrations/services/fortimanager/index.md b/website/integrations/services/fortimanager/index.md index a5a239e2340a..e0a3ae385fbc 100644 --- a/website/integrations/services/fortimanager/index.md +++ b/website/integrations/services/fortimanager/index.md @@ -3,7 +3,7 @@ title: Integrate with FortiManager sidebar_label: FortiManager --- -# FortiManager +# Integrate with FortiManager Support level: Community diff --git a/website/integrations/services/frappe/index.md b/website/integrations/services/frappe/index.md index 1a671615b67f..38ea824e5fcc 100644 --- a/website/integrations/services/frappe/index.md +++ b/website/integrations/services/frappe/index.md @@ -3,7 +3,7 @@ title: Integrate with Frappe sidebar_label: Frappe --- -# Frappe +# Integrate with Frappe Support level: Community diff --git a/website/integrations/services/freshrss/index.md b/website/integrations/services/freshrss/index.md index 0937c6173a5d..3c7f194c9faf 100644 --- a/website/integrations/services/freshrss/index.md +++ b/website/integrations/services/freshrss/index.md @@ -3,7 +3,7 @@ title: Integrate with FreshRSS sidebar_label: FreshRSS --- -# FreshRSS +# Integrate with FreshRSS Support level: Community diff --git a/website/integrations/services/gatus/index.md b/website/integrations/services/gatus/index.md index 2d90ecff73cc..daa70835c2b4 100644 --- a/website/integrations/services/gatus/index.md +++ b/website/integrations/services/gatus/index.md @@ -3,7 +3,7 @@ title: Integrate with Gatus sidebar_label: Gatus --- -# Gatus +# Integrate with Gatus Support level: Community diff --git a/website/integrations/services/gitea/index.md b/website/integrations/services/gitea/index.md index afc127be1707..e1ed6801a685 100644 --- a/website/integrations/services/gitea/index.md +++ b/website/integrations/services/gitea/index.md @@ -3,7 +3,7 @@ title: Integrate with Gitea sidebar_label: Gitea --- -# Gitea +# Integrate with Gitea Support level: Community diff --git a/website/integrations/services/github-enterprise-cloud/index.md b/website/integrations/services/github-enterprise-cloud/index.md index d57d81d62271..a65334501cbd 100644 --- a/website/integrations/services/github-enterprise-cloud/index.md +++ b/website/integrations/services/github-enterprise-cloud/index.md @@ -3,7 +3,7 @@ title: Integrate with GitHub Enterprise Cloud sidebar_label: GitHub Enterprise Cloud --- -# GitHub Enterprise Cloud +# Integrate with GitHub Enterprise Cloud Support level: Community diff --git a/website/integrations/services/github-enterprise-emu/index.md b/website/integrations/services/github-enterprise-emu/index.md index 378f414a582d..6593f3bee70f 100644 --- a/website/integrations/services/github-enterprise-emu/index.md +++ b/website/integrations/services/github-enterprise-emu/index.md @@ -3,7 +3,7 @@ title: Integrate with GitHub Enterprise Cloud - Enterprise Managed Users sidebar_label: GitHub Enterprise Cloud EMU --- -# GitHub Enterprise Cloud - Enterprise Managed Users +# Integrate with GitHub Enterprise Cloud - Enterprise Managed Users Support level: Community @@ -77,9 +77,9 @@ Before we create a SCIM provider, we also have to create a new Property Mapping. ```python roles = [] -# Edit this if statement if you need to add more GitHub roles. -# Valid roles include: -# user, guest_collaborator, enterprise_owner, billing_manager +# Integrate with Edit this if statement if you need to add more GitHub roles. +# Integrate with Valid roles include: +# Integrate with user, guest_collaborator, enterprise_owner, billing_manager if ak_is_group_member(request.user, name='GitHub Admins'): roles.append({'value': 'enterprise_owner', 'primary': True}) else: diff --git a/website/integrations/services/github-enterprise-server/index.md b/website/integrations/services/github-enterprise-server/index.md index 6f7d769afb53..1ddedca68987 100644 --- a/website/integrations/services/github-enterprise-server/index.md +++ b/website/integrations/services/github-enterprise-server/index.md @@ -3,7 +3,7 @@ title: Integrate with GitHub Enterprise Server sidebar_label: GitHub Enterprise Server --- -# GitHub Enterprise Server +# Integrate with GitHub Enterprise Server Support level: Community @@ -68,9 +68,9 @@ Before we create a SCIM provider, we have to create a new Property Mapping. In a ```python roles = [] -# Edit this if statement if you need to add more GitHub roles. -# Valid roles include: -# user, guest_collaborator, enterprise_owner, billing_manager +# Integrate with Edit this if statement if you need to add more GitHub roles. +# Integrate with Valid roles include: +# Integrate with user, guest_collaborator, enterprise_owner, billing_manager if ak_is_group_member(request.user, name='GitHub Admins'): roles.append({'value': 'enterprise_owner', 'primary': True}) else: diff --git a/website/integrations/services/github-organization/index.md b/website/integrations/services/github-organization/index.md index 3a406a58bd7b..23cf0ac68ffc 100644 --- a/website/integrations/services/github-organization/index.md +++ b/website/integrations/services/github-organization/index.md @@ -3,7 +3,7 @@ title: Integrate with GitHub Organization sidebar_label: GitHub Organization --- -# GitHub Organization +# Integrate with GitHub Organization Support level: Community diff --git a/website/integrations/services/gitlab/index.md b/website/integrations/services/gitlab/index.md index cb141f72eb38..87a3739e1b92 100644 --- a/website/integrations/services/gitlab/index.md +++ b/website/integrations/services/gitlab/index.md @@ -3,7 +3,7 @@ title: Integrate with GitLab sidebar_label: GitLab --- -# GitLab +# Integrate with GitLab Support level: authentik diff --git a/website/integrations/services/glitchtip/index.md b/website/integrations/services/glitchtip/index.md index 810625c9afb0..495071afbb7d 100644 --- a/website/integrations/services/glitchtip/index.md +++ b/website/integrations/services/glitchtip/index.md @@ -3,7 +3,7 @@ title: Integrate with Glitchtip sidebar_label: Glitchtip --- -# Glitchtip +# Integrate with Glitchtip Support level: Community diff --git a/website/integrations/services/globalprotect/index.md b/website/integrations/services/globalprotect/index.md index 16ae538b3c32..faa18139834b 100644 --- a/website/integrations/services/globalprotect/index.md +++ b/website/integrations/services/globalprotect/index.md @@ -3,7 +3,7 @@ title: Integrate with GlobalProtect sidebar_label: GlobalProtect --- -# GlobalProtect +# Integrate with GlobalProtect Support level: Community diff --git a/website/integrations/services/google/index.md b/website/integrations/services/google/index.md index 24b8375e9244..3e8e4a76cc78 100644 --- a/website/integrations/services/google/index.md +++ b/website/integrations/services/google/index.md @@ -3,7 +3,7 @@ title: Integrate with Google Workspace sidebar_label: Google Workspace --- -# Google Workspace +# Integrate with Google Workspace Support level: authentik diff --git a/website/integrations/services/grafana/index.mdx b/website/integrations/services/grafana/index.mdx index 94d3423742c4..6965ae944e1a 100644 --- a/website/integrations/services/grafana/index.mdx +++ b/website/integrations/services/grafana/index.mdx @@ -3,7 +3,7 @@ title: Integrate with Grafana sidebar_label: Grafana --- -# Grafana +# Integrate with Grafana Support level: authentik diff --git a/website/integrations/services/gravitee/index.md b/website/integrations/services/gravitee/index.md index 5df4a0776fda..0917e3a87fd9 100644 --- a/website/integrations/services/gravitee/index.md +++ b/website/integrations/services/gravitee/index.md @@ -3,7 +3,7 @@ title: Integrate with Gravitee sidebar_label: Gravitee --- -# Gravitee +# Integrate with Gravitee Support level: Community diff --git a/website/integrations/services/harbor/index.md b/website/integrations/services/harbor/index.md index 6e68589105ca..7a38909fa2e4 100644 --- a/website/integrations/services/harbor/index.md +++ b/website/integrations/services/harbor/index.md @@ -3,7 +3,7 @@ title: Integrate with Harbor sidebar_label: Harbor --- -# Harbor +# Integrate with Harbor Support level: Community diff --git a/website/integrations/services/hashicorp-cloud/index.md b/website/integrations/services/hashicorp-cloud/index.md index d005af8c4da1..6cf2015fc819 100644 --- a/website/integrations/services/hashicorp-cloud/index.md +++ b/website/integrations/services/hashicorp-cloud/index.md @@ -3,7 +3,7 @@ title: Integrate with HashiCorp Cloud Platform sidebar_label: HashiCorp Cloud Platform --- -# HashiCorp Cloud Platform +# Integrate with HashiCorp Cloud Platform Support level: Community diff --git a/website/integrations/services/hashicorp-vault/index.md b/website/integrations/services/hashicorp-vault/index.md index d2eace300631..83518ef26a8c 100644 --- a/website/integrations/services/hashicorp-vault/index.md +++ b/website/integrations/services/hashicorp-vault/index.md @@ -3,7 +3,7 @@ title: Integrate with Hashicorp Vault sidebar_label: Hashicorp Vault --- -# Hashicorp Vault +# Integrate with Hashicorp Vault Support level: authentik diff --git a/website/integrations/services/hedgedoc/index.md b/website/integrations/services/hedgedoc/index.md index 1d72c9cdea6f..d50f3104b780 100644 --- a/website/integrations/services/hedgedoc/index.md +++ b/website/integrations/services/hedgedoc/index.md @@ -3,7 +3,7 @@ title: Integrate with HedgeDoc sidebar_label: HedgeDoc --- -# HedgeDoc +# Integrate with HedgeDoc Support level: Community diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md index 9b5b40319b54..120fda1157b3 100644 --- a/website/integrations/services/hoarder/index.md +++ b/website/integrations/services/hoarder/index.md @@ -3,7 +3,7 @@ title: Integrate with Hoarder sidebar_label: Hoarder --- -# Hoarder +# Integrate with Hoarder Support level: Community @@ -47,10 +47,10 @@ OAUTH_CLIENT_SECRET= OAUTH_WELLKNOWN_URL=https://authentik.company/application/o/hoarder/.well-known/openid-configuration OAUTH_PROVIDER_NAME=authentik OAUTH_ALLOW_DANGEROUS_EMAIL_ACCOUNT_LINKING=true -# Optional: You can add this if you only want to allow login with Authentik -# DISABLE_PASSWORD_AUTH=true -# Optional but highly recommended: -# DISABLE_SIGNUPS=true +# Integrate with Optional: You can add this if you only want to allow login with Authentik +# Integrate with DISABLE_PASSWORD_AUTH=true +# Integrate with Optional but highly recommended: +# Integrate with DISABLE_SIGNUPS=true ``` Finally, restart the Hoarder server and test your configuration. diff --git a/website/integrations/services/home-assistant/index.md b/website/integrations/services/home-assistant/index.md index f900445f63a5..81966c5b902f 100644 --- a/website/integrations/services/home-assistant/index.md +++ b/website/integrations/services/home-assistant/index.md @@ -3,7 +3,7 @@ title: Integrate with Home Assistant sidebar_label: Home Assistant --- -# Home Assistant +# Integrate with Home Assistant Support level: Community diff --git a/website/integrations/services/immich/index.md b/website/integrations/services/immich/index.md index 517d1f79d919..16996668ad75 100644 --- a/website/integrations/services/immich/index.md +++ b/website/integrations/services/immich/index.md @@ -3,7 +3,7 @@ title: Integrate with Immich sidebar_label: Immich --- -# Immich +# Integrate with Immich Support level: Community diff --git a/website/integrations/services/jellyfin/index.md b/website/integrations/services/jellyfin/index.md index 4197eb44bf31..34e6dc2b4a67 100644 --- a/website/integrations/services/jellyfin/index.md +++ b/website/integrations/services/jellyfin/index.md @@ -3,7 +3,7 @@ title: Integrate with Jellyfin sidebar_label: Jellyfin --- -# Jellyfin +# Integrate with Jellyfin Support level: Community diff --git a/website/integrations/services/jenkins/index.md b/website/integrations/services/jenkins/index.md index f31a4a8c337d..2f6b591b0f84 100644 --- a/website/integrations/services/jenkins/index.md +++ b/website/integrations/services/jenkins/index.md @@ -3,7 +3,7 @@ title: Integrate with Jenkins sidebar_label: Jenkins --- -# Jenkins +# Integrate with Jenkins Support level: Community diff --git a/website/integrations/services/kimai/index.md b/website/integrations/services/kimai/index.md index b636f72ddf52..6fbaf3e72dff 100644 --- a/website/integrations/services/kimai/index.md +++ b/website/integrations/services/kimai/index.md @@ -3,7 +3,7 @@ title: Integrate with Kimai sidebar_label: Kimai --- -# Kimai +# Integrate with Kimai Support level: Community @@ -39,11 +39,11 @@ Paste the following block in your `local.yaml` file, after replacing the placeho To get the value for `x509cert`, go to _System_ > _Certificates_, and download the public Signing Certificate. To avoid further problems, concat it into "string format" using e.g.: https://www.samltool.com/format_x509cert.php ```yaml -# Optionally add this for docker debug-logging -# monolog: -# handlers: -# main: -# path: php://stderr +# Integrate with Optionally add this for docker debug-logging +# Integrate with monolog: +# Integrate with handlers: +# Integrate with main: +# Integrate with path: php://stderr kimai: saml: diff --git a/website/integrations/services/komga/index.md b/website/integrations/services/komga/index.md index aedac93af0d0..2046021d77f5 100644 --- a/website/integrations/services/komga/index.md +++ b/website/integrations/services/komga/index.md @@ -3,7 +3,7 @@ title: Integrate with Komga sidebar_label: Komga --- -# Komga +# Integrate with Komga Support level: Community diff --git a/website/integrations/services/linkwarden/index.md b/website/integrations/services/linkwarden/index.md index 232ddea020fa..f62fcace03f4 100644 --- a/website/integrations/services/linkwarden/index.md +++ b/website/integrations/services/linkwarden/index.md @@ -3,7 +3,7 @@ title: Integrate with Linkwarden sidebar_label: Linkwarden --- -# Linkwarden +# Integrate with Linkwarden Support level: Community diff --git a/website/integrations/services/mastodon/index.md b/website/integrations/services/mastodon/index.md index c89dd30260e8..ca5cdaae44f6 100644 --- a/website/integrations/services/mastodon/index.md +++ b/website/integrations/services/mastodon/index.md @@ -3,7 +3,7 @@ title: Integrate with Mastodon sidebar_label: Mastodon --- -# Mastodon +# Integrate with Mastodon Support level: Community diff --git a/website/integrations/services/matrix-synapse/index.md b/website/integrations/services/matrix-synapse/index.md index d07ff8af7d57..fffb61e81d98 100644 --- a/website/integrations/services/matrix-synapse/index.md +++ b/website/integrations/services/matrix-synapse/index.md @@ -3,7 +3,7 @@ title: Integrate with Matrix Synapse sidebar_label: Matrix Synapse --- -# Matrix Synapse +# Integrate with Matrix Synapse Support level: Community diff --git a/website/integrations/services/meshcentral/index.md b/website/integrations/services/meshcentral/index.md index 263d469e9641..f6588b386910 100644 --- a/website/integrations/services/meshcentral/index.md +++ b/website/integrations/services/meshcentral/index.md @@ -3,6 +3,8 @@ title: Integrate with MeshCentral sidebar_label: MeshCentral --- +# Integrate with MeshCentral + Support level: Community ## What is MeshCentral @@ -35,7 +37,7 @@ Next, create an application, using the provider you've created above. Edit the `config.json` file for your MeshCentral deployment, and add the following code in the `domains:` subsection: -:::info +:::info For Docker deployments, the `config.json` should be located in the directory on the host machine you mapped to `/opt/meshcentral/meshcentral-data`. ::: diff --git a/website/integrations/services/minio/index.md b/website/integrations/services/minio/index.md index 2b4ab3c9a800..93d80b78c7c7 100644 --- a/website/integrations/services/minio/index.md +++ b/website/integrations/services/minio/index.md @@ -3,7 +3,7 @@ title: Integrate with MinIO sidebar_label: MinIO --- -# MinIO +# Integrate with MinIO Support level: authentik diff --git a/website/integrations/services/mobilizon/index.md b/website/integrations/services/mobilizon/index.md index 3d03b9e8cf9a..832d5abec6eb 100644 --- a/website/integrations/services/mobilizon/index.md +++ b/website/integrations/services/mobilizon/index.md @@ -3,7 +3,7 @@ title: Integrate with Mobilizon sidebar_label: Mobilizon --- -# Mobilizon +# Integrate with Mobilizon Support level: Community diff --git a/website/integrations/services/netbird/index.md b/website/integrations/services/netbird/index.md index 687a8bbe3bc2..5e21f98d23bc 100644 --- a/website/integrations/services/netbird/index.md +++ b/website/integrations/services/netbird/index.md @@ -3,7 +3,7 @@ title: Integrate with NetBird sidebar_label: NetBird --- -# NetBird +# Integrate with NetBird Support level: Community diff --git a/website/integrations/services/netbox/index.md b/website/integrations/services/netbox/index.md index 789cb2f800af..f9b98af9e28b 100644 --- a/website/integrations/services/netbox/index.md +++ b/website/integrations/services/netbox/index.md @@ -3,7 +3,7 @@ title: Integrate with NetBox sidebar_label: NetBox --- -# NetBox +# Integrate with NetBox Support level: Community @@ -38,11 +38,11 @@ This setup was tested and developed with NetBox Docker. For a non-Docker install The following Docker env vars are required for the configuration. ```env -# Enable python-social-auth +# Integrate with Enable python-social-auth REMOTE_AUTH_ENABLED='true' REMOTE_AUTH_BACKEND='social_core.backends.open_id_connect.OpenIdConnectAuth' -# python-social-auth config +# Integrate with python-social-auth config SOCIAL_AUTH_OIDC_ENDPOINT='https://authentik.company/application/o//' SOCIAL_AUTH_OIDC_KEY='' SOCIAL_AUTH_OIDC_SECRET='' @@ -56,10 +56,10 @@ The Netbox configuration needs to be extended, for this you can create a new fil from os import environ ############# -# Docker +# Integrate with Docker ############# -# python-social-auth configuration +# Integrate with python-social-auth configuration SOCIAL_AUTH_OIDC_ENDPOINT = environ.get('SOCIAL_AUTH_OIDC_ENDPOINT') SOCIAL_AUTH_OIDC_KEY = environ.get('SOCIAL_AUTH_OIDC_KEY') SOCIAL_AUTH_OIDC_SECRET = environ.get('SOCIAL_AUTH_OIDC_SECRET') @@ -68,14 +68,14 @@ LOGOUT_REDIRECT_URL = environ.get('LOGOUT_REDIRECT_URL') ############# -# non Docker +# Integrate with non Docker ############# -# NetBox settings +# Integrate with NetBox settings #REMOTE_AUTH_ENABLED = True #REMOTE_AUTH_BACKEND = 'social_core.backends.open_id_connect.OpenIdConnectAuth' -# python-social-auth configuration +# Integrate with python-social-auth configuration #SOCIAL_AUTH_OIDC_ENDPOINT = 'https://authentik.company/application/o/= 4.0.0 class AuthFailed(Exception): diff --git a/website/integrations/services/nextcloud/index.md b/website/integrations/services/nextcloud/index.md index f0b3a35a08cb..6e31473bde8a 100644 --- a/website/integrations/services/nextcloud/index.md +++ b/website/integrations/services/nextcloud/index.md @@ -3,7 +3,7 @@ title: Integrate with Nextcloud sidebar_label: Nextcloud --- -# Nextcloud +# Integrate with Nextcloud Support level: Community @@ -68,13 +68,13 @@ However, if you want to be able to control how much storage users in Nextcloud c - Expression: ```python -# Extract all groups the user is a member of +# Integrate with Extract all groups the user is a member of groups = [group.name for group in user.ak_groups.all()] -# Nextcloud admins must be members of a group called "admin". -# This is static and cannot be changed. -# We append a fictional "admin" group to the user's groups if they are an admin in authentik. -# This group would only be visible in Nextcloud and does not exist in authentik. +# Integrate with Nextcloud admins must be members of a group called "admin". +# Integrate with This is static and cannot be changed. +# Integrate with We append a fictional "admin" group to the user's groups if they are an admin in authentik. +# Integrate with This group would only be visible in Nextcloud and does not exist in authentik. if user.is_superuser and "admin" not in groups: groups.append("admin") diff --git a/website/integrations/services/node-red/index.md b/website/integrations/services/node-red/index.md index b86fcad2713c..44f2a6bc0699 100644 --- a/website/integrations/services/node-red/index.md +++ b/website/integrations/services/node-red/index.md @@ -3,7 +3,7 @@ title: Integrate with Node-RED sidebar_label: Node-RED --- -# Node-RED +# Integrate with Node-RED Support level: Community diff --git a/website/integrations/services/observium/index.md b/website/integrations/services/observium/index.md index dd16f291df00..3f7540bb24aa 100644 --- a/website/integrations/services/observium/index.md +++ b/website/integrations/services/observium/index.md @@ -3,7 +3,7 @@ title: Integrate with Observium sidebar_label: Observium --- -# Observium +# Integrate with Observium Support level: Community diff --git a/website/integrations/services/onlyoffice/index.md b/website/integrations/services/onlyoffice/index.md index 79cb0d552d9f..28ce9cc03c9f 100644 --- a/website/integrations/services/onlyoffice/index.md +++ b/website/integrations/services/onlyoffice/index.md @@ -3,7 +3,7 @@ title: Integrate with OnlyOffice sidebar_label: OnlyOffice --- -# OnlyOffice +# Integrate with OnlyOffice Support level: Community diff --git a/website/integrations/services/opnsense/index.md b/website/integrations/services/opnsense/index.md index f476240e2ce3..5aaa6b16c1cf 100644 --- a/website/integrations/services/opnsense/index.md +++ b/website/integrations/services/opnsense/index.md @@ -3,7 +3,7 @@ title: Integrate with OPNsense sidebar_label: OPNsense --- -# OPNsense +# Integrate with OPNsense Support level: Community diff --git a/website/integrations/services/oracle-cloud/index.md b/website/integrations/services/oracle-cloud/index.md index 5d18382ef78f..1c4c72963fc8 100644 --- a/website/integrations/services/oracle-cloud/index.md +++ b/website/integrations/services/oracle-cloud/index.md @@ -3,7 +3,7 @@ title: Integrate with Oracle Cloud sidebar_label: Oracle Cloud --- -# Oracle Cloud +# Integrate with Oracle Cloud Support level: Community diff --git a/website/integrations/services/organizr/index.md b/website/integrations/services/organizr/index.md index 7471d4d80049..2fda3e232d70 100644 --- a/website/integrations/services/organizr/index.md +++ b/website/integrations/services/organizr/index.md @@ -3,7 +3,7 @@ title: Integrate with organizr sidebar_label: organizr --- -# organizr +# Integrate with organizr Support level: Community diff --git a/website/integrations/services/outline/index.md b/website/integrations/services/outline/index.md index 51b198e8a616..700554a71926 100644 --- a/website/integrations/services/outline/index.md +++ b/website/integrations/services/outline/index.md @@ -3,7 +3,7 @@ title: Integrate with Outline sidebar_label: Outline --- -# Outline +# Integrate with Outline Support level: Community diff --git a/website/integrations/services/paperless-ng/index.md b/website/integrations/services/paperless-ng/index.md index b04275f2370f..78b4593a81b7 100644 --- a/website/integrations/services/paperless-ng/index.md +++ b/website/integrations/services/paperless-ng/index.md @@ -3,7 +3,7 @@ title: Integrate with Paperless-ng sidebar_label: Paperless-ng --- -# Paperless-ng +# Integrate with Paperless-ng Support level: Community diff --git a/website/integrations/services/paperless-ngx/index.mdx b/website/integrations/services/paperless-ngx/index.mdx index 8061fa07d609..d817afdcf497 100644 --- a/website/integrations/services/paperless-ngx/index.mdx +++ b/website/integrations/services/paperless-ngx/index.mdx @@ -3,7 +3,7 @@ title: Integrate with Paperless-ngx sidebar_label: Paperless-ngx --- -# Paperless-ngx +# Integrate with Paperless-ngx Support level: Community diff --git a/website/integrations/services/pfsense/index.md b/website/integrations/services/pfsense/index.md index 06c3f2ab40a8..ef3309473203 100644 --- a/website/integrations/services/pfsense/index.md +++ b/website/integrations/services/pfsense/index.md @@ -3,7 +3,7 @@ title: Integrate with pfSense sidebar_label: pfSense --- -# pfSense +# Integrate with pfSense Support level: Community diff --git a/website/integrations/services/pgadmin/index.md b/website/integrations/services/pgadmin/index.md index 1a6153fcdedb..e2cc8cd83c3b 100644 --- a/website/integrations/services/pgadmin/index.md +++ b/website/integrations/services/pgadmin/index.md @@ -3,7 +3,7 @@ title: Integrate with pgAdmin sidebar_label: pgAdmin --- -# pgAdmin +# Integrate with pgAdmin Support level: Community @@ -24,7 +24,7 @@ The following placeholders are used in this guide: - `pgadmin.company` is the FQDN of pgAdmin. - `authentik.company` is the FQDN of authentik. -# authentik configuration +# Integrate with authentik configuration 1. From the Admin interface, navigate to **Applications** -> **Applications**. 2. Use the wizard to create a new application and provider. During this process: diff --git a/website/integrations/services/phpipam/index.md b/website/integrations/services/phpipam/index.md index 38b66f038530..956d5066bc93 100644 --- a/website/integrations/services/phpipam/index.md +++ b/website/integrations/services/phpipam/index.md @@ -3,7 +3,7 @@ title: Integrate with phpIPAM sidebar_label: phpIPAM --- -# phpIPAM +# Integrate with phpIPAM Support level: Community diff --git a/website/integrations/services/portainer/index.md b/website/integrations/services/portainer/index.md index 1e3672f35932..feddc02b536b 100644 --- a/website/integrations/services/portainer/index.md +++ b/website/integrations/services/portainer/index.md @@ -3,7 +3,7 @@ title: Integrate with Portainer sidebar_label: Portainer --- -# Portainer +# Integrate with Portainer Support level: Community diff --git a/website/integrations/services/powerdns-admin/index.md b/website/integrations/services/powerdns-admin/index.md index 4946c3c987f4..424bfc392dfe 100644 --- a/website/integrations/services/powerdns-admin/index.md +++ b/website/integrations/services/powerdns-admin/index.md @@ -3,7 +3,7 @@ title: Integrate with PowerDNS-Admin sidebar_label: PowerDNS-Admin --- -# PowerDNS-Admin +# Integrate with PowerDNS-Admin Support level: Community diff --git a/website/integrations/services/proftpd/index.md b/website/integrations/services/proftpd/index.md index 9013499c8de8..11819c5aece1 100644 --- a/website/integrations/services/proftpd/index.md +++ b/website/integrations/services/proftpd/index.md @@ -3,7 +3,7 @@ title: Integrate with ProFTPD sidebar_label: ProFTPD --- -# ProFTPD +# Integrate with ProFTPD Support level: Community diff --git a/website/integrations/services/proxmox-ve/index.md b/website/integrations/services/proxmox-ve/index.md index 62e40a2213d9..b6cf519bc81b 100644 --- a/website/integrations/services/proxmox-ve/index.md +++ b/website/integrations/services/proxmox-ve/index.md @@ -3,7 +3,7 @@ title: Integrate with Proxmox VE sidebar_label: Proxmox VE --- -# Proxmox VE +# Integrate with Proxmox VE Support level: Community diff --git a/website/integrations/services/qnap-nas/index.md b/website/integrations/services/qnap-nas/index.md index 74bb262dd1c9..2efee55d8929 100644 --- a/website/integrations/services/qnap-nas/index.md +++ b/website/integrations/services/qnap-nas/index.md @@ -3,7 +3,7 @@ title: Integrate with QNAP NAS sidebar_label: QNAP NAS --- -# QNAP NAS +# Integrate with QNAP NAS ## What is QNAP NAS @@ -140,20 +140,20 @@ ssl on rootbinddn cn=${qnap.serviceAccount},ou=users,${ldap.baseDN} nss_schema rfc2307bis -# remap object classes to authentik ones +# Integrate with remap object classes to authentik ones nss_map_objectclass posixAccount user nss_map_objectclass shadowAccount user nss_map_objectclass posixGroup group -# remap attributes -# uid to cn is essential otherwise only id usernames will occur +# Integrate with remap attributes +# Integrate with uid to cn is essential otherwise only id usernames will occur nss_map_attribute uid cn -# map displayName information into comments field +# Integrate with map displayName information into comments field nss_map_attribute gecos displayName -# see https://ldapwiki.com/wiki/GroupOfUniqueNames%20vs%20groupOfNames +# Integrate with see https://ldapwiki.com/wiki/GroupOfUniqueNames%20vs%20groupOfNames nss_map_attribute uniqueMember member -# configure scope per search filter +# Integrate with configure scope per search filter nss_base_passwd ou=users,${ldap.baseDN}?one nss_base_shadow ou=users,${ldap.baseDN}?one nss_base_group ou=groups,${ldap.baseDN}?one @@ -176,14 +176,14 @@ Now start the LDAP Service: To see if connection is working, type ```bash -# list users +# Integrate with list users $ getent passwd ``` The output should list local users and authentik accounts. ```bash -# list groups +# Integrate with list groups $ getent group ``` diff --git a/website/integrations/services/rancher/index.md b/website/integrations/services/rancher/index.md index 913a4b06a7fa..e1b888fd4db6 100644 --- a/website/integrations/services/rancher/index.md +++ b/website/integrations/services/rancher/index.md @@ -3,7 +3,7 @@ title: Integrate with Rancher sidebar_label: Rancher --- -# Rancher +# Integrate with Rancher Support level: authentik diff --git a/website/integrations/services/rocketchat/index.md b/website/integrations/services/rocketchat/index.md index e440d9490544..9f7f0097302b 100644 --- a/website/integrations/services/rocketchat/index.md +++ b/website/integrations/services/rocketchat/index.md @@ -3,7 +3,7 @@ title: Integrate with Rocket.chat sidebar_label: Rocket.chat --- -# Rocket.chat +# Integrate with Rocket.chat Support level: Community diff --git a/website/integrations/services/roundcube/index.md b/website/integrations/services/roundcube/index.md index 25afea4f81dc..c55079d64bd9 100644 --- a/website/integrations/services/roundcube/index.md +++ b/website/integrations/services/roundcube/index.md @@ -3,7 +3,7 @@ title: Integrate with Roundcube sidebar_label: Roundcube --- -# Roundcube +# Integrate with Roundcube Support level: Community diff --git a/website/integrations/services/rustdesk-pro/index.mdx b/website/integrations/services/rustdesk-pro/index.mdx index 15272b013ce1..f35fb4dfe213 100644 --- a/website/integrations/services/rustdesk-pro/index.mdx +++ b/website/integrations/services/rustdesk-pro/index.mdx @@ -3,14 +3,14 @@ title: Integrate with RustDesk Server Pro sidebar_label: RustDesk Server Pro --- -# RustDesk Server Pro +# Integrate with RustDesk Server Pro Support level: Community ## What is RustDesk Server Pro? -> RustDesk Server Pro is a premium self-hosted solution for managing remote desktop connections securely and efficiently. -> It offers enhanced performance, advanced security features, and customization options like branding to meet professional needs. +> RustDesk Server Pro is a premium self-hosted solution for managing remote desktop connections securely and efficiently. +> It offers enhanced performance, advanced security features, and customization options like branding to meet professional needs. > Ideal for businesses, it provides full control over data while ensuring scalable and reliable remote access. > > -- https://rustdesk.com/ diff --git a/website/integrations/services/semaphore/index.mdx b/website/integrations/services/semaphore/index.mdx index a347108ffbdd..0a8935594f04 100644 --- a/website/integrations/services/semaphore/index.mdx +++ b/website/integrations/services/semaphore/index.mdx @@ -3,7 +3,7 @@ title: Integrate with Semaphore UI sidebar_label: Semaphore --- -# Semaphore UI +# Integrate with Semaphore UI Support level: Community diff --git a/website/integrations/services/semgrep/index.md b/website/integrations/services/semgrep/index.md index 84eb148e359c..2b2ba71ff1bd 100644 --- a/website/integrations/services/semgrep/index.md +++ b/website/integrations/services/semgrep/index.md @@ -3,7 +3,7 @@ title: Integrate with Semgrep sidebar_label: Semgrep --- -# Semgrep +# Integrate with Semgrep Support level: Community diff --git a/website/integrations/services/sentry/index.md b/website/integrations/services/sentry/index.md index 2832af77477e..f17325b616f8 100644 --- a/website/integrations/services/sentry/index.md +++ b/website/integrations/services/sentry/index.md @@ -3,7 +3,7 @@ title: Integrate with Sentry sidebar_label: Sentry --- -# Sentry +# Integrate with Sentry Support level: authentik diff --git a/website/integrations/services/sharepoint-se/index.md b/website/integrations/services/sharepoint-se/index.md index a7a5de807323..22514ff3cdef 100644 --- a/website/integrations/services/sharepoint-se/index.md +++ b/website/integrations/services/sharepoint-se/index.md @@ -3,7 +3,7 @@ title: Integrate with SharePoint Server SE sidebar_label: SharePoint Server SE --- -# SharePoint Server SE +# Integrate with SharePoint Server SE Support level: Community @@ -189,7 +189,7 @@ The following PowerShell script must be updated according to your environment an ```PowerShell Add-PSSnapin microsoft.sharepoint.powershell -# Setup farm properties to work with OIDC +# Integrate with Setup farm properties to work with OIDC $cert = New-SelfSignedCertificate -CertStoreLocation Cert:\LocalMachine\My -Provider 'Microsoft Enhanced RSA and AES Cryptographic Provider' -Subject "CN=SharePoint Cookie Cert" $rsaCert = [System.Security.Cryptography.X509Certificates.RSACertificateExtensions]::GetRSAPrivateKey($cert) $fileName = $rsaCert.key.UniqueName @@ -240,13 +240,13 @@ The following PowerShell script must be updated according to your environment an ```PowerShell Add-PSSnapin microsoft.sharepoint.powershell -# OIDC Settings +# Integrate with OIDC Settings $metadataendpointurl = "auth.providerConfigURL" $clientIdentifier = "auth.providerClientID" $trustedTokenIssuerName = "sp.issuerName" $trustedTokenIssuerDescription = "sp.issuerDesc" -# OIDC Claims Mapping +# Integrate with OIDC Claims Mapping ## Identity claim: oid => defined within the Authentik scope mapping $idClaim = New-SPClaimTypeMapping "http://schemas.microsoft.com/identity/claims/objectidentifier" -IncomingClaimTypeDisplayName "oid" -SameAsIncoming @@ -264,11 +264,11 @@ $claims = @( ) -# Trust 3rd party identity token issuer +# Integrate with Trust 3rd party identity token issuer $trustedTokenIssuer = New-SPTrustedIdentityTokenIssuer -Name $trustedTokenIssuerName -Description $trustedTokenIssuerDescription -ClaimsMappings $claims -IdentifierClaim $idClaim.InputClaimType -DefaultClientIdentifier $clientIdentifier -MetadataEndPoint $metadataendpointurl -Scope "openid email profile" #Note: Remove the profile scope if you plan to use the LDAPCP claims augmentation. -# Create the SharePoint authentication provider based on the trusted token issuer +# Integrate with Create the SharePoint authentication provider based on the trusted token issuer New-SPAuthenticationProvider -TrustedIdentityTokenIssuer $trustedTokenIssuer ``` diff --git a/website/integrations/services/skyhigh/index.md b/website/integrations/services/skyhigh/index.md index 88202d190775..e7631cd15588 100644 --- a/website/integrations/services/skyhigh/index.md +++ b/website/integrations/services/skyhigh/index.md @@ -3,7 +3,7 @@ title: Integrate with Skyhigh Security sidebar_label: Skyhigh Security --- -# Skyhigh Security +# Integrate with Skyhigh Security Support level: Community diff --git a/website/integrations/services/slack/index.md b/website/integrations/services/slack/index.md index 3410a8bf7766..ce0390678b24 100644 --- a/website/integrations/services/slack/index.md +++ b/website/integrations/services/slack/index.md @@ -3,7 +3,7 @@ title: Integrate with Slack sidebar_label: Slack --- -# Slack +# Integrate with Slack Support level: authentik diff --git a/website/integrations/services/snipe-it/index.md b/website/integrations/services/snipe-it/index.md index dc795b53c42f..bb772afa5ee0 100644 --- a/website/integrations/services/snipe-it/index.md +++ b/website/integrations/services/snipe-it/index.md @@ -3,7 +3,7 @@ title: Integrate with Snipe-IT sidebar_label: Snipe-IT --- -# Snipe-IT +# Integrate with Snipe-IT Support level: Community diff --git a/website/integrations/services/sonar-qube/index.md b/website/integrations/services/sonar-qube/index.md index 1e7a3af807f5..49bfdedd750e 100644 --- a/website/integrations/services/sonar-qube/index.md +++ b/website/integrations/services/sonar-qube/index.md @@ -3,7 +3,7 @@ title: Integrate with SonarQube sidebar_label: SonarQube --- -# SonarQube +# Integrate with SonarQube Support level: Community diff --git a/website/integrations/services/sonarr/index.md b/website/integrations/services/sonarr/index.md index b781b943d9ea..23a866597277 100644 --- a/website/integrations/services/sonarr/index.md +++ b/website/integrations/services/sonarr/index.md @@ -3,7 +3,7 @@ title: Integrate with Sonarr sidebar_label: Sonarr --- -# Sonarr +# Integrate with Sonarr Support level: Community diff --git a/website/integrations/services/sssd/index.md b/website/integrations/services/sssd/index.md index c318dc66ff4f..adee4e30c69c 100644 --- a/website/integrations/services/sssd/index.md +++ b/website/integrations/services/sssd/index.md @@ -3,7 +3,7 @@ title: Integrate with sssd sidebar_label: sssd --- -# sssd +# Integrate with sssd Support level: Community @@ -102,7 +102,7 @@ ldap_user_name = cn ldap_group_object_class = group ldap_group_name = cn -# Optionally, filter logins to only a specific group +# Integrate with Optionally, filter logins to only a specific group #ldap_access_order = filter #ldap_access_filter = memberOf=cn=authentik Admins,ou=groups,${ldap.baseDN} diff --git a/website/integrations/services/synology-dsm/index.md b/website/integrations/services/synology-dsm/index.md index d9b7b0a3ed5b..cf7f824aef70 100644 --- a/website/integrations/services/synology-dsm/index.md +++ b/website/integrations/services/synology-dsm/index.md @@ -3,7 +3,7 @@ title: Integrate with Synology DSM (DiskStation Manager) sidebar_label: Synology DSM (DiskStation Manager) --- -# Synology DSM (DiskStation Manager) +# Integrate with Synology DSM (DiskStation Manager) Support level: Community diff --git a/website/integrations/services/tautulli/index.md b/website/integrations/services/tautulli/index.md index 3ccf14fe6ecf..fff40049a6b8 100644 --- a/website/integrations/services/tautulli/index.md +++ b/website/integrations/services/tautulli/index.md @@ -3,7 +3,7 @@ title: Integrate with Tautulli sidebar_label: Tautulli --- -# Tautulli +# Integrate with Tautulli Support level: Community diff --git a/website/integrations/services/terrakube/index.md b/website/integrations/services/terrakube/index.md index 57a8311e3d75..194020ffd9bb 100644 --- a/website/integrations/services/terrakube/index.md +++ b/website/integrations/services/terrakube/index.md @@ -3,7 +3,7 @@ title: Integrate with Terrakube sidebar_label: Terrakube --- -# Terrakube +# Integrate with Terrakube Support level: Community diff --git a/website/integrations/services/thelounge/index.md b/website/integrations/services/thelounge/index.md index a5d7492de21d..6d249b453e8c 100644 --- a/website/integrations/services/thelounge/index.md +++ b/website/integrations/services/thelounge/index.md @@ -3,7 +3,7 @@ title: Integrate with The Lounge sidebar_label: The Lounge --- -# The Lounge +# Integrate with The Lounge Support level: Community diff --git a/website/integrations/services/truecommand/index.md b/website/integrations/services/truecommand/index.md index a1539b04c9a9..61be528388fe 100644 --- a/website/integrations/services/truecommand/index.md +++ b/website/integrations/services/truecommand/index.md @@ -3,7 +3,7 @@ title: Integrate with TrueNAS TrueCommand sidebar_label: TrueNAS TrueCommand --- -# TrueNAS TrueCommand +# Integrate with TrueNAS TrueCommand Support level: Community diff --git a/website/integrations/services/ubuntu-landscape/index.md b/website/integrations/services/ubuntu-landscape/index.md index ee3cc2218943..7d70df38dcb3 100644 --- a/website/integrations/services/ubuntu-landscape/index.md +++ b/website/integrations/services/ubuntu-landscape/index.md @@ -3,7 +3,7 @@ title: Integrate with Ubuntu Landscape sidebar_label: Ubuntu Landscape --- -# Ubuntu Landscape +# Integrate with Ubuntu Landscape Support level: Community diff --git a/website/integrations/services/uptime-kuma/index.md b/website/integrations/services/uptime-kuma/index.md index a0045c1feadb..4cd1d38db84a 100644 --- a/website/integrations/services/uptime-kuma/index.md +++ b/website/integrations/services/uptime-kuma/index.md @@ -3,7 +3,7 @@ title: Integrate with Uptime Kuma sidebar_label: Uptime Kuma --- -# Uptime Kuma +# Integrate with Uptime Kuma Support level: Community diff --git a/website/integrations/services/veeam-enterprise-manager/index.md b/website/integrations/services/veeam-enterprise-manager/index.md index a9c0828e532c..b3dfcab65796 100644 --- a/website/integrations/services/veeam-enterprise-manager/index.md +++ b/website/integrations/services/veeam-enterprise-manager/index.md @@ -3,7 +3,7 @@ title: Integrate with Veeam Enterprise Manager sidebar_label: Veeam Enterprise Manager --- -# Veeam Enterprise Manager +# Integrate with Veeam Enterprise Manager Support level: Community diff --git a/website/integrations/services/vikunja/index.md b/website/integrations/services/vikunja/index.md index 6cb283ff3da7..8f37cc0ff72e 100644 --- a/website/integrations/services/vikunja/index.md +++ b/website/integrations/services/vikunja/index.md @@ -3,7 +3,7 @@ title: Integrate with Vikunja sidebar_label: Vikunja --- -# Vikunja +# Integrate with Vikunja Support level: Community diff --git a/website/integrations/services/vmware-vcenter/index.md b/website/integrations/services/vmware-vcenter/index.md index 4d2b0cba9fee..d46c59ba2319 100644 --- a/website/integrations/services/vmware-vcenter/index.md +++ b/website/integrations/services/vmware-vcenter/index.md @@ -3,7 +3,7 @@ title: Integrate with VMware vCenter sidebar_label: VMware vCenter --- -# VMware vCenter +# Integrate with VMware vCenter Support level: Community diff --git a/website/integrations/services/weblate/index.md b/website/integrations/services/weblate/index.md index 11210bdcf65f..96379f38fc05 100644 --- a/website/integrations/services/weblate/index.md +++ b/website/integrations/services/weblate/index.md @@ -3,7 +3,7 @@ title: Integrate with Weblate sidebar_label: Weblate --- -# Weblate +# Integrate with Weblate Support level: Community diff --git a/website/integrations/services/wekan/index.mdx b/website/integrations/services/wekan/index.mdx index 68740c1c317b..99c054f3877e 100644 --- a/website/integrations/services/wekan/index.mdx +++ b/website/integrations/services/wekan/index.mdx @@ -3,7 +3,7 @@ title: Integrate with Wekan sidebar_label: Wekan --- -# Wekan +# Integrate with Wekan Support level: Community diff --git a/website/integrations/services/whats-up-docker/index.md b/website/integrations/services/whats-up-docker/index.md index 0e355203f6f3..d43dcb1a793f 100644 --- a/website/integrations/services/whats-up-docker/index.md +++ b/website/integrations/services/whats-up-docker/index.md @@ -3,7 +3,7 @@ title: Integrate with What's Up Docker sidebar_label: What's Up Docker --- -# What's Up Docker +# Integrate with What's Up Docker Support level: Community diff --git a/website/integrations/services/wiki-js/index.md b/website/integrations/services/wiki-js/index.md index 31847aaaec1e..5d4b3dbb27c1 100644 --- a/website/integrations/services/wiki-js/index.md +++ b/website/integrations/services/wiki-js/index.md @@ -3,7 +3,7 @@ title: Integrate with Wiki.js sidebar_label: Wiki.js --- -# Wiki.js +# Integrate with Wiki.js Support level: Community diff --git a/website/integrations/services/wordpress/index.md b/website/integrations/services/wordpress/index.md index 507c3880fb99..40440f99107b 100644 --- a/website/integrations/services/wordpress/index.md +++ b/website/integrations/services/wordpress/index.md @@ -3,7 +3,7 @@ title: Integrate with WordPress sidebar_label: WordPress --- -# WordPress +# Integrate with WordPress Support level: Community diff --git a/website/integrations/services/writefreely/index.md b/website/integrations/services/writefreely/index.md index 1c6ffcb9d769..223b55f50136 100644 --- a/website/integrations/services/writefreely/index.md +++ b/website/integrations/services/writefreely/index.md @@ -3,7 +3,7 @@ title: Integrate with Writefreely sidebar_label: Writefreely --- -# Writefreely +# Integrate with Writefreely Support level: Community diff --git a/website/integrations/services/xen-orchestra/index.md b/website/integrations/services/xen-orchestra/index.md index 11f30f8b5b3e..57240ef620bf 100644 --- a/website/integrations/services/xen-orchestra/index.md +++ b/website/integrations/services/xen-orchestra/index.md @@ -3,7 +3,7 @@ title: Integrate with Xen Orchestra sidebar_label: Xen Orchestra --- -# Xen Orchestra +# Integrate with Xen Orchestra Support level: Community diff --git a/website/integrations/services/zabbix/index.md b/website/integrations/services/zabbix/index.md index befb1a687343..1a7dab729dfb 100644 --- a/website/integrations/services/zabbix/index.md +++ b/website/integrations/services/zabbix/index.md @@ -3,7 +3,7 @@ title: Integrate with Zabbix sidebar_label: Zabbix --- -# Zabbix +# Integrate with Zabbix Support level: Community diff --git a/website/integrations/services/zammad/index.md b/website/integrations/services/zammad/index.md index f484993a2f0a..6694091c2449 100644 --- a/website/integrations/services/zammad/index.md +++ b/website/integrations/services/zammad/index.md @@ -3,7 +3,7 @@ title: Integrate with Zammad sidebar_label: Zammad --- -# Zammad +# Integrate with Zammad Support level: Community diff --git a/website/integrations/services/zulip/index.md b/website/integrations/services/zulip/index.md index 389e1ba302ef..9da67acd3203 100644 --- a/website/integrations/services/zulip/index.md +++ b/website/integrations/services/zulip/index.md @@ -3,7 +3,7 @@ title: Integrate with Zulip sidebar_label: Zulip --- -# Zulip +# Integrate with Zulip Support level: Community diff --git a/website/integrations/template/service.md b/website/integrations/template/service.md index 7a622a12e3c0..d7db4a422be8 100644 --- a/website/integrations/template/service.md +++ b/website/integrations/template/service.md @@ -3,7 +3,7 @@ title: Integrate with Service Name sidebar_label: Service Name --- -# Service Name +# Integrate with Service Name Support level: Community diff --git a/x.sh b/x.sh new file mode 100755 index 000000000000..ae1b29a3f578 --- /dev/null +++ b/x.sh @@ -0,0 +1,12 @@ +#!/bin/bash + +# Directory containing the markdown files +DIR="website/integrations/services" + +# Loop through all markdown files in the specified directory and subdirectories +find "$DIR" -type f -name "*.md" | while read -r file; do + # Use sed to update the header line in place + sed -i -E 's/^(# )(.*)/\1Integrate with \2/' "$file" +done + +echo "Headers updated in all markdown files in $DIR" From c81646ce45b5fd7d9c5b2c1d65a3c6f773183215 Mon Sep 17 00:00:00 2001 From: 4d62 Date: Wed, 22 Jan 2025 21:11:21 -0500 Subject: [PATCH 2/4] website/integrations-all: cleanup script --- x.sh | 12 ------------ 1 file changed, 12 deletions(-) delete mode 100755 x.sh diff --git a/x.sh b/x.sh deleted file mode 100755 index ae1b29a3f578..000000000000 --- a/x.sh +++ /dev/null @@ -1,12 +0,0 @@ -#!/bin/bash - -# Directory containing the markdown files -DIR="website/integrations/services" - -# Loop through all markdown files in the specified directory and subdirectories -find "$DIR" -type f -name "*.md" | while read -r file; do - # Use sed to update the header line in place - sed -i -E 's/^(# )(.*)/\1Integrate with \2/' "$file" -done - -echo "Headers updated in all markdown files in $DIR" From f24ac4cb5f33d159373a034cb5fe0688b96ee3c8 Mon Sep 17 00:00:00 2001 From: 4d62 Date: Thu, 23 Jan 2025 09:25:50 -0500 Subject: [PATCH 3/4] start ??? will do the rest in a sec --- website/integrations/services/qnap-nas/index.md | 10 +++++----- website/integrations/services/sharepoint-se/index.md | 10 +++++----- website/integrations/services/sssd/index.md | 2 +- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/website/integrations/services/qnap-nas/index.md b/website/integrations/services/qnap-nas/index.md index 2efee55d8929..d56e7f8a14c6 100644 --- a/website/integrations/services/qnap-nas/index.md +++ b/website/integrations/services/qnap-nas/index.md @@ -140,20 +140,20 @@ ssl on rootbinddn cn=${qnap.serviceAccount},ou=users,${ldap.baseDN} nss_schema rfc2307bis -# Integrate with remap object classes to authentik ones +# remap object classes to authentik ones nss_map_objectclass posixAccount user nss_map_objectclass shadowAccount user nss_map_objectclass posixGroup group -# Integrate with remap attributes -# Integrate with uid to cn is essential otherwise only id usernames will occur +# remap attributes +# uid to cn is essential otherwise only id usernames will occur nss_map_attribute uid cn # Integrate with map displayName information into comments field nss_map_attribute gecos displayName -# Integrate with see https://ldapwiki.com/wiki/GroupOfUniqueNames%20vs%20groupOfNames +# see https://ldapwiki.com/wiki/GroupOfUniqueNames%20vs%20groupOfNames nss_map_attribute uniqueMember member -# Integrate with configure scope per search filter +# configure scope per search filter nss_base_passwd ou=users,${ldap.baseDN}?one nss_base_shadow ou=users,${ldap.baseDN}?one nss_base_group ou=groups,${ldap.baseDN}?one diff --git a/website/integrations/services/sharepoint-se/index.md b/website/integrations/services/sharepoint-se/index.md index 22514ff3cdef..eede57e7a21c 100644 --- a/website/integrations/services/sharepoint-se/index.md +++ b/website/integrations/services/sharepoint-se/index.md @@ -189,7 +189,7 @@ The following PowerShell script must be updated according to your environment an ```PowerShell Add-PSSnapin microsoft.sharepoint.powershell -# Integrate with Setup farm properties to work with OIDC +# Setup farm properties to work with OIDC $cert = New-SelfSignedCertificate -CertStoreLocation Cert:\LocalMachine\My -Provider 'Microsoft Enhanced RSA and AES Cryptographic Provider' -Subject "CN=SharePoint Cookie Cert" $rsaCert = [System.Security.Cryptography.X509Certificates.RSACertificateExtensions]::GetRSAPrivateKey($cert) $fileName = $rsaCert.key.UniqueName @@ -240,13 +240,13 @@ The following PowerShell script must be updated according to your environment an ```PowerShell Add-PSSnapin microsoft.sharepoint.powershell -# Integrate with OIDC Settings +# OIDC Settings $metadataendpointurl = "auth.providerConfigURL" $clientIdentifier = "auth.providerClientID" $trustedTokenIssuerName = "sp.issuerName" $trustedTokenIssuerDescription = "sp.issuerDesc" -# Integrate with OIDC Claims Mapping +# OIDC Claims Mapping ## Identity claim: oid => defined within the Authentik scope mapping $idClaim = New-SPClaimTypeMapping "http://schemas.microsoft.com/identity/claims/objectidentifier" -IncomingClaimTypeDisplayName "oid" -SameAsIncoming @@ -264,11 +264,11 @@ $claims = @( ) -# Integrate with Trust 3rd party identity token issuer +# Trust 3rd party identity token issuer $trustedTokenIssuer = New-SPTrustedIdentityTokenIssuer -Name $trustedTokenIssuerName -Description $trustedTokenIssuerDescription -ClaimsMappings $claims -IdentifierClaim $idClaim.InputClaimType -DefaultClientIdentifier $clientIdentifier -MetadataEndPoint $metadataendpointurl -Scope "openid email profile" #Note: Remove the profile scope if you plan to use the LDAPCP claims augmentation. -# Integrate with Create the SharePoint authentication provider based on the trusted token issuer +# Create the SharePoint authentication provider based on the trusted token issuer New-SPAuthenticationProvider -TrustedIdentityTokenIssuer $trustedTokenIssuer ``` diff --git a/website/integrations/services/sssd/index.md b/website/integrations/services/sssd/index.md index adee4e30c69c..7ef3799f226a 100644 --- a/website/integrations/services/sssd/index.md +++ b/website/integrations/services/sssd/index.md @@ -102,7 +102,7 @@ ldap_user_name = cn ldap_group_object_class = group ldap_group_name = cn -# Integrate with Optionally, filter logins to only a specific group +# Optionally, filter logins to only a specific group #ldap_access_order = filter #ldap_access_filter = memberOf=cn=authentik Admins,ou=groups,${ldap.baseDN} From 9b77c28395eb8292e887cfed76737f8132399305 Mon Sep 17 00:00:00 2001 From: 4d62 Date: Thu, 23 Jan 2025 17:21:39 -0500 Subject: [PATCH 4/4] website/integrations-all: fix broken script website/integrations-all: fix website/integrations-all: fix website/integrations-all: fix website/integrations-all: fix --- website/integrations/services/aws/index.md | 4 +- .../integrations/services/bookstack/index.md | 38 +++++++++---------- .../services/github-enterprise-emu/index.md | 6 +-- .../github-enterprise-server/index.md | 6 +-- .../integrations/services/hoarder/index.md | 8 ++-- website/integrations/services/kimai/index.md | 10 ++--- website/integrations/services/netbox/index.md | 16 ++++---- .../integrations/services/nextcloud/index.md | 10 ++--- .../integrations/services/pgadmin/index.md | 2 +- .../integrations/services/qnap-nas/index.md | 6 +-- 10 files changed, 53 insertions(+), 53 deletions(-) diff --git a/website/integrations/services/aws/index.md b/website/integrations/services/aws/index.md index 89e920b1ed11..4b5f9bd9de59 100644 --- a/website/integrations/services/aws/index.md +++ b/website/integrations/services/aws/index.md @@ -148,8 +148,8 @@ Go back to your authentik instance - As the expression, enter: ```python -# Integrate with This expression strips the default mapping from its 'photos' attribute, -# Integrate with which is a forbidden property in AWS IAM. +# This expression strips the default mapping from its 'photos' attribute, +# which is a forbidden property in AWS IAM. return { "photos": None, } diff --git a/website/integrations/services/bookstack/index.md b/website/integrations/services/bookstack/index.md index b4ead4bbcb33..9382b7c2ba7c 100644 --- a/website/integrations/services/bookstack/index.md +++ b/website/integrations/services/bookstack/index.md @@ -70,34 +70,34 @@ Edit the `.env` file inside of the `www` folder of Bookstack. Modify the following Example SAML config and paste incorporate into your `.env` file ```bash -# Integrate with Set authentication method to be saml2 +# Set authentication method to be saml2 AUTH_METHOD=saml2 -# Integrate with Control if BookStack automatically initiates login via your SAML system if it's the only authentication method. -# Integrate with Prevents the need for the user to click the "Login with x" button on the login page. -# Integrate with Setting this to true enables auto-initiation. +# Control if BookStack automatically initiates login via your SAML system if it's the only authentication method. +# Prevents the need for the user to click the "Login with x" button on the login page. +# Setting this to true enables auto-initiation. AUTH_AUTO_INITIATE=true -# Integrate with Set the display name to be shown on the login button. -# Integrate with (Login with ) +# Set the display name to be shown on the login button. +# (Login with ) SAML2_NAME=authentik -# Integrate with Name of the attribute which provides the user's email address +# Name of the attribute which provides the user's email address SAML2_EMAIL_ATTRIBUTE=email -# Integrate with Name of the attribute to use as an ID for the SAML user. +# Name of the attribute to use as an ID for the SAML user. SAML2_EXTERNAL_ID_ATTRIBUTE=uid -# Integrate with Enable SAML group sync. +# Enable SAML group sync. SAML2_USER_TO_GROUPS=true -# Integrate with Set the attribute from which BookStack will read groups names from. -# Integrate with You will need to rename your roles in Bookstack to match your groups in authentik. +# Set the attribute from which BookStack will read groups names from. +# You will need to rename your roles in Bookstack to match your groups in authentik. SAML2_GROUP_ATTRIBUTE=http://schemas.xmlsoap.org/claims/Group -# Integrate with Name of the attribute(s) to use for the user's display name -# Integrate with Can have multiple attributes listed, separated with a '|' in which -# Integrate with case those values will be joined with a space. -# Integrate with Example: SAML2_DISPLAY_NAME_ATTRIBUTES=firstName|lastName -# Integrate with Defaults to the ID value if not found. +# Name of the attribute(s) to use for the user's display name +# Can have multiple attributes listed, separated with a '|' in which +# case those values will be joined with a space. +# Example: SAML2_DISPLAY_NAME_ATTRIBUTES=firstName|lastName +# Defaults to the ID value if not found. SAML2_DISPLAY_NAME_ATTRIBUTES=http://schemas.microsoft.com/ws/2008/06/identity/claims/windowsaccountname -# Integrate with Identity Provider entityID URL +# Identity Provider entityID URL SAML2_IDP_ENTITYID=METADATAURL -# Integrate with Auto-load metadata from the IDP -# Integrate with Setting this to true negates the need to specify the next three options +# Auto-load metadata from the IDP +# Setting this to true negates the need to specify the next three options SAML2_AUTOLOAD_METADATA=true ``` diff --git a/website/integrations/services/github-enterprise-emu/index.md b/website/integrations/services/github-enterprise-emu/index.md index 6593f3bee70f..397ffbbfff96 100644 --- a/website/integrations/services/github-enterprise-emu/index.md +++ b/website/integrations/services/github-enterprise-emu/index.md @@ -77,9 +77,9 @@ Before we create a SCIM provider, we also have to create a new Property Mapping. ```python roles = [] -# Integrate with Edit this if statement if you need to add more GitHub roles. -# Integrate with Valid roles include: -# Integrate with user, guest_collaborator, enterprise_owner, billing_manager +# Edit this if statement if you need to add more GitHub roles. +# Valid roles include: +# user, guest_collaborator, enterprise_owner, billing_manager if ak_is_group_member(request.user, name='GitHub Admins'): roles.append({'value': 'enterprise_owner', 'primary': True}) else: diff --git a/website/integrations/services/github-enterprise-server/index.md b/website/integrations/services/github-enterprise-server/index.md index 1ddedca68987..d7ce42df9712 100644 --- a/website/integrations/services/github-enterprise-server/index.md +++ b/website/integrations/services/github-enterprise-server/index.md @@ -68,9 +68,9 @@ Before we create a SCIM provider, we have to create a new Property Mapping. In a ```python roles = [] -# Integrate with Edit this if statement if you need to add more GitHub roles. -# Integrate with Valid roles include: -# Integrate with user, guest_collaborator, enterprise_owner, billing_manager +# Edit this if statement if you need to add more GitHub roles. +# Valid roles include: +# user, guest_collaborator, enterprise_owner, billing_manager if ak_is_group_member(request.user, name='GitHub Admins'): roles.append({'value': 'enterprise_owner', 'primary': True}) else: diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md index 120fda1157b3..c6ea66d914d5 100644 --- a/website/integrations/services/hoarder/index.md +++ b/website/integrations/services/hoarder/index.md @@ -47,10 +47,10 @@ OAUTH_CLIENT_SECRET= OAUTH_WELLKNOWN_URL=https://authentik.company/application/o/hoarder/.well-known/openid-configuration OAUTH_PROVIDER_NAME=authentik OAUTH_ALLOW_DANGEROUS_EMAIL_ACCOUNT_LINKING=true -# Integrate with Optional: You can add this if you only want to allow login with Authentik -# Integrate with DISABLE_PASSWORD_AUTH=true -# Integrate with Optional but highly recommended: -# Integrate with DISABLE_SIGNUPS=true +# Optional: You can add this if you only want to allow login with Authentik +# DISABLE_PASSWORD_AUTH=true +# Optional but highly recommended: +# DISABLE_SIGNUPS=true ``` Finally, restart the Hoarder server and test your configuration. diff --git a/website/integrations/services/kimai/index.md b/website/integrations/services/kimai/index.md index 6fbaf3e72dff..80f43639ac82 100644 --- a/website/integrations/services/kimai/index.md +++ b/website/integrations/services/kimai/index.md @@ -39,11 +39,11 @@ Paste the following block in your `local.yaml` file, after replacing the placeho To get the value for `x509cert`, go to _System_ > _Certificates_, and download the public Signing Certificate. To avoid further problems, concat it into "string format" using e.g.: https://www.samltool.com/format_x509cert.php ```yaml -# Integrate with Optionally add this for docker debug-logging -# Integrate with monolog: -# Integrate with handlers: -# Integrate with main: -# Integrate with path: php://stderr +# Optionally add this for docker debug-logging +# monolog: +# handlers: +# main: +# path: php://stderr kimai: saml: diff --git a/website/integrations/services/netbox/index.md b/website/integrations/services/netbox/index.md index f9b98af9e28b..b12d72236ceb 100644 --- a/website/integrations/services/netbox/index.md +++ b/website/integrations/services/netbox/index.md @@ -38,11 +38,11 @@ This setup was tested and developed with NetBox Docker. For a non-Docker install The following Docker env vars are required for the configuration. ```env -# Integrate with Enable python-social-auth +# Enable python-social-auth REMOTE_AUTH_ENABLED='true' REMOTE_AUTH_BACKEND='social_core.backends.open_id_connect.OpenIdConnectAuth' -# Integrate with python-social-auth config +# python-social-auth config SOCIAL_AUTH_OIDC_ENDPOINT='https://authentik.company/application/o//' SOCIAL_AUTH_OIDC_KEY='' SOCIAL_AUTH_OIDC_SECRET='' @@ -56,10 +56,10 @@ The Netbox configuration needs to be extended, for this you can create a new fil from os import environ ############# -# Integrate with Docker +# Docker ############# -# Integrate with python-social-auth configuration +# python-social-auth configuration SOCIAL_AUTH_OIDC_ENDPOINT = environ.get('SOCIAL_AUTH_OIDC_ENDPOINT') SOCIAL_AUTH_OIDC_KEY = environ.get('SOCIAL_AUTH_OIDC_KEY') SOCIAL_AUTH_OIDC_SECRET = environ.get('SOCIAL_AUTH_OIDC_SECRET') @@ -68,14 +68,14 @@ LOGOUT_REDIRECT_URL = environ.get('LOGOUT_REDIRECT_URL') ############# -# Integrate with non Docker +# non Docker ############# -# Integrate with NetBox settings +# NetBox settings #REMOTE_AUTH_ENABLED = True #REMOTE_AUTH_BACKEND = 'social_core.backends.open_id_connect.OpenIdConnectAuth' -# Integrate with python-social-auth configuration +# python-social-auth configuration #SOCIAL_AUTH_OIDC_ENDPOINT = 'https://authentik.company/application/o/= 4.0.0 class AuthFailed(Exception): diff --git a/website/integrations/services/nextcloud/index.md b/website/integrations/services/nextcloud/index.md index 6e31473bde8a..95ca560b1490 100644 --- a/website/integrations/services/nextcloud/index.md +++ b/website/integrations/services/nextcloud/index.md @@ -68,13 +68,13 @@ However, if you want to be able to control how much storage users in Nextcloud c - Expression: ```python -# Integrate with Extract all groups the user is a member of +# Extract all groups the user is a member of groups = [group.name for group in user.ak_groups.all()] -# Integrate with Nextcloud admins must be members of a group called "admin". -# Integrate with This is static and cannot be changed. -# Integrate with We append a fictional "admin" group to the user's groups if they are an admin in authentik. -# Integrate with This group would only be visible in Nextcloud and does not exist in authentik. +# Nextcloud admins must be members of a group called "admin". +# This is static and cannot be changed. +# We append a fictional "admin" group to the user's groups if they are an admin in authentik. +# This group would only be visible in Nextcloud and does not exist in authentik. if user.is_superuser and "admin" not in groups: groups.append("admin") diff --git a/website/integrations/services/pgadmin/index.md b/website/integrations/services/pgadmin/index.md index e2cc8cd83c3b..e06865c3431a 100644 --- a/website/integrations/services/pgadmin/index.md +++ b/website/integrations/services/pgadmin/index.md @@ -24,7 +24,7 @@ The following placeholders are used in this guide: - `pgadmin.company` is the FQDN of pgAdmin. - `authentik.company` is the FQDN of authentik. -# Integrate with authentik configuration +# authentik configuration 1. From the Admin interface, navigate to **Applications** -> **Applications**. 2. Use the wizard to create a new application and provider. During this process: diff --git a/website/integrations/services/qnap-nas/index.md b/website/integrations/services/qnap-nas/index.md index d56e7f8a14c6..915efcf16199 100644 --- a/website/integrations/services/qnap-nas/index.md +++ b/website/integrations/services/qnap-nas/index.md @@ -148,7 +148,7 @@ nss_map_objectclass posixGroup group # remap attributes # uid to cn is essential otherwise only id usernames will occur nss_map_attribute uid cn -# Integrate with map displayName information into comments field +# map displayName information into comments field nss_map_attribute gecos displayName # see https://ldapwiki.com/wiki/GroupOfUniqueNames%20vs%20groupOfNames nss_map_attribute uniqueMember member @@ -176,14 +176,14 @@ Now start the LDAP Service: To see if connection is working, type ```bash -# Integrate with list users +# list users $ getent passwd ``` The output should list local users and authentik accounts. ```bash -# Integrate with list groups +# list groups $ getent group ```