- reformatting text documentation to be ReST-friendly
git-svn-id: http://svn.dataflake.org/svn/Products.LDAPMultiPlugins/trunk@1511 835909ba-7c00-0410-bfa4-884f43845301
This commit is contained in:
jens
parent
f170723339
commit
4d0bd72d05
|
|
@ -1,4 +1,4 @@
|
|||
Copyright (c) 2004-2006 Chris McDonough and Jens Vagelpohl.
|
||||
Copyright (c) 2004-2008 Jens Vagelpohl and contributors.
|
||||
All Rights Reserved.
|
||||
|
||||
This software is subject to the provisions of the Zope Public License,
|
||||
|
|
|
|||
|
|
@ -1,26 +1,25 @@
|
|||
=======================================
|
||||
Installing the LDAPMultiPlugins Product
|
||||
=======================================
|
||||
|
||||
It is assumed that you have installed the PluggableAuthService and
|
||||
PluginRegistry products already. They are available from cvs.zope.org.
|
||||
This product does not require any special handling after unzipping
|
||||
and untarring it in the Zope Products directory. You should do
|
||||
something like:
|
||||
|
||||
This product does not require any special handling after unzipping
|
||||
and untarring it in the Zope Products directory. You should do
|
||||
something like::
|
||||
$ cp LDAPMultiPlugins-xyz.tgz <zope_root>/lib/python/Products
|
||||
$ cd <zope_root>/lib/python/Products
|
||||
$ tar zxvf LDAPMultiPlugins-xyz.tgz
|
||||
<watch files being decompressed>
|
||||
|
||||
$ cp LDAPMultiPlugins-xyz.tgz <zope_root>/lib/python/Products
|
||||
$ cd <zope_root>/lib/python/Products
|
||||
$ tar zxvf LDAPMultiPlugins-xyz.tgz
|
||||
<watch files being decompressed>
|
||||
Windows users can use WinZip or similar, it can handle tarred
|
||||
gzip files. Make sure to move the extracted LDAPMultiPlugins
|
||||
folder to your Zope installation's lib/python/Products-folder.
|
||||
|
||||
Windows users can use WinZip or similar, it can handle tarred
|
||||
gzip files. Make sure to move the extracted LDAPMultiPlugins
|
||||
folder to your Zope installation's lib/python/Products-folder.
|
||||
|
||||
That's all. Do not forget to restart Zope afterwards. You will then
|
||||
be able to select the "LDAP Multi Plugin" and the "Active Directory
|
||||
Multi Plugin" from the list of plugins to add when you navigate to
|
||||
your PluggableAuthService-based user folder and select the "Contents"
|
||||
tab in the Zope Management Interface (ZMI).
|
||||
|
||||
See README.txt for any other dependencies and requirements.
|
||||
That's all. Do not forget to restart Zope afterwards. You will then
|
||||
be able to select the "LDAP Multi Plugin" and the "Active Directory
|
||||
Multi Plugin" from the list of plugins to add when you navigate to
|
||||
your PluggableAuthService-based user folder and select the "Contents"
|
||||
tab in the Zope Management Interface (ZMI).
|
||||
|
||||
See README.txt and DEPENDENCIES.txt for any other dependencies and
|
||||
requirements.
|
||||
|
|
|
|||
|
|
@ -1,61 +1,65 @@
|
|||
README for the Zope LDAPMultiPlugins Product
|
||||
======
|
||||
README
|
||||
======
|
||||
|
||||
The LDAPMultiPlugins provides PluggableAuthService plugins that use
|
||||
LDAP as the backend for the services they provide. The
|
||||
PluggableAuthService is a Zope user folder product that can be extended
|
||||
in modular fashion using various plugins. See DEPENDENCIES.txt for
|
||||
software needed by this package.
|
||||
The LDAPMultiPlugins provides PluggableAuthService plugins that use LDAP as
|
||||
the backend for the services they provide. The PluggableAuthService is a
|
||||
Zope user folder product that can be extended in modular fashion using
|
||||
various plugins. See DEPENDENCIES.txt for software needed by this package.
|
||||
|
||||
Please make sure to read the documentation included in the
|
||||
LDAPUserFolder package as well.
|
||||
Please make sure to read the documentation included in the LDAPUserFolder
|
||||
package as well.
|
||||
|
||||
|
||||
**Caching**
|
||||
Caching
|
||||
-------
|
||||
|
||||
The results of some calls into the plugins provided by these package can
|
||||
be cached using the Zope ZCacheable mechanism:
|
||||
The results of some calls into the plugins provided by these package can be
|
||||
cached using the Zope ZCacheable mechanism:
|
||||
|
||||
- In the Zope Management Interface (ZMI) of your PluggableAuthService
|
||||
instance, select 'RAM Cache Manager' from the dropdown, give it an ID
|
||||
and configure it according to your needs.
|
||||
- In the Zope Management Interface (ZMI) of your PluggableAuthService
|
||||
instance, select 'RAM Cache Manager' from the dropdown, give it an ID
|
||||
and configure it according to your needs.
|
||||
|
||||
- Click on your LDAP/ActiveDirectoryMultiPlugin and use the 'Cache'
|
||||
ZMI tab on the far right to associate the newly created RAM Cache
|
||||
Manager object with the plugin.
|
||||
- Click on your LDAP/ActiveDirectoryMultiPlugin and use the 'Cache'
|
||||
ZMI tab on the far right to associate the newly created RAM Cache
|
||||
Manager object with the plugin.
|
||||
|
||||
Now your plugin will use the RAM Cache Manager object to cache results
|
||||
from some of the possibly expensive API calls.
|
||||
Now your plugin will use the RAM Cache Manager object to cache results from
|
||||
some of the possibly expensive API calls.
|
||||
|
||||
|
||||
**Special features - Active Directory Multi Plugin**
|
||||
|
||||
* Properties of the ADMultiPlugin instance:
|
||||
|
||||
* groupid_attr - the LDAP attribute used for group ids.
|
||||
|
||||
* grouptitle_attr - the LDAP attribute used to compose group titles.
|
||||
|
||||
* group_class - the LDAP class of group objects.
|
||||
|
||||
* group_recurse - boolean indicating whether to determine group
|
||||
memberships of a user by unrolling nested group relationships
|
||||
(expensive). This feature is not guaranteed to work at this moment.
|
||||
Special features - Active Directory Multi Plugin
|
||||
------------------------------------------------
|
||||
|
||||
Properties of the ADMultiPlugin instance:
|
||||
|
||||
- groupid_attr - the LDAP attribute used for group ids.
|
||||
|
||||
- grouptitle_attr - the LDAP attribute used to compose group titles.
|
||||
|
||||
- group_class - the LDAP class of group objects.
|
||||
|
||||
- group_recurse - boolean indicating whether to determine group
|
||||
memberships of a user by unrolling nested group relationships
|
||||
(expensive). This feature is not guaranteed to work at this moment.
|
||||
|
||||
|
||||
**Active Directory configuration hints**
|
||||
Active Directory configuration hints
|
||||
------------------------------------
|
||||
|
||||
In order for groups support to work correctly, you may have to set the
|
||||
following properties. Every situation is different, but this has helped
|
||||
some people succeed:
|
||||
In order for groups support to work correctly, you may have to set the
|
||||
following properties. Every situation is different, but this has helped
|
||||
some people succeed:
|
||||
|
||||
* On the "Properties" tab for the ActiveDirectoryMultiPlugin, set the
|
||||
groupid_attr property to "name".
|
||||
- On the "Properties" tab for the ActiveDirectoryMultiPlugin, set the
|
||||
groupid_attr property to "name".
|
||||
|
||||
* On the contained LDAPUserFolder's "Configure" tab, choose a
|
||||
property other than "objectGUID", e.g. "sAMAccountName" for the
|
||||
User ID property. To get to the LDAPUserFolder, click on the
|
||||
ActiveDirectoryMultiPlugin "Content" tab.
|
||||
- On the contained LDAPUserFolder's "Configure" tab, choose a
|
||||
property other than "objectGUID", e.g. "sAMAccountName" for the
|
||||
User ID property. To get to the LDAPUserFolder, click on the
|
||||
ActiveDirectoryMultiPlugin "Content" tab.
|
||||
|
||||
Please see README.ActiveDirectory from the LDAPUserFolder package for
|
||||
additional information.
|
||||
Please see README.ActiveDirectory from the LDAPUserFolder package for
|
||||
additional information.
|
||||
|
||||
|
|
|
|||
Reference in New Issue