[[PageOutline(2-5,Contents,pullout)]]

= Auth Required Plugin =

{{{
#!html
<div class="system-message" float="left" overflow="auto">
<b>Notice:</b> This plugin is deprecated. Please see the <a href="http://trac-hacks.org/wiki/PermRedirectPlugin">PermRedirectPlugin</a> for equivalent functionality.</div>
}}}

== Description ==

This plugin redirects all anonymous requests (i.e. users not logged in) to /login.

For any practical purpose, this hack only makes sense if you are using the AccountManagerPlugin to get a form based login, and, as such, requires it.  If you aren't using AccountManager, you could simply password protect trac's base URI to present a standard auth dialog.

This is essentially a "pretty" solution to a couple annoyances:
 * trac will display an error stating that WIKI_VIEW permission is required when anonymous has no permissions (ugly)
 * certain plugins and navigation contributors still work for anonymous even if he has no permissions:
  * TagsPlugin link to tag cloud
  * /about
  * /settings

== Bugs/Feature Requests == 

Existing bugs and feature requests for AuthRequiredPlugin are 
[report:9?COMPONENT=AuthRequiredPlugin here].

If you have any issues, create a 
[http://trac-hacks.org/newticket?component=AuthRequiredPlugin&owner=BladeHawke new ticket].

== Download ==

Download the zipped source from [download:authrequiredplugin here].

== Install ==

First make sure you've [trac:wiki:TracPlugins#Requirements installed setuptools].

Then you can install the plugin using the `easy_install` application.

'''Note:''' Windows users will need to [http://peak.telecommunity.com/DevCenter/EasyInstall#windows-notes add easy_install to their PATH].

For Trac 0.10:

Install the trac:WebAdmin plugin.

Then install the AccountManagerPlugin.

Then install this plugin:
{{{
easy_install http://trac-hacks.org/svn/authrequiredplugin/0.10
}}}

== Source ==

You can check out AuthRequiredPlugin from [http://trac-hacks.org/svn/authrequiredplugin here] using Subversion, or [source:authrequiredplugin browse the source] with Trac.

== Recent Changes ==

[[ChangeLog(authrequiredplugin, 3)]]

== Author/Contributors ==

'''Author:''' [wiki:BladeHawke] [[BR]]
'''Maintainer:''' ''none'' [[BR]]
'''Contributors:'''