RequireRegistrationPlugin

Force externally authenticated users to register in case they do not have a TWiki account

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.
  • 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

Plugin Author: TWiki:Main.ByronIgoe
Copyright: © 2007 TWiki:Main.ByronIgoe
© 2012 TWiki:Main.WillemEngen
© 2009-2013 TWiki:Main.PeterThoeny
© 2008-2013 TWiki:Main.TWikiContributors
License: GPL (GNU General Public License)
Sponsor: Carbon Design Systems
Plugin Version: 2013-07-09 (v1.5)
2013-07-09: TWikibug:Item7291: New flag to check for existence of user profile topic -- TWiki:Main.PeterThoeny
2012-09-03: TWikibug:Item6915: Move settings to configure; add {Plugins}{$pluginName}{Actions} setting -- TWiki:Main.WillemEngen
2011-08-02: TWikibug:Item6725: Change global package variables from "use vars" to "our" -- TWiki:Main.PeterThoeny
2010-10-29: Doc fixes -- TWiki:Main.PeterThoeny
2008-03-04: Fix bug in addToHEAD, made redirect method and refresh time configurable -- TWiki:Main.PeterThoeny
2007-08-27: 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: http://TWiki.org/cgi-bin/view/Plugins/RequireRegistrationPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/RequireRegistrationPluginDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/RequireRegistrationPluginAppraisal

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

Topic revision: r0 - 2013-07-10 - TWikiContributor
 
    • Cern Search Icon Cern Search
    • TWiki Search Icon TWiki Search
    • Google Search Icon Google Search

    TWiki All webs login

This site is powered by the TWiki collaboration platform Powered by PerlCopyright & 2008-2018 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.RequireRegistrationPlugin