LDAP Tools/Explanation of Parameters

From Authentication Tools for Joomla! (JAuthTools)

(Difference between revisions)
Jump to: navigation, search
(→Group Map)
Line 1: Line 1:
There are many parameters for LDAP Tools, some which might be a bit confusing as to their true purpose. This page aims to document them in more detail.
There are many parameters for LDAP Tools, some which might be a bit confusing as to their true purpose. This page aims to document them in more detail.
-
= General Settings =
+
Unless otherwise stated, all settings are available in the core Joomla! LDAP mambot/plugin. Some settings may exist in the Joomla! 1.5 LDAP plugin but not all do, where to find the feature is noted where possible.
-
==Use Global Settings==
+
-
{{Plugins:SSOSSISYNCHTTP}}
+
= Server Connect Settings =
 +
'''Use Global Settings'''
-
Use the Joomla! LDAP Library configuration settings instead of anything locally configured. This allows single point configuration of LDAP settings.
+
Use the Joomla! LDAP Library configuration settings instead of the plugins configured settings. This allows single point configuration of LDAP settings via the Joomla! LDAP plugin (1.0.x only)
-
==Autocreate Users==
 
-
{{Plugins:SSOSSIHTTP}}
+
'''Host'''
-
 
+
-
Autocreate a user if it is possible (e.g. user is recognized via LDAP but not in Joomla!).
+
-
 
+
-
'''Note: In J!1.5 this is stored in the global configuration settings'''
+
-
 
+
-
= Server Settings =
+
-
 
+
-
==Host==
+
The host name of the server to connect.
The host name of the server to connect.
-
==Port==
+
'''Port'''
The port to connect to the server. This will normally be fine with the default.
The port to connect to the server. This will normally be fine with the default.
-
==LDAP V3==
+
'''LDAP V3'''
Use LDAP Version 3. This may be required by your server (e.g. OpenLDAP)
Use LDAP Version 3. This may be required by your server (e.g. OpenLDAP)
-
==Negotiate TLS==
+
'''Negotiate TLS'''
Use TLS (like SSL) for the Connection.
Use TLS (like SSL) for the Connection.
-
==Don't follow referrals==
+
'''Don't follow referrals'''
If your LDAP server is configured to refer to other hosts (for load balancing), do not enable this option. This can be a security risk.
If your LDAP server is configured to refer to other hosts (for load balancing), do not enable this option. This can be a security risk.
-
= LDAP Tree Settings =
+
= Server Binding Settings =
-
==Base DN==
+
''Base DN''
The Base DN of the tree.
The Base DN of the tree.
-
== Connect Username==
+
'' Connect Username''
Connection username to be passed to the server. Used for default authentication.
Connection username to be passed to the server. Used for default authentication.
-
==Connect password==
+
''Connect password''
 +
 
 +
The password to use if you need one to connect to your server (e.g. Active Directory)
 +
 
 +
''Search string=''
 +
 
 +
A full default search string, e.g. CN=[search]
 +
 
 +
''Users DN''
 +
 
 +
User DN to search for users (e.g. CN=[username],OU=Users,O=Example)
 +
 
 +
= Attribute Mapping Settings =
 +
 
 +
= User Creation and Synchronisation Settings =
 +
 
 +
'''Autocreate Users'''
 +
 
 +
Autocreate a user if it is possible (e.g. user is recognized via LDAP but not in Joomla!).
 +
 
 +
'''Autocreate Registered Users'''
 +
 
 +
= Group Assignment Settings =
 +
'''Group Map'''
 +
 
 +
[[LDAP Tools/Group Mapping|Group Mapping]] is a system to simply map LDAP based groups to Joomla!'s group system. This information is used by the autocreate system to map users, otherwise all autocreated users are created as the default value.
 +
 
 +
 
 +
= Internationalisation Support =  
 +
'''Use iconv'''
 +
 
 +
iconv is required to convert some fields into UTF-8 that is stored in the database. You will need iconv installed (See System -> System Info -> PHP Info) or this will error
 +
 
-
The password to use if you need one to connect to your server
+
'''Original Encoding'''
-
==Search string==
+
This is the encoding used in your LDAP directory.
-
A full default search string.
+
'''Target Encoding'''
-
==Users DN==
+
This is the encoding used in your database server (e.g. MySQL, typically UTF-8)
-
User DN to search for users (allows specifying username instead of username.cn.o etc).
 
-
==Group Map==
 
-
{{Plugins:SSOSSISYNCHTTP}}
+
''Note: In J!1.5 this is stored in the global configuration settings''
-
[[LDAP Tools/Group Mapping|Group Mapping]] is a system to simply map LDAP based groups to Joomla!'s group system. This information is used by the autocreate system to map users, otherwise all autocreated users are created as registered. Please note in JAuthTools for J!1.0.x that this was not covered by the use global settings option.
 
[[Category:LDAP]] [[Category:Settings]]
[[Category:LDAP]] [[Category:Settings]]

Revision as of 03:51, 19 November 2007

There are many parameters for LDAP Tools, some which might be a bit confusing as to their true purpose. This page aims to document them in more detail.

Unless otherwise stated, all settings are available in the core Joomla! LDAP mambot/plugin. Some settings may exist in the Joomla! 1.5 LDAP plugin but not all do, where to find the feature is noted where possible.

Contents

Server Connect Settings

Use Global Settings

Use the Joomla! LDAP Library configuration settings instead of the plugins configured settings. This allows single point configuration of LDAP settings via the Joomla! LDAP plugin (1.0.x only)


Host

The host name of the server to connect.


Port

The port to connect to the server. This will normally be fine with the default.


LDAP V3

Use LDAP Version 3. This may be required by your server (e.g. OpenLDAP)


Negotiate TLS

Use TLS (like SSL) for the Connection.


Don't follow referrals

If your LDAP server is configured to refer to other hosts (for load balancing), do not enable this option. This can be a security risk.

Server Binding Settings

Base DN

The Base DN of the tree.

Connect Username

Connection username to be passed to the server. Used for default authentication.

Connect password

The password to use if you need one to connect to your server (e.g. Active Directory)

Search string=

A full default search string, e.g. CN=[search]

Users DN

User DN to search for users (e.g. CN=[username],OU=Users,O=Example)

Attribute Mapping Settings

User Creation and Synchronisation Settings

Autocreate Users

Autocreate a user if it is possible (e.g. user is recognized via LDAP but not in Joomla!).

Autocreate Registered Users

Group Assignment Settings

Group Map

Group Mapping is a system to simply map LDAP based groups to Joomla!'s group system. This information is used by the autocreate system to map users, otherwise all autocreated users are created as the default value.


Internationalisation Support

Use iconv

iconv is required to convert some fields into UTF-8 that is stored in the database. You will need iconv installed (See System -> System Info -> PHP Info) or this will error


Original Encoding

This is the encoding used in your LDAP directory.

Target Encoding

This is the encoding used in your database server (e.g. MySQL, typically UTF-8)



Note: In J!1.5 this is stored in the global configuration settings

Retrieved from "http://sammoffatt.com.au/jauthtools/LDAP_Tools/Explanation_of_Parameters"
Personal tools