HttpsRedirectPlugin < TWiki

Tags: view all tags
---+!! !HttpsRedirectPlugin
<!--
   Contributions to this TWiki plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/HttpsRedirectPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/HttpsRedirectPluginDev.
   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%

---++ Usage

The HTTPS redirect plug-in is designed to help you run a web site where guest users can access pages through HTTP and authenticated users will be forced to use HTTPS. This plug-in do not expose any TWiki =%<nop>VARIABLE%=. Simply activate the plug-in from =configure= to take advantage of its functionality.

Once enabled it will force authenticated users to use HTTPS by redirecting them to HTTPS URL if needed. Guests will be redirected to HTTPS only when accessing the login screen.

---++ Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server where TWiki is running.

Like many other TWiki extensions, this module is shipped with a fully
automatic installer script written using the Build<nop>Contrib.
   * If you have TWiki 4.2 or later, you can install from the =configure= interface (Go to Plugins->Find More Extensions)
      * See the [[http://twiki.org/cgi-bin/view/Plugins/BuildContribInstallationSupplement][installation supplement]] on TWiki.org for more information.
   * If you have any problems, then you can still install manually from the command-line:
      1 Download one of the =.zip= or =.tgz= archives
      1 Unpack the archive in the root directory of your TWiki installation.
      1 Run the installer script ( =perl &lt;module&gt;_installer= )
      1 Run =configure= and enable the module, if it is a plugin.
      1 Repeat for any missing dependencies.
   * If you are *still* having problems, then instead of running the installer script:
      1 Make sure that the file permissions allow the webserver user to access all files.
      1 Check in any installed files that have existing =,v= files in your existing install (take care *not* to lock the files when you check in)
      1 Manually edit !LocalSite.cfg to set any configuration variables.

%IF{"defined 'SYSTEMWEB'" else="<div class='twikiAlert'>%X% WARNING: SYSTEMWEB is not defined in this TWiki. Please add these definitions to your %MAINWEB%.TWikiPreferences, if they are not already there:<br><pre>   * <nop>Set SYSTEMWEB = %<nop>TWIKIWEB%<br>   * <nop>Set USERSWEB = %<nop>MAINWEB%</pre></div>"}%


---++ Plugin Info

   * Set SHORTDESCRIPTION = Redirect authenticated users to HTTPS URL

|  Plugin Author: | TWiki:Main.StephaneLenclud |
|  Copyright: | &copy; 2008 TWiki:Main.StephaneLenclud <br /> &copy; 2008-2011 TWiki:TWiki.TWikiContributor |
|  License: | [[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]] |
|  Plugin Version: | 20293 (2011-01-21) |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  2011-01-21: | TWikibug:Item6638: Fixing plugin for TWiki-5.0; doc improvements; changing TWIKIWEB to SYSTEMWEB -- TWiki:Main.PeterThoeny |
|  2008-08-25: | Initial version |
|  Dependencies: | None |
|  Plugin Home: | http://twiki.org/cgi-bin/view/Plugins/HttpsRedirectPlugin |
|  Feedback: | http://twiki.org/cgi-bin/view/Plugins/HttpsRedirectPluginDev |
|  Appraisal: | http://twiki.org/cgi-bin/view/Plugins/HttpsRedirectPluginAppraisal |

Many thanks to the following sponsors for supporting this work:
   * http://slion.net/

__Related Topics:__ %SYSTEMWEB%.TWikiPlugins, %SYSTEMWEB%.DeveloperDocumentationCategory, %SYSTEMWEB%.AdminDocumentationCategory, %SYSTEMWEB%.TWikiPreferences
Topic revision: r2 - 2016-02-13 - TWikiAdminUser
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.HttpsRedirectPlugin.