opensource/galaxy
3
0
Fork 0
mirror of https://github.com/galaxyproject/galaxy.git synced 2026-09-24 16:30:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improve auth_conf.xml.sample documentation.

Browse Source
This commit is contained in:
Nicola Soranzo
2015-06-01 11:58:08 +01:00
parent 608c827559
commit 30872e72bb
1 changed files with 72 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
config/auth_conf.xml.sample
+72 -22
View File
@@ -3,44 +3,94 @@
<!--<authenticator>
<type>ldap</type>
-->
<!-- Replacement fields: instances of {email}, {username} and {password}
are replaced with the corresponding user's values inside the
<filter>, <server>, <ldap-options>, <search-fields>,
<search-filter>, <search-base>, <search-user> and <search-password>
elements. -->
<!-- Filter users for which this authenticator applies. This is a Python
expression which is evaluated after replacing instances of {email}
and {username} with the corresponding user's values. -->
expression which is evaluated after field replacement. -->
<!-- <filter>'{email}'.endswith('@example.com')</filter>
<options>
<auto-register>True</auto-register>
<server>ldap://dc1.example.com</server>
-->
<!-- If search-fields is not present, all other search-* elements are ignored -->
<!-- <search-fields>sAMAccountName,mail</search-fields>
<search-filter>(&amp;(objectClass=user)(mail={email}))</search-filter>
<search-base>dc=dc1,dc=example,dc=com</search-base>
<!-- Whether to allow user registration. Possible values are True,
False and Challenge (i.e. allow registration in case of
successful authentication). Default is True. -->
<!-- <allow-register>False</allow-register>
-->
<!-- If search-user not specified will bind anonymously to LDAP for search -->
<!-- <search-user>jsmith</search-user>
<search-password>mysecret</search-password>
<bind-user>{sAMAccountName}@example.com</bind-user>
<bind-password>{password}</bind-password>
<auto-register-username>{sAMAccountName}</auto-register-username>
<auto-register-email>{mail}</auto-register-email>
<!-- Whether Galaxy should automatically register users when they
first login. Default is False. -->
<!-- <auto-register>True</auto-register>
-->
<!-- Whether users are allowed to change their password. Default is
False. -->
<!-- <allow-password-change>False</allow-password-change>
-->
<!-- If your need to pass additional options to your LDAP connection, set them here
The syntax is: option1=value1,option2=value2,...
Options and values should match those from the python-ldap documentation.
<!-- LDAP-specific options -->
<!-- <server>ldap://dc1.example.com</server>
-->
<!-- Additional options for the LDAP connection. The syntax is:
option1=value1,option2=value2,...
Options and values should match those from the python-ldap
documentation.
The following example allows connecting to ldaps:// (SSL/TLS)
when self-signed certificates are used -->
<!-- <ldap-options>OPT_X_TLS_REQUIRE_CERT=OPT_X_TLS_ALLOW</ldap-options>
-->
<!-- To allow login with username instead of email, default is False -->
<!-- <login-use-username>True</login-use-username>
</options>
</authenticator>
<!-- Whether to allow login with username instead of email. Default
is False. -->
<!-- <login-use-username>False</login-use-username>
-->
<!-- Whether to continue with the following authenticators if LDAP
fails. Default is False. -->
<!-- <continue-on-failure>False</continue-on-failure>
-->
<!-- If search-fields is not specified, all other search-* elements
are ignored.
If search-user is not specified, Galaxy will bind anonymously
to the LDAP server for search. -->
<!-- For Active Directory: -->
<!-- <search-fields>sAMAccountName,mail</search-fields>
<search-filter>(&amp;(objectClass=user)(mail={email}))</search-filter>
<search-base>dc=dc1,dc=example,dc=com</search-base>
<search-user>jsmith@dc1.example.com</search-user>
<search-password>mysecret</search-password>
-->
<!-- For OpenLDAP: -->
<!-- <search-fields>uid,mail</search-fields>
<search-filter>(&#124;(mail={email})(uid={username}))</search-filter>
<search-base>ou=People,dc=example,dc=com</search-base>
<search-user>cn=jsmith,ou=People,dc=domain,dc=com</search-user>
<search-password>mysecret</search-password>
-->
<!-- Replacement fields: instances of {email}, {username},
{password}, {dn} plus all fields defined in <search-fields> are
replaced with the corresponding user's values inside the
<bind-user>, <bind-password>, <auto-register-username> and
<auto-register-email> elements. -->
<!-- For Active Directory: -->
<!-- <bind-user>{sAMAccountName}@dc1.example.com</bind-user>
<bind-password>{password}</bind-password>
<auto-register-username>{sAMAccountName}</auto-register-username>
<auto-register-email>{mail}</auto-register-email>
-->
<!-- For OpenLDAP: -->
<!-- <bind-user>{dn}</bind-user>
<bind-password>{password}</bind-password>
<auto-register-username>{uid}</auto-register-username>
<auto-register-email>{mail}</auto-register-email>
-->
<!-- </options>
</authenticator>
-->
<authenticator>
<type>localdb</type>
<options>
<!-- Whether users are allowed to change their password. Default is
False. -->
<allow-password-change>true</allow-password-change>
</options>
</authenticator>