diff options
author | Mike Fellows <Mike.Fellows@shaw.ca> | 2017-11-30 05:36:53 -0800 |
---|---|---|
committer | Lunny Xiao <xiaolunwen@gmail.com> | 2017-11-30 21:36:53 +0800 |
commit | 82e8486f13253e5a2b1a06c286b1e2b2b6049473 (patch) | |
tree | 648627a11bfa6505ef1aaed4736020ce448b8d12 /docs | |
parent | 474dfcc798b4d2d1a0d83f5cf69c6e129fc3a5c5 (diff) | |
download | gitea-82e8486f13253e5a2b1a06c286b1e2b2b6049473.tar.gz gitea-82e8486f13253e5a2b1a06c286b1e2b2b6049473.zip |
Update docs for LDAP (via BindDN) user sync option. (#2985)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/content/doc/features/authentication.en-us.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/content/doc/features/authentication.en-us.md b/docs/content/doc/features/authentication.en-us.md index 37a0d6fa87..f4f5ee5f5f 100644 --- a/docs/content/doc/features/authentication.en-us.md +++ b/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: matching supplied login name against multiple attributes such as user identifier, email or even phone number. - Example: `(&(objectClass=Person)(|(uid=%[1]s)(mail=%[1]s)(mobile=%[1]s)))` +- Enable user synchronization + - This option enables a periodic task that synchronizes the Gitea users with + the LDAP server. The default period is every 24 hours but that can be + changed in the app.ini file. See the *cron.sync_external_users* section in + the [sample + app.ini](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.ini.sample) + for detailed comments about that section. The *User Search Base* and *User + Filter* settings described above will limit which users can use Gitea and + which users will be synchronized. When initially run the task will create + all LDAP users that match the given settings so take care if working with + large Enterprise LDAP directories. **LDAP using simple auth** adds the following fields: |