RequireRegistrationPlugin

Introduction

This plugin will redirect a user to the TWikiRegistration topic if their login name is not a WikiWord, or optionally, if the user's profile page does not exist.

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

Syntax Rules

• None, just install and configure it.

Examples

• None. It just works.

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
  lib/TWiki/Plugins/RequireRegistrationPlugin/Config.spec	Spec file for configure

• Configure the Plugin:
  • Run the configure script
  • Enable the plugin in the Plugins section
  • Find the RequireRegistrationPlugin in the Extensions section and change these settings as needed:
    • {Plugins}{RequireRegistrationPlugin}{Actions} - comma-separated list of actions that this plugin should work on. Default actions: attach, edit, viewfile.
    • {Plugins}{RequireRegistrationPlugin}{RequireProfileTopic} - set to 1 if to check for existence of the user profile topic
    • {Plugins}{RequireRegistrationPlugin}{Refresh} - refresh time in seconds to do a meta refresh redirect to the registration page. Specify -1 to use an immediate redirect CGI query.
    • {Plugins}{RequireRegistrationPlugin}{RedirectMessage} - redirect message, such as "Please register before using this site" - this requires {Refresh} >= 0
• Test if the installation was successful:
  • Log in as a user without a WikiName and edit a page - it should redirect to the registration topic.
  • You can add a conditional message in the registration topic to let users know what is happening. Use an IF statement to test for parameter note=requireregistration.

Plugin Info

• One line description, shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Force externally authenticated users to register in case they do not have a TWiki account

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences