RequireRegistrationPlugin

Introduction

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.

Examples

• None. It just works.

Plugin Settings

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

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

• Refresh time in seconds to do a meta refresh redirect to the registration page. Specify -1 to use an immediate redirect CGI query:
  • Set REFRESH = -1

• 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 RequireRegistrationPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/RequireRegistrationPlugin.txt	Plugin topic
  lib/TWiki/Plugins/RequireRegistrationPlugin.pm	Plugin Perl module

• Configure the Plugin:
  • Run the configure script to enable the plugin
  • Change the plugin settings as needed
• Test if the installation was successful:
  • Log in as a user without a WikiName

Plugin Info

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences