summaryrefslogtreecommitdiff
path: root/doc/en_US
diff options
context:
space:
mode:
authorFrédéric Guillot <fred@kanboard.net>2017-11-28 16:29:49 -0800
committerFrédéric Guillot <fred@kanboard.net>2017-11-28 16:29:49 -0800
commit6d2076e85940c38c3b00bc26ec932aae09712743 (patch)
tree6110681fad8649f52d9410c93ce371aeb9c4d808 /doc/en_US
parent436673247fc28ae05c6b17baf202ca26e1903862 (diff)
Add config option to exclude fields from auth providers sync
Diffstat (limited to 'doc/en_US')
-rw-r--r--doc/en_US/config.markdown7
-rw-r--r--doc/en_US/ldap-authentication.markdown12
2 files changed, 17 insertions, 2 deletions
diff --git a/doc/en_US/config.markdown b/doc/en_US/config.markdown
index f5f57b6f..103c859b 100644
--- a/doc/en_US/config.markdown
+++ b/doc/en_US/config.markdown
@@ -1,4 +1,4 @@
-Config file
+Config File
===========
You can customize the default settings of Kanboard by adding a file `config.php` at the project root or in the `data` folder.
@@ -273,7 +273,7 @@ define('LOG_FILE', __DIR__.DIRECTORY_SEPARATOR.'data'.DIRECTORY_SEPARATOR.'debug
```
Brute-force protection
----------------------
+----------------------
```php
// Enable captcha after 3 authentication failure
@@ -338,4 +338,7 @@ define('TOTP_ISSUER', 'Kanboard');
// Maximum number of events stored in the table "project_activities"
define('PROJECT_ACTIVITIES_MAX_EVENTS', 10000);
+
+// Comma separated list of fields to not synchronize when using external authentication providers
+define('EXTERNAL_AUTH_EXCLUDE_FIELDS', 'username');
```
diff --git a/doc/en_US/ldap-authentication.markdown b/doc/en_US/ldap-authentication.markdown
index 6d80e9db..c3445e5d 100644
--- a/doc/en_US/ldap-authentication.markdown
+++ b/doc/en_US/ldap-authentication.markdown
@@ -194,6 +194,18 @@ Just change the value of `LDAP_ACCOUNT_CREATION` to `false`:
define('LDAP_ACCOUNT_CREATION', false);
```
+Synchronization
+---------------
+
+By default, Kanboard will synchronize all fields (role, name, email...) except the username.
+
+If you would like to change this behavior, use this config parameter:
+
+```bash
+// This example will not synchronize the fields "username" and "role" from LDAP to Kanboard.
+define('EXTERNAL_AUTH_EXCLUDE_FIELDS', 'username,role');
+```
+
Troubleshooting
---------------