# fixed infos about the new features

This commit is contained in:
nicobo 2015-05-25 12:52:10 +02:00
parent 822a0267c6
commit dc0c031052

View file

@ -1,17 +1,18 @@
Modular Script Realm plugin for Jenkins
=======================================
Script Realm plugin for Jenkins
===============================
This fork of the "Script Realm" plugin for Jenkins adds e-mail and display name resolution support.
The original plugin allows to use a user-written custom script to authenticate the username and password (also supports groups).
This Jenkins plugin allows you to use a user-written custom script to authenticate the username and password (also supports groups).
This is useful if you need to plug into a custom authentication scheme, but don't want to write your own plugin.
Find more about the original plugin at https://wiki.jenkins-ci.org/display/JENKINS/Script+Security+Realm.
By default this plugin triggers any `MailAddressResolver` and `UserNameResolver` installed on the Jenkins instance.
You may also disable resolution or use a specific resolver for each of them.
Find more at https://wiki.jenkins-ci.org/display/JENKINS/Script+Security+Realm.
For instance, the [LDAP Email Plugin](https://wiki.jenkins-ci.org/display/JENKINS/LDAP+Email+Plugin) provides a `MailAddressResolver`. If installed, you may configure "Modular Script Realm" to use a custom script to authenticate users and the "LDAP Email Plugin" to resolve their e-mail.
Resolving e-mail and full name
------------------------------
In order to display e-mail and full name in the authenticated users' page, this plugin triggers any `MailAddressResolver` and `UserNameResolver` installed on the Jenkins instance.
You may disable resolution or use a specific resolver for each of them.
For instance, the [LDAP Email Plugin](https://wiki.jenkins-ci.org/display/JENKINS/LDAP+Email+Plugin) provides a `MailAddressResolver`.
Since this plugin does not know how resolvers from external plugins are to be configured, using a random resolver might not work at all.
You will soon find here a list of known working configurations.