Changes between Version 115 and Version 116 of AccountManagerPlugin


Ignore:
Timestamp:
Jul 4, 2011 1:33:00 AM (3 years ago)
Author:
hasienda
Comment:

ultimately transform components section into table, rearrange other page content too, stepping aside from Trac 0.9, not that relevant nor supported anymore

Legend:

Unmodified
Added
Removed
Modified
  • AccountManagerPlugin

    v115 v116  
    3737 
    3838== Install == 
    39  
     39=== Prerequisites === 
    4040First make sure you’ve [trac:wiki:TracPlugins#Requirements installed setuptools].  Make sure you have a version >= 0.6c9, since previous versions contain a bug which makes the installation fail. Then you can install the plugin using the `easy_install` application. 
    4141 
    4242'''Note:''' Windows users will need to [http://peak.telecommunity.com/DevCenter/EasyInstall#windows-notes add easy_install to their PATH]. 
    4343 
    44 For Trac 0.9: 
     44=== Release Status, Downloads and Source === 
     45While in general the branch name suggests the corresponding Trac version, `0.11` should work equally well for Trac 0.11 (old stable), 0.12 (current stable) and Trac 0.13dev (development). 
     46 
     47|| Old, obsolete Version ||easy_install https://trac-hacks.org/svn/accountmanagerplugin/0.10 ||[download:accountmanagerplugin/0.10 download] ||[http://trac-hacks.org/svn/accountmanagerplugin/0.10 subversion] || 
     48|| Stable Version ||easy_install https://trac-hacks.org/svn/accountmanagerplugin/0.11 ||[download:accountmanagerplugin/0.11 download] ||[http://trac-hacks.org/svn/accountmanagerplugin/0.11 subversion] || 
     49|| Under Development ||easy_install https://trac-hacks.org/svn/accountmanagerplugin/trunk ||[download:accountmanagerplugin/trunk download] ||[http://trac-hacks.org/svn/accountmanagerplugin/trunk subversion] || 
     50 
     51[source:/accountmanagerplugin Browse the source] with Trac. For Subversion checkout use {{{svn co <url>}}} with URL depending on your Trac version and target release (see links above). 
     52 
     53'''Hint:''' If you are using the tracd standalone server or Apache 2.2.x you will need to restart it to detect the plugin. 
     54 
     55=== About i18n/l10n support === 
     56Starting with acct_mgr-0.3 this plugin is prepared for localization.[[BR]] 
     57But English message texts are still the (POSIX) default. If this isn't your preferred language, you can 
     58 1. look, if it's already available from the [TracPluginTranslation Trac plugin l10n project] at [http://www.transifex.net/projects/p/Trac_Plugin-L10N/c/acct_mgr Transifex] or 
     59 2. do it yourself (see the [http://trac.edgewall.org/wiki/CookBook/PluginL10N#Dotranslatorswork l10n cookbook page for Trac plugins] for more details). 
     60 
     61You've done a new translation? Superb! Contributing your translation is highly appreciated.[[BR]] 
     62You could send it to the plugin's maintainer or contribute to [TracPluginTranslation Trac plugin l10n project] 
     63via [http://www.transifex.net/projects/p/Trac_Plugin-L10N/ Transifex]: 
     64 
     65Top translations: Trac_Plugin-L10N » [http://www.transifex.net/projects/p/Trac_Plugin-L10N/resource/acct_mgr-messages/ acct_mgr-messages][[BR]] 
     66 [[Image(http://www.transifex.net/projects/p/Trac_Plugin-L10N/resource/acct_mgr-messages/chart/image_png, title=Go to Trac_Plugin-L10N project page on Transifex.net, link=http://www.transifex.net/projects/p/Trac_Plugin-L10N/resource/acct_mgr-messages/)]] 
     67Kindly provided by [[Image(http://sw.transifex.net/3/static/charts/images/tx-logo-micro.png, link=http://www.transifex.net/, title=the open translation platform, valign=bottom)]] 
     68 
     69Preparing the plugin from source requires '''no additional steps''' for compiling message catalog files. Only to include translations marked as `# fuzzy` by the translator, you'll want to do a manual message catalog compilation with the extra `-f` argument before packaging: 
    4570{{{ 
    46 easy_install http://trac-hacks.org/svn/accountmanagerplugin/0.9 
    47 }}} 
     71cd accountmanagerplugin/ 
     72python ./setup.py compile_catalog -f 
     73python ./setup.py bdist_egg 
     74}}}  
     75Complaints about missing `locale` directory are often a side-effect of failure to compile any message catalog for inclusion into Python egg, hence the whole path is missing. Due to a know Trac issue Babel has to be installed prior to Trac, to get it all working as expected.[[BR]] 
     76Again, for more details see the [t:wiki:CookBook/PluginL10N#Compileanduseit l10n cookbook page for Trac plugins]. 
    4877 
    49 For Trac 0.10: 
     78== Setup == 
     79=== Components === 
     80In order to use the features of the !AccountManager you will need to enable some or all of its components. 
     81The available components are mentioned below, but described in greater details on a [wiki:AccountManagerPlugin/Modules separate page]. 
    5082 
    51 Install the trac:WebAdmin plugin. 
     83||'''Component'''||'''Description/Purpose'''||'''Recommendation'''|| 
     84||!AccountManager ||This holds core code of this plugin. ||This component ''must'' be enabled to use any of the other components. See [wiki:AccountManagerPlugin/Modules#AccountManager details]. || 
     85||!AccountManagerAdminPages^1^ ||This component adds new pages to the trac:WebAdmin section.||The admin part for managing related parts of Trac's configuration^2^ should be an important part of what you're expecting. See [wiki:AccountManagerPlugin/Modules#AccountManagerAdminPage details]. || 
     86||!AccountModule ||Allows users to manage their account^3^ via tab “Account” in users “Preferences”. ||The user accessible part, might be required or even forbidden depending on your use case. See [wiki:AccountManagerPlugin/Modules#AccountModule details]. || 
     87||!LoginModule ||Allows users to login via a HTML form instead of using HTTP authentication. ||Replace Trac's own login module for an alternative to Simple HTTP Authentication, but only one can be enable at a time. See [wiki:AccountManagerPlugin/Modules#LoginModule details]. || 
     88||!AccountGuard ||This component adds login failure tracking and administrative account locking. ||Use it as part of your security policy to protect against brute-force attacks on user passwords. See [wiki:AccountManagerPlugin/Modules#AccountGuard details]. || 
     89||!RegistrationModule ||It adds a “Register” link on metanav^4^. ||Enable users to register a new account with a configurable procedure. See [wiki:AccountManagerPlugin/Modules#RegistrationModule details]. 
     90||!EmailVerificationModule ||An new email address will trigger an email with a verification code to enter, to approve it is really users own email address, and user account privileges cut down until successful verification. ||Implement a verification process for added or changed email addresses, if required. See [wiki:AccountManagerPlugin/Modules#EmailVerificationModule details]. || 
     91^1^ name in acct_mgr-0.3, old name has been `AccountManagerAdminPage`[[BR]] 
     92^2^ found in `trac.ini`[[BR]] 
     93^3^ change their password, or even delete their account, if permission granted by appropriate configuration[[BR]] 
     94^4^ same menu bar as the “Login” link 
    5295 
    53 Then install this plugin: 
    54 {{{ 
    55 easy_install http://trac-hacks.org/svn/accountmanagerplugin/0.10 
    56 }}} 
    57  
    58 For Trac 0.11 
    59 {{{ 
    60 easy_install http://trac-hacks.org/svn/accountmanagerplugin/0.11 
    61 }}} 
    62  
    63 For Trac 0.12: 
    64 {{{ 
    65 easy_install https://trac-hacks.org/svn/accountmanagerplugin/trunk 
    66 }}} 
    67  
    68 If you are using the tracd standalone server or Apache 2.2.x you will need to restart it to detect the plugin. 
    69  
    70 == Source == 
    71  
    72 [source:/accountmanagerplugin Browse the source] 
    73  
    74 Subversion Checkout (depends on your Trac version): 
    75 {{{ 
    76 svn co http://trac-hacks.org/svn/accountmanagerplugin/0.9 
    77 svn co http://trac-hacks.org/svn/accountmanagerplugin/0.10 
    78 svn co http://trac-hacks.org/svn/accountmanagerplugin/0.11 
    79 svn co http://trac-hacks.org/svn/accountmanagerplugin/trunk 
    80 }}} 
    81  
    82 Downloads: 
    83  * [download:accountmanagerplugin/0.9 0.9] 
    84  * [download:accountmanagerplugin/0.10 0.10] 
    85  * [download:accountmanagerplugin/0.11 0.11] 
    86  * [download:accountmanagerplugin/trunk trunk] 
    87  
    88 == Components == 
    89  
    90 In order to use the features of the AccountManager you will need to enable some or all of its components. 
    91  
    92 The easiest way to enable the components is via the trac:WebAdmin plugin.  Users logged in with the TRAC_ADMIN permission will be able to manage the enabled components: 
     96The easiest way to learn about available components and enable them is via Trac's plugin admin page (before Trac 0.11 this has been a separate trac:WebAdmin plugin).  Users logged in with the TRAC_ADMIN permission will be able to manage the enabled components: 
    9397 
    9498[[Image(components-admin.png)]] 
     
    112116}}} 
    113117 
    114  
    115 The available components are mentioned below, but described in greater details on a [wiki:AccountManagerPlugin/Modules separate page]. 
    116  
     118=== Configuration === 
    117119See [wiki:CookBook/AccountManagerPluginConfiguration configuration cookbook] page for hint's on proper configuration. 
    118120 
    119 === !AccountManager === 
    120 This holds core code of this plugin, so this component ''must'' be enabled to use any of the other components. 
    121  
    122 See [wiki:AccountManagerPlugin/Modules#AccountManager details]. 
    123  
    124 === !AccountManagerAdminPage === 
    125 This component adds new pages to the trac:WebAdmin section for managing related parts of Trac's configuration (found in `trac.ini`). 
    126  
    127 See [wiki:AccountManagerPlugin/Modules#AccountManagerAdminPage details]. 
    128  
    129 === !AccountModule === 
    130 Allows users to change their password, or delete their account via tab “Account” in users “Preferences”. 
    131  
    132 See [wiki:AccountManagerPlugin/Modules#AccountModule details]. 
    133  
    134 === !LoginModule === 
    135 Allows users to login via a HTML form instead of using HTTP authentication. 
    136  
    137 See [wiki:AccountManagerPlugin/Modules#LoginModule details]. 
    138  
    139 === !AccountGuard === 
    140 This component adds login failure tracking and administrative account locking to protect against brute-force attacks on user passwords. 
    141  
    142 See [wiki:AccountManagerPlugin/Modules#AccountGuard details]. 
    143  
    144 === !RegistrationModule === 
    145 Enables users to register a new account.  It adds a “Register” link on metanav, the same menu bar as the “Login” link. 
    146  
    147 See [wiki:AccountManagerPlugin/Modules#RegistrationModule details]. 
    148  
    149 === !EmailVerificationModule === 
    150 Adding or changing an email address will trigger an email with a verification code to enter, to approve it is really users own email address, and user account priviledges cut down until successful verification. 
    151  
    152 See [wiki:AccountManagerPlugin/Modules#EmailVerificationModule details]. 
    153  
    154121== Post Setup/Configuration == 
    155  
    156122In order to use the Account Manager plugin, while logged in as a user with TRAC_ADMIN rights, use the new “Admin” link on the menubar. 
    157123 
    158124Once in, you might want to enable the permissions to allow the “authenticated” user group permissions.  For instance, if you remove the anonymous group from TICKET_MODIFY, and WIKI_MODIFY, and add the “authenticated” group instead, only authenticated, logged-in (registered) users can perform ticket modifications and wiki editing. 
    159125 
    160 === About i18n/l10n support === 
    161  
    162 The development version of this plugin is prepared for localization.[[BR]] 
    163 But English message texts are still the (POSIX) default. If this isn't your preferred language, you can 
    164  1. look, if it's already available from the [TracPluginTranslation Trac plugin l10n project] at [http://www.transifex.net/projects/p/Trac_Plugin-L10N/c/acct_mgr Transifex] or 
    165  2. do it yourself (see the [http://trac.edgewall.org/wiki/CookBook/PluginL10N#Dotranslatorswork l10n cookbook page for Trac plugins] for more details). 
    166  
    167 You've done a new translation? Superb! Contributing your translation is highly appreciated.[[BR]] 
    168 You could send it to the plugin's maintainer or contribute to [TracPluginTranslation Trac plugin l10n project] 
    169 via [http://www.transifex.net/projects/p/Trac_Plugin-L10N/ Transifex]: 
    170  
    171 Top translations: Trac_Plugin-L10N » [http://www.transifex.net/projects/p/Trac_Plugin-L10N/resource/acct_mgr-messages/ acct_mgr-messages][[BR]] 
    172  [[Image(http://www.transifex.net/projects/p/Trac_Plugin-L10N/resource/acct_mgr-messages/chart/image_png, title=Go to Trac_Plugin-L10N project page on Transifex.net, link=http://www.transifex.net/projects/p/Trac_Plugin-L10N/resource/acct_mgr-messages/)]] 
    173 Kindly provided by [[Image(http://sw.transifex.net/3/static/charts/images/tx-logo-micro.png, link=http://www.transifex.net/, title=the open translation platform, valign=bottom)]] 
    174  
    175 Preparing the plugin from source requires '''no additional steps''' for compiling message catalog files. Only to include translations marked as `# fuzzy` by the translator, you'll want to do a manual message catalog compilation with the extra `-f` argument before packaging: 
    176 {{{ 
    177 cd accountmanagerplugin/ 
    178 python ./setup.py compile_catalog -f 
    179 python ./setup.py bdist_egg 
    180 }}}  
    181 Complaints about missing `locale` directory are often a side-effect of failure to compile any message catalog for inclusion into Python egg, hence the whole path is missing. Due to a know Trac issue Babel has to be installed prior to Trac, to get it all working as expected.[[BR]] 
    182 Again, for more details see the [t:wiki:CookBook/PluginL10N#Compileanduseit l10n cookbook page for Trac plugins]. 
    183  
    184126== Recent Changes == 
    185  
    186127[[ChangeLog(/accountmanagerplugin,3)]] 
    187128