Merge branch 'main' into main

example_configs/portainer.md

@@ -1,49 +1,64 @@
-# Configuration for Portainer CE
+# Configuration for Portainer CE/BE
-##  Settings > Authentication 
+###  Settings > Authentication > LDAP > Custom
 ---
 
-## LDAP configuration 
+## LDAP configuration
-### LDAP Server
+
+#### LDAP Server
 ```
-localhost:3890
+localhost:3890 or ip-address:3890
 ```
-### Anonymous mode
+#### Anonymous mode
 ```
 off
 ```
-### Reader DN
+#### Reader DN
 ```
 uid=admin,ou=people,dc=example,dc=com
 ```
-### Password
+#### Password
 ```
 xxx
 ```
+* Password is the ENV you set at *LLDAP_LDAP_USER_PASS=* or `lldap_config.toml`
 
 ## User search configurations
-### Base DN
+
+#### Base DN
 ```
 ou=people,dc=example,dc=com
 ```
-### Username attribute
+#### Username attribute
 ```
 uid
 ```
-### Filter 
+### Filter
+#### All available user(s)
 ```
 (objectClass=person)
 ```
+* Using this filter will list all user registered in LLDAP
+
+#### All user(s) from specific group
+```
+(&(objectClass=person)(memberof=cn=lldap_portainer,ou=groups,dc=example,dc=com))
+```
+* Using this filter will only list user that included in `lldap_portainer` group. 
+* Admin should manually configure groups and add a user to it. **lldap_portainer** only sample.
+
+
 
 ## Group search configurations 
-### Group Base DN
+
+#### Group Base DN
 ```
 ou=groups,dc=example,dc=com
 ```
-### Group Membership Attribute
+#### Group Membership Attribute
 ```
 cn
 ```
-### Group Filter 
+#### Group Filter 
 ```
 is optional
 ```

example_configs/syncthing.md

@@ -0,0 +1,30 @@
+# Configuration for Syncthing
+##  Actions > Advanced > LDAP
+---
+
+| Parameter            | Value                                                                  | Details                                               |
+|----------------------|------------------------------------------------------------------------|-------------------------------------------------------|
+| Address              | `localhost:3890`                                                       | Replace `localhost:3890` with your LLDAP host & port  |
+| Bind DN              | `cn=%s,ou=people,dc=example,dc=com`                                    |                                                       |
+| Insecure Skip Verify | *unchecked*                                                            |                                                       |
+| Search Base DN       | `ou=people,dc=example,dc=com`                                          | Only used when using filters.                         |
+| Search Filter        | `(&(uid=%s)(memberof=cn=lldap_syncthing,ou=groups,dc=example,dc=com))` | Filters on users belonging to group `lldap_syncthing` |
+| Transport            | `plain`                                                                |                                                       |
+
+Replace `dc=example,dc=com` with your LLDAP configured domain for all occurances
+
+Leave **Search Base DN** and **Search Filter** both blank if you are not using any filters.
+
+##  Actions > Advanced > GUI
+
+Change **Auth Mode** from `static` to `ldap`
+
+
+If you get locked out of the UI due to invalid LDAP settings, you can always change the settings from the `config.xml`, save the file, and force restart the app.
+
+### Example
+
+Change the below and restart
+
+` <authMode>ldap</authMode>` to ` <authMode>static</authMode>`
+