NewUserPlugin

<--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/NewUserPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/NewUserPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->

Description

This plugin is of use in those cases where TWiki users are registered and authenticated externally, for example using LDAP. So users are not registered to TWiki using its own registration workflow and therefore don't have a user topic in the Main web. This plugin fills that gap and creates a user's topic if it does not yet exist.

Settings

<-- 

 Set SHORTDESCRIPTION = Create a user topic if it does not exist yet
 
-->

• Set NEWUSERTEMPLATE = NewLdapUserTemplate

If not set, it defaults to NewUserTemplate. This plugin comes with an example template, NewLdapUserTemplate, to illustrate how to extract user data from an LDAP directory and integrate the information into the user's topic dynamically. You will need to install the TWiki:Plugins/LdapNgPlugin and the TWiki:Plugins/GluePlugin to make use of it.

Syntax

On creation of the user home topic only %WIKINAME%, %USERNAME% and %WIKIUSERNAME% get expanded by default. To expand additional VARIABLES, you can use the %EXPAND{}% syntax. All percent signs have to be escaped by $percnt, deeper recursion levels may use $dollar, too. Multiline EXPANDs are not supported.

Example:

%EXPAND{$percntGMTIME{"$year-$mo-$day"}$percnt}%

Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server where TWiki is running.

Like many other TWiki extensions, this module is shipped with a fully automatic installer script written using the BuildContrib.

• If you have TWiki 4.2 or later, you can install from the configure interface (Go to Plugins->Find More Extensions)
  • See the installation supplement on TWiki.org for more information.
• If you have any problems, then you can still install manually from the command-line:
  1. Download one of the .zip or .tgz archives
  2. Unpack the archive in the root directory of your TWiki installation.
  3. Run the installer script ( perl <module>_installer )
  4. Run configure and enable the module, if it is a plugin.
  5. Repeat for any missing dependencies.
• If you are still having problems, then instead of running the installer script:
  1. Make sure that the file permissions allow the webserver user to access all files.
  2. Check in any installed files that have existing ,v files in your existing install (take care not to lock the files when you check in)
  3. Manually edit LocalSite.cfg to set any configuration variables.

Plugin Info

This work is partly funded by T+T Hennerich GmbH.

Plugin Author:	TWiki:Main.MichaelDaum
Copyright:	© 2006-2008, Michael Daum http://michaeldaumconsulting.com; © 2006-2010, TWiki:TWiki/TWikiContributor
License:	GPL (GNU General Public License)
Plugin Version:	2011-01-14
Change History:	<-- versions below in reverse order -->
2011-01-14:	TWikibug:Item6530: Doc improvements
2010-05-02:	TWikibug:Item6433: Doc improvements; changing TWIKIWEB to SYSTEMWEB
15 Sep 2008	TWiki:Main.OliverKrueger: added EXPAND feature, removed noise in debug.txt
12 Feb 2008	remove leading/trailing whitespaces from NEWUSERTEMPLATE filename
09 Jan 2008	fixed spelling error
03 Jan 2008	fixed default values for NEWUSERTEMPLATE, clearing unset LDAP attributes
23 Oct 2007	work around infinite loop in combination with ActionTrackerPlugin
17 Sep 2007	replace usernames in formtemplates as well as in the topic text
18 Dec 2006	initial release
Dependencies:	None
Plugin Home:	TWiki:Plugins/NewUserPlugin
Feedback:	TWiki:Plugins/NewUserPluginDev
Appraisal:	TWiki:Plugins/NewUserPluginAppraisal

Related Topics: NewLdapUserTemplate, RenderLdapUser, TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences