[[PageOutline(2-5,Contents,pullout)]] [[html(
)]] '''!ToDo''' * short-term: release of !AcctMgr 0.3 '''News''' 18-Jun-2011:: important fix to the 'lost password' procedure, backported to `0.10` branch as well 12-Jun-2011:: Account editor finally reworked in ''trunk'', a password hash refresh feature has been added some days before (open: 47) 29-Nov-2010:: Account locking feature and account details admin page added to ''trunk'' (open: 43) 17-Oct-2010:: more bug squashing, and i18n support has been introduced to ''trunk'' (open: 46) 28-Sep-2010:: Maintainership handed over from [wiki:pacopablo] to [wiki:hasienda] 26-Sep-2010:: Starting ticket list cleanup and triaging (open: 96) [[html(
)]] = Account Manager Plugin = == Description == The AccountManagerPlugin offers several features for managing user accounts: * enable authentication through a number of build-in [wiki:AccountManagerPlugin/AuthStores authentication resources] and some more by [wiki:AccountManagerPlugin/AuthStores#Othersources 3rd party extensions] * allow users to register new accounts * login via an HTML [wiki:AccountManagerPlugin#LoginModule form] instead of using HTTP authentication * allow existing users to change their passwords or delete their accounts These features are new in the plugin for Trac 0.10. * send a new password to users who’ve forgotten their password * administration of user accounts == Bugs/Feature Requests == Existing bugs and feature requests for !AccountManagerPlugin are available from Trac-Hacks [query:?status!=closed&group=&component=AccountManagerPlugin&order=priority ticket system]. If you have any issues that is not found in [query:?component=AccountManagerPlugin&order=priority existing tickets], create a [http://trac-hacks.org/newticket?component=AccountManagerPlugin&owner=hasienda new ticket], please. You do wonder, if you could contribute here? Great! There are some recommendations, [wiki:AccountManagerPlugin/TicketBurndown where to start]. == Install == First 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. '''Note:''' Windows users will need to [http://peak.telecommunity.com/DevCenter/EasyInstall#windows-notes add easy_install to their PATH]. For Trac 0.9: {{{ easy_install http://trac-hacks.org/svn/accountmanagerplugin/0.9 }}} For Trac 0.10: Install the trac:WebAdmin plugin. Then install this plugin: {{{ easy_install http://trac-hacks.org/svn/accountmanagerplugin/0.10 }}} For Trac 0.11 {{{ easy_install http://trac-hacks.org/svn/accountmanagerplugin/0.11 }}} For Trac 0.12: {{{ easy_install https://trac-hacks.org/svn/accountmanagerplugin/trunk }}} If you are using the tracd standalone server or Apache 2.2.x you will need to restart it to detect the plugin. == Source == [source:/accountmanagerplugin Browse the source] Subversion Checkout (depends on your Trac version): {{{ svn co http://trac-hacks.org/svn/accountmanagerplugin/0.9 svn co http://trac-hacks.org/svn/accountmanagerplugin/0.10 svn co http://trac-hacks.org/svn/accountmanagerplugin/0.11 svn co http://trac-hacks.org/svn/accountmanagerplugin/trunk }}} Downloads: * [download:accountmanagerplugin/0.9 0.9] * [download:accountmanagerplugin/0.10 0.10] * [download:accountmanagerplugin/0.11 0.11] * [download:accountmanagerplugin/trunk trunk] == Components == In order to use the features of the AccountManager you will need to enable some or all of its components. 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: [[Image(components-admin.png)]] Components can also be enabled or disabled in the [trac:TracIni trac.ini] file under the `[components]` section. For example to enable the login form and disable user registration: {{{ #!cfg [components] trac.web.auth.LoginModule = disabled acct_mgr.web_ui.LoginModule = enabled acct_mgr.web_ui.RegistrationModule = disabled }}} '''Hint:''' Option names are written in !CamelCase style notation, but will get (re-)written all-lowercase, if added/updated via the Trac admin web-UI. Anyway, case doesn't really matter here. '''Note:''' To make it to replace the traditional trac login feature with a webform, also add: {{{ #!cfg [components] trac.web.auth.loginmodule = disabled }}} The available components are mentioned below, but described in greater details on a [wiki:AccountManagerPlugin/Modules separate page]. See [wiki:CookBook/AccountManagerPluginConfiguration configuration cookbook] page for hint's on proper configuration. === !AccountManager === This holds core code of this plugin, so this component ''must'' be enabled to use any of the other components. See [wiki:AccountManagerPlugin/Modules#AccountManager details]. === !AccountManagerAdminPage === This component adds new pages to the trac:WebAdmin section for managing related parts of Trac's configuration (found in `trac.ini`). See [wiki:AccountManagerPlugin/Modules#AccountManagerAdminPage details]. === !AccountModule === Allows users to change their password, or delete their account via tab “Account” in users “Preferences”. See [wiki:AccountManagerPlugin/Modules#AccountModule details]. === !LoginModule === Allows users to login via a HTML form instead of using HTTP authentication. See [wiki:AccountManagerPlugin/Modules#LoginModule details]. === !RegistrationModule === Enables users to register a new account. It adds a “Register” link on metanav, the same menu bar as the “Login” link. See [wiki:AccountManagerPlugin/Modules#RegistrationModule details]. === !EmailVerificationModule === 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. See [wiki:AccountManagerPlugin/Modules#EmailVerificationModule details]. == Post Setup/Configuration == In 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. Once 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. === About i18n/l10n support === The development version of this plugin is prepared for localization.[[BR]] But English message texts are still the (POSIX) default. If this isn't your preferred language, you can 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 2. do it yourself (see the [http://trac.edgewall.org/wiki/CookBook/PluginL10N#Dotranslatorswork l10n cookbook page for Trac plugins] for more details). You've done a new translation? Superb! Contributing your translation is highly appreciated.[[BR]] You could send it to the plugin's maintainer or contribute to [TracPluginTranslation Trac plugin l10n project] via [http://www.transifex.net/projects/p/Trac_Plugin-L10N/ Transifex]: Top translations: Trac_Plugin-L10N » [http://www.transifex.net/projects/p/Trac_Plugin-L10N/resource/r-acct_mgr-locale-messages-pot_0/ r-acct_mgr-locale-messages-pot_0][[BR]] [[Image(http://www.transifex.net/projects/p/Trac_Plugin-L10N/resource/r-acct_mgr-locale-messages-pot_0/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/r-acct_mgr-locale-messages-pot_0/)]] 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)]] 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: {{{ cd accountmanagerplugin/ python ./setup.py compile_catalog -f python ./setup.py bdist_egg }}} 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]] Again, for more details see the [t:wiki:CookBook/PluginL10N#Compileanduseit l10n cookbook page for Trac plugins]. == Recent Changes == [[ChangeLog(/accountmanagerplugin,3)]] == Author/Contributors == '''Author:''' [wiki:mgood] [[BR]] '''Maintainer:''' [wiki:hasienda] [[BR]] '''Contributors:''' [wiki:coderanger], [wiki:crocea], [wiki:manski], [wiki:mrelbe], [wiki:otaku42], [wiki:pacopablo], [wiki:riggs], [wiki:s0undt3ch] [[BR]]