Skip to content

Commit

Permalink
docs: update gateway conf reference doc
Browse files Browse the repository at this point in the history
  • Loading branch information
rezib committed Aug 30, 2024
1 parent 9aa95a7 commit 7737b5c
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- pkgs: Add requirement on RFL.core >= 1.0.3.
- frontend: Add intermediate cluster list width to 80% on large screens, before
going down to 60% on even larger screens.
- docs: Update configuration reference documentation.

### Fixed
- backend: handle rfl.settings.errors.SettingsSiteLoaderError when loading
Expand Down
14 changes: 14 additions & 0 deletions docs/modules/conf/examples/gateway.ini
Original file line number Diff line number Diff line change
Expand Up @@ -150,11 +150,25 @@ user_name_attribute=uid
# Default value: cn
user_fullname_attribute=cn

# User entry attribute for primary group ID
#
# Default value: gidNumber
user_primary_group_attribute=gidNumber

# Group entry attribute for name
#
# Default value: cn
group_name_attribute=cn

# List of LDAP object classes for groups
#
# Default value:
# - posixGroup
# - groupOfNames
group_object_classes=
posixGroup
groupOfNames

# DN used to bind to the LDAP server. When this parameter is not defined,
# access to LDAP directory is performed anonymously.
bind_dn=cn=system,ou=people,dc=example,dc=org
Expand Down
28 changes: 28 additions & 0 deletions docs/modules/conf/partials/conf-gateway.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -366,6 +366,17 @@ _No default value_
|-
|user_primary_group_attribute
|str
|User entry attribute for primary group ID
*Default:* `gidNumber`
|-
|group_name_attribute
|str
|Group entry attribute for name
Expand All @@ -375,6 +386,23 @@ _No default value_
*Default:* `cn`
|-
|group_object_classes
|list[str]
|List of LDAP object classes for groups
*Default:*
* `posixGroup`
* `groupOfNames`
|-
|bind_dn
Expand Down

0 comments on commit 7737b5c

Please sign in to comment.