Skip to content

Commit

Permalink
website/integrations-all: fix broken script
Browse files Browse the repository at this point in the history
website/integrations-all: fix

website/integrations-all: fix

website/integrations-all: fix

website/integrations-all: fix
  • Loading branch information
4d62 committed Jan 23, 2025
1 parent f85c574 commit 9b77c28
Show file tree
Hide file tree
Showing 10 changed files with 53 additions and 53 deletions.
4 changes: 2 additions & 2 deletions website/integrations/services/aws/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
}
Expand Down
38 changes: 19 additions & 19 deletions website/integrations/services/bookstack/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <name>)
# Set the display name to be shown on the login button.
# (Login with <name>)
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

```
Expand Down
6 changes: 3 additions & 3 deletions website/integrations/services/github-enterprise-emu/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
8 changes: 4 additions & 4 deletions website/integrations/services/hoarder/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,10 @@ OAUTH_CLIENT_SECRET=<Client secret from authentik>
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.
10 changes: 5 additions & 5 deletions website/integrations/services/kimai/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
16 changes: 8 additions & 8 deletions website/integrations/services/netbox/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/<Application slug>/'
SOCIAL_AUTH_OIDC_KEY='<Client ID>'
SOCIAL_AUTH_OIDC_SECRET='<Client Secret>'
Expand All @@ -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')
Expand All @@ -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/<Application
#SOCIAL_AUTH_OIDC_KEY = '<Client ID>'
#SOCIAL_AUTH_OIDC_SECRET = '<Client Secret>'
Expand All @@ -91,7 +91,7 @@ From Netbox version 4.0.0 Netbox add the custom `Group` models. The following co
:::

```python
# Integrate with from django.contrib.auth.models import Group # For Netbox < 4.0.0
# from django.contrib.auth.models import Group # For Netbox < 4.0.0
from netbox.authentication import Group # For Netbox >= 4.0.0

class AuthFailed(Exception):
Expand Down
10 changes: 5 additions & 5 deletions website/integrations/services/nextcloud/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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")

Expand Down
2 changes: 1 addition & 1 deletion website/integrations/services/pgadmin/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
6 changes: 3 additions & 3 deletions website/integrations/services/qnap-nas/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
```

Expand Down

0 comments on commit 9b77c28

Please sign in to comment.