Add example configuration

Florian Knodt 2020-03-24 13:07:00 +01:00
parent e64405aebd
commit f2bd34ad81

22
LDAP.md

@ -1,3 +1,23 @@
The images tagged with "-ldap" contain all the necessary dependencies to authenticate against an LDAP or Active Directory server. The images tagged with "-ldap" contain all the necessary dependencies to authenticate against an LDAP or Active Directory server.
The default configuration `ldap_config.py` is prepared for use with an Active Directory server. The default configuration `ldap_config.py` is prepared for use with an Active Directory server.
Custom values can be injected using environment variables, similar to the main configuration mechanisms. Custom values can be injected using environment variables, similar to the main configuration mechanisms.
## Override example
Among others you can use *docker-compose.override.yml* to inject necessary variables. Example override file for Active Directory:
```
version: '3.4'
services:
netbox:
environment:
AUTH_LDAP_SERVER_URI: "ldaps://domain.com"
AUTH_LDAP_BIND_DN: "CN=Netbox,OU=EmbeddedDevices,OU=MyCompany,DC=domain,dc=com"
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"
AUTH_LDAP_BIND_PASSWORD: "TopSecretPassword"
LDAP_IGNORE_CERT_ERRORS: "false"
```