steffen: server/kolabd/kolabd/doc README.webgui,NONE,1.1

[cvs at intevation.de]

Author: steffen

Update of /kolabrepository/server/kolabd/kolabd/doc
In directory doto:/tmp/cvs-serv17342

Added Files:
	README.webgui 
Log Message:
documentation for new webgui features (access control)

--- NEW FILE: README.webgui ---
Web admin interface for Kolab
=============================

Last edited: $Id: README.webgui,v 1.1 2005/04/11 01:05:16 steffen Exp $

Requirements
------------

This feature requires the kolab-webadmin package to be installed.

Configuration
-------------

There are only two aspects of the webgui that can be configured currently:

1) Access control based on user class. Each kolab user is member of one of the
user classes

 "user": Any regular kolab user.
 "maintainer": A user that can create/modify/delete user accounts,
        addressbook entries and distribution lists.
 "admin": Same as "maintainer" but with the additional rights to
        change services configuration and manage maintainers.
 "manager": The "manager" class contains only one user -- the manager
        user. The right are the same as "admin".

By default all classes can use the webgui. By changing
@l_prefix@/etc/kolab/templates/session_vars.php this can be
configured. The user-classes that shold have access to the webgui
are listed in the $params['allow_user_classes'] array:

$params['allow_user_classes'] = 
        array( 'user', 'admin', 'maintainer', 'manager' );


2) Controlling access for regular users to the LDAP attributes of the
user's account object. If it possible to change which LDAP attributes
are shown to users on the user page. For each attribute in the user
form, an entry in the array $params['attribute_access'] in
@l_prefix@/etc/kolab/templates/session_vars.php can be made. The key
of the entry is the attribute's name and the value is one of 

  "ro": Readonly.
  "rw": Read/write.
  "hidden": Attribute will not be shown.
  "mandatory": Attribute must not be empty when edited.

The names of the attributes visible to regular users are:

  givenname, sn, password, mail, uid, kolabhomeserver, accttype,
  kolabinvitationpolicy, title, alias, kolabdelegate, o, ou,
  roomNumber, street, postOfficeBox, postalCode, l, c, telephoneNumber,
  facsimileTelephoneNumber, kolabFreeBusyFuture.

An example showing how to make title and telephoneNumber readonly and
hide the c (country) attribute:

$param['attribute_access'] = array( 'title' => 'ro',
                                    'telephoneNumber' => 'ro',
                                    'c' => 'hidden' );