Added note over OpenLDAP

Tomasz Durda 2020-06-08 18:40:01 +02:00
parent 2ed4e67699
commit 8374fd9a7e

29
LDAP.md

@ -4,7 +4,9 @@ Custom values can be injected using environment variables, similar to the main c
## Override example
Among others you can use *docker-compose.override.yml* to inject necessary variables. Example override file for Active Directory:
Among others you can use *docker-compose.override.yml* to inject necessary variables.
### Example override file for Active Directory
```
version: '3.4'
@ -14,11 +16,36 @@ services:
environment:
AUTH_LDAP_SERVER_URI: "ldaps://domain.com"
AUTH_LDAP_BIND_DN: "CN=Netbox,OU=EmbeddedDevices,OU=MyCompany,DC=domain,dc=com"
AUTH_LDAP_BIND_PASSWORD: "TopSecretPassword"
AUTH_LDAP_USER_SEARCH_BASEDN: "OU=MyCompany,DC=domain,dc=com"
AUTH_LDAP_GROUP_SEARCH_BASEDN: "OU=SubGroups,OU=MyCompany,DC=domain,dc=com"
AUTH_LDAP_REQUIRE_GROUP_DN: "CN=Netbox-User,OU=SoftwareGroups,OU=SubGroups,OU=MyCompany,DC=domain,dc=com"
AUTH_LDAP_IS_ADMIN_DN: "CN=Network Configuration Operators,CN=Builtin,DC=domain,dc=com"
AUTH_LDAP_IS_SUPERUSER_DN: "CN=Domain Admins,CN=Users,DC=domain,dc=com"
LDAP_IGNORE_CERT_ERRORS: "false"
```
### Example override file for OpenLDAP
**NOTE**: Currently, there are reported issues associated with OpenLDAP support
```
version: '3.4'
services:
netbox:
image: netboxcommunity/netbox:${VERSION-latest-ldap}
environment:
AUTH_LDAP_SERVER_URI: "ldaps://domain.com"
AUTH_LDAP_BIND_DN: "cn=netbox,ou=services,dc=domain,dc=com"
AUTH_LDAP_BIND_PASSWORD: "TopSecretPassword"
AUTH_LDAP_USER_SEARCH_BASEDN: "ou=people,dc=domain,dc=com"
AUTH_LDAP_GROUP_SEARCH_BASEDN: "ou=groups,dc=domain,dc=com"
AUTH_LDAP_REQUIRE_GROUP_DN: "cn=netbox" # or "cn=netbox,ou=groups,dc=domain,dc=com"
AUTH_LDAP_IS_ADMIN_DN: "cn=donkey,ou=people,dc=domain,dc=com"
AUTH_LDAP_IS_SUPERUSER_DN: "cn=shrek,ou=people,dc=domain,dc=com"
AUTH_LDAP_USER_SEARCH_ATTR = "cn"
AUTH_LDAP_GROUP_SEARCH_CLASS = "groupOfUniqueNames"
AUTH_LDAP_ATTR_LASTNAME = "sn"
AUTH_LDAP_ATTR_FIRSTNAME = "givenName"
LDAP_IGNORE_CERT_ERRORS: "false"
```