diff --git a/README.md b/README.md index 1419eee..3676b98 100644 --- a/README.md +++ b/README.md @@ -317,6 +317,7 @@ folder for help with: - [Gitea](example_configs/gitea.md) - [GitLab](example_configs/gitlab.md) - [Grafana](example_configs/grafana_ldap_config.toml) +- [Grocy](example_configs/grocy.md) - [Hedgedoc](example_configs/hedgedoc.md) - [Home Assistant](example_configs/home-assistant.md) - [Jellyfin](example_configs/jellyfin.md) diff --git a/example_configs/grocy.md b/example_configs/grocy.md new file mode 100644 index 0000000..4f5ec45 --- /dev/null +++ b/example_configs/grocy.md @@ -0,0 +1,28 @@ +# Configuration for Grocy + +Adjust the following values in the file `config/data/config.php` or add environment variables for them (prefixed with `GROCY_`). + +NOTE: If the environment variables are not working (for example in the linuxserver.io Docker Image), you need to add `clear_env = no` under the `[www]` in `/config/php/www2.conf`. + +Replace `dc=example,dc=com` with your LLDAP configured domain. + +### AUTH_CLASS +Needs to be set to `Grocy\Middleware\LdapAuthMiddleware` in order to use LDAP + +### LDAP_ADDRESS +The address of your ldap server, eg: `ldap://lldap.example.com:389` + +### LDAP_BASE_DN +The base dn, usually points directly to the `people`, eg: `ou=people,dc=example,dc=com` + +### LDAP_BIND_DN +The reader user for lldap, eg: `uid=ldap-reader,ou=people,dc=example,dc=com` + +### LDAP_BIND_PW +The password for the reader user + +### LDAP_USER_FILTER +The filter to use for the users, eg. for a separate group: `(&(objectClass=person)(memberof=cn=grocy_users,ou=groups,dc=example,dc=com))` + +### LDAP_UID_ATTR +The user id attribute, should be `uid`