Browse Source

Update docs for LDAP (via BindDN) user sync option. (#2985)

Mike Fellows 2 years ago
parent
commit
82e8486f13
1 changed files with 11 additions and 0 deletions
  1. 11 0
      docs/content/doc/features/authentication.en-us.md

+ 11 - 0
docs/content/doc/features/authentication.en-us.md

@@ -95,6 +95,17 @@ Both the LDAP via BindDN and the simple auth LDAP share the following fields:
95 95
     matching supplied login name against multiple attributes such as user
96 96
     identifier, email or even phone number.
97 97
   - Example: `(&(objectClass=Person)(|(uid=%[1]s)(mail=%[1]s)(mobile=%[1]s)))`
98
+- Enable user synchronization
99
+  - This option enables a periodic task that synchronizes the Gitea users with
100
+    the LDAP server. The default period is every 24 hours but that can be
101
+    changed in the app.ini file.  See the *cron.sync_external_users* section in
102
+    the [sample
103
+    app.ini](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.ini.sample)
104
+    for detailed comments about that section.  The *User Search Base* and *User
105
+    Filter* settings described above will limit which users can use Gitea and
106
+    which users will be synchronized.  When initially run the task will create
107
+    all LDAP users that match the given settings so take care if working with
108
+    large Enterprise LDAP directories.
98 109
 
99 110
 **LDAP using simple auth** adds the following fields:
100 111