RequireRegistrationPlugin < TWiki

Tags: , view all tags
---+!! <nop>%TOPIC%
<!--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/RequireRegistrationPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/RequireRegistrationPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->
<sticky><div style="float:right; background-color:#EBEEF0; margin:0 0 20px 20px; padding: 0 10px 0 10px;">
%TOC{title="Page contents"}%
</div></sticky>
%SHORTDESCRIPTION%

---++ Introduction

This plugin will redirect a user to the %SYSTEMWEB%.TWikiRegistration topic if their login name is not a %SYSTEMWEB%.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 ==%TOPIC%.zip== in your twiki installation directory. Content:
     | *File:* | *Description:* |
     | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
     | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
     | ==lib/TWiki/Plugins/%TOPIC%/Config.spec== | Spec file for configure |
   * Configure the Plugin:
      * Run the [[%SCRIPTURL{configure}%][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 %SYSTEMWEB%.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 [[%SYSTEMWEB%.IfStatements][IF statement]] to test for parameter =note=requireregistration=.

---++ Plugin Info

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

%TABLE{ tablewidth="100%" columnwidths="170," }%
|  Plugin Author: | TWiki:Main.ByronIgoe |
|  Copyright: | &copy; 2007 TWiki:Main.ByronIgoe <br /> &copy; 2012 TWiki:Main.WillemEngen <br /> &copy; 2009-2013 TWiki:Main.PeterThoeny <br /> &copy; 2008-2013 TWiki:Main.TWikiContributors |
|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
|  Sponsor: | [[http://www.carbondesignsystems.com/][Carbon Design Systems]] |
|  Plugin Version: | 2013-07-09 (v1.5) |
%TWISTY{
 mode="div"
 showlink="Show Change History %ICONURL{toggleopen}%"
 hidelink="Hide Change History %ICONURL{toggleclose}%"
}%
%TABLE{ tablewidth="100%" columnwidths="170," }%
|  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 |
%ENDTWISTY%
%TABLE{ tablewidth="100%" columnwidths="170," }%
|  TWiki Dependency: | $TWiki::Plugins::VERSION 1.1 |
|  CPAN Dependencies: | none |
|  Other Dependencies: | none |
|  Perl Version: | 5.005 |
|  [[TWiki:Plugins/Benchmark][Benchmarks]]: | %SYSTEMWEB%.GoodStyle nn%, %SYSTEMWEB%.FormattedSearch nn%, %TOPIC% nn% |
|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
|  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |

__Related Topics:__ %SYSTEMWEB%.TWikiPlugins, %SYSTEMWEB%.DeveloperDocumentationCategory, %SYSTEMWEB%.AdminDocumentationCategory, %SYSTEMWEB%.TWikiPreferences
Topic revision: r0 - 2013-07-09 - TWikiContributor
Account
- Log In
Edit
Attach
Copyright © 1999-2025 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.
antalya escort bursa escort eskisehir escort istanbul escort izmir escort