Update documentation

This commit is contained in:
Frederic Guillot
2016-01-05 21:29:34 -05:00
parent 22568325c9
commit a03e4d4dcb
4 changed files with 8 additions and 3 deletions

View File

@@ -52,6 +52,7 @@ define('LDAP_GROUP_FILTER', '(&(objectClass=group)(sAMAccountName=%s*))');
With the filter given as example above, Kanboard will search for groups that match the query. With the filter given as example above, Kanboard will search for groups that match the query.
If the end-user enter the text "My group" in the auto-complete box, Kanboard will return all groups that match the pattern: `(&(objectClass=group)(sAMAccountName=My group*))`. If the end-user enter the text "My group" in the auto-complete box, Kanboard will return all groups that match the pattern: `(&(objectClass=group)(sAMAccountName=My group*))`.
Note that the special characters `*` is important here, otherwise an exact match will be done. - Note 1: The special characters `*` is important here, otherwise an exact match will be done.
- Note 2: This feature is only compatible with LDAP authentication configured in "proxy" or "anonymous" mode
[More examples of LDAP filters for Active Directory](http://social.technet.microsoft.com/wiki/contents/articles/5392.active-directory-ldap-syntax-filters.aspx) [More examples of LDAP filters for Active Directory](http://social.technet.microsoft.com/wiki/contents/articles/5392.active-directory-ldap-syntax-filters.aspx)

View File

@@ -37,3 +37,4 @@ Example of authentication plugins
- [Authentication providers included in Kanboard](https://github.com/fguillot/kanboard/tree/master/app/Auth) - [Authentication providers included in Kanboard](https://github.com/fguillot/kanboard/tree/master/app/Auth)
- [Reverse-Proxy Authentication with LDAP support](https://github.com/kanboard/plugin-reverse-proxy-ldap) - [Reverse-Proxy Authentication with LDAP support](https://github.com/kanboard/plugin-reverse-proxy-ldap)
- [SMS Two-Factor Authentication](https://github.com/kanboard/plugin-sms-2fa)

View File

@@ -82,7 +82,7 @@ $this->user->getById(123);
Plugin Translations Plugin Translations
------------------- -------------------
Plugin can be translated in the same way the rest of the application. You must load the translations yourself when the session is created: Plugin can be translated in the same way as the rest of the application. You must load the translations yourself when the session is created:
```php ```php
$this->on('app.bootstrap', function($container) { $this->on('app.bootstrap', function($container) {
@@ -90,7 +90,9 @@ $this->on('app.bootstrap', function($container) {
}); });
``` ```
The translations must be stored in `plugins/Myplugin/Locale/xx_XX/translations.php`. The translations must be stored in the file `plugins/Myplugin/Locale/xx_XX/translations.php` (replace xx_XX by the language code fr_FR, en_US...).
Translations are stored in a dictionary, if you would like to override an existing string, you just need to use the same key in your translation file.
Dependency Injection Container Dependency Injection Container
------------------------------ ------------------------------

View File

@@ -26,6 +26,7 @@ Plugin creators should specify explicitly the compatible versions of Kanboard. I
Examples of plugins Examples of plugins
------------------- -------------------
- [SMS Two-Factor Authentication](https://github.com/kanboard/plugin-sms-2fa)
- [Reverse-Proxy Authentication with LDAP support](https://github.com/kanboard/plugin-reverse-proxy-ldap) - [Reverse-Proxy Authentication with LDAP support](https://github.com/kanboard/plugin-reverse-proxy-ldap)
- [Slack](https://github.com/kanboard/plugin-slack) - [Slack](https://github.com/kanboard/plugin-slack)
- [Hipchat](https://github.com/kanboard/plugin-hipchat) - [Hipchat](https://github.com/kanboard/plugin-hipchat)