Changes between Version 21 and Version 22 of AccountManagerPlugin


Ignore:
Timestamp:
Aug 6, 2006, 11:12:40 PM (8 years ago)
Author:
mgood
Comment:

document remaining components

Legend:

Unmodified
Added
Removed
Modified
  • AccountManagerPlugin

    v21 v22  
    6969}}}
    7070
    71 The available components are describe below.
     71The available components are described below.
    7272
    7373=== !AccountManager ===
     
    141141[[Image(reset-password.png)]]
    142142
    143 == Example ==
     143=== !LoginModule ===
     144 '''Package''':: acct_mgr.web_ui
    144145
    145 The AccountManagerPlugin settings are configured in the [trac:TracIni trac.ini] file.
     146'''Warning:''' this module is not supported using the [trac:TracStandalone tracd] stand-alone server on Trac 0.9.  It either needs Trac 0.10, or an external webserver such as Apache.
    146147
    147 The plugin includes support for the two password file formats used by Apache.
     148Allows users to login via a HTML form instead of using HTTP authentication.
    148149
    149 '''Note:''' the webserver needs permission to write to both the password file '''and the directory''' where it's located.
    150 
    151 For htpasswd:
    152 {{{
    153 [account-manager]
    154 password_format = htpasswd
    155 password_file = /var/trac/trac.htpasswd
    156 }}}
    157 
    158 For htdigest:
    159 {{{
    160 [account-manager]
    161 password_format = htdigest
    162 password_file = /var/trac/trac.htdigest
    163 htdigest_realm = TracRealm
    164 }}}
    165 
    166 == Form-based Login ==
    167 
    168 The plugin supports allowing users to login via a form instead of HTTP authentication.  You will need to turn off the default Trac login handler and enable the handler from the AccountManagerPlugin in your `trac.ini` file:
    169 
     150In order to use this plugin you will need to disable the default Trac login module:
    170151{{{
    171152[components]
     
    174155}}}
    175156
     157[[Image(login-form.png)]]
     158
     159==== Disable HTTP authentication ====
     160
     161When using the [trac:TracStandalone tracd] server be sure '''not''' to use the "--auth" or "--basic-auth" options.  Using either of these options will cause tracd to popup the username/password dialog box and you will not be able to use the HTML form.
     162
     163If you have previously enabled authentication for Trac on Apache, you will need to disable it or Apache will popup the username/password dialog and you will be unable to use the HTML form.  In order to disable the authentication look for a section in the Apache configuration file like like:
     164
     165{{{
     166<Location /trac/login>
     167   # Some options like AuthType and AuthUserFile
     168   Require valid-user
     169</Location>
     170}}}
     171
     172Deleting or commenting the `Require valid-user` line should be sufficient to disable HTTP authentication.  After you've tested it you can probably delete or comment out the rest of the authentication options.
     173
     174=== !RegistrationModule ===
     175 '''Package''':: acct_mgr.web_ui
     176
     177Enables users to register a new account.  It adds a "Register" link on the same menu bar as the "Login" link.
     178
     179[[Image(register.png)]]
     180
    176181== Author/Contributors ==
    177182
    178 '''Author:''' [wiki:mgood mgood] [[BR]]
     183'''Author:''' [wiki:mgood] [[BR]]
    179184'''Contributors:'''
    180185