You are here: CTSPedia>TWiki Web>RequireRegistrationPlugin (27 Jul 2007, ByronIgoe?)EditAttach
create new tag
, view all tags, tagging instructions


This plugin will redirect a user to the TWikiRegistration topic if their login name is not a WikiWord.

Use this if you have setup single sign-on (SSO) and want to force externally authenticated users to register their WikiName before accessing any wiki content.

The condition for when to redirect can very easily be enhanced to only force users to register when they try to:

  • access a protected web
  • edit a page

Syntax Rules

  • None, just install it. Modifications currently must be made in the Perl code.


  • None. It just works.

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %NEWPLUGIN_SHORTDESCRIPTION%

  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = Force externally authenticated users to register a WikiName

  • Debug plugin: (See output in data/debug.txt)
    • Set DEBUG = 0

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

  • Download the ZIP file from the Plugin web (see below)
  • Unzip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/RequireRegistrationPlugin.txt Plugin topic
    data/TWiki/RequireRegistrationPlugin.txt,v Plugin topic repository
    lib/TWiki/Plugins/ Plugin Perl module
  • Configure the Plugin:
    • TWiki 4.0 and up: Run the configure script to enable the Plugin
    • Change the Plugin settings as needed
  • Test if the installation was successful:

Plugin Info

Plugin Author: TWiki:Main.ByronIgoe
Copyright: © 2007, TWiki:Main.ByronIgoe
License: GPL (GNU General Public License)
Plugin Version: 27 Jul 2007 (V1.000)
Change History:  
27 Jul 2007: Initial version
TWiki Dependency: $TWiki::Plugins::VERSION 1.1
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.005
Benchmarks: GoodStyle nn%, FormattedSearch nn%, RequireRegistrationPlugin nn%
Plugin Home:

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

-- TWiki:Main.ByronIgoe - 27 Jul 2007

Topic revision: r1 - 27 Jul 2007 - 17:58:26 - ByronIgoe?
Copyright & by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding CTSPedia? Send feedback