Changes between Version 176 and Version 177 of AccountManagerPlugin


Ignore:
Timestamp:
Nov 5, 2016, 9:38:36 PM (7 years ago)
Author:
figaro
Comment:

Relocated paragraphs to maintain consistency

Legend:

Unmodified
Added
Removed
Modified

  • AccountManagerPlugin

    v176 v177  
    5151[[TicketQuery(component=AccountManagerPlugin&group=type,format=progress)]]
    5252
    53 == Installation
    54 
    55 === Release Status, Downloads and Source
     53== Downloads and Source
    5654
    5755|| '''Stable Version''' ||easy_install https://trac-hacks.org/svn/accountmanagerplugin/tags/acct_mgr-0.4.4 ||download from [export:accountmanagerplugin/tags/acct_mgr-0.4.4 trac-hacks] or from [pypi:TracAccountManager pypi]||[/svn/accountmanagerplugin/tags/acct_mgr-0.4.4 subversion] ||
    … …  
    7068'''Upgrades from previous versions''': Please see the [source:accountmanagerplugin/trunk/README.update README.update] file included in the source.
    7169
    72 === About i18n/l10n support
     70== Installation
     71
     72To use the features of the !AccountManager some or all of its components need to be enabled.
     73The available components are mentioned here, but are described in greater details on separate pages linked below.
     74
     75||'''Component'''||'''Description/Purpose'''||'''Recommendation'''||
     76||[wiki:AccountManagerPlugin/Modules#AccountManager AccountManager] ||This holds the core code of this plugin. ||This component ''must'' be enabled to use any of the other components. See [wiki:AccountManagerPlugin/Modules#AccountManager details]. ||
     77||[wiki:AccountManagerPlugin/Modules#AccountManagerAdminPanel AccountManagerAdminPanel]^1^ ||This component adds new pages to the web admin section.||The admin part for managing related parts of Trac's configuration in `trac.ini` should be an important part of what you're expecting. See [wiki:AccountManagerPlugin/Modules#AccountManagerAdminPanel details]. ||
     78||[wiki:AccountManagerPlugin/Modules#AccountModule AccountModule] ||Allows users to manage their account via tab "Account" in users "Preferences". They can change their password, or even delete their account, if permission granted by appropriate configuration.||The user accessible part, might be required or even forbidden depending on your use case. See [wiki:AccountManagerPlugin/Modules#AccountModule details]. ||
     79||[wiki:AccountManagerPlugin/Modules#LoginModule 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 enabled at a time. See [wiki:AccountManagerPlugin/Modules#LoginModule details]. ||
     80||[wiki:AccountManagerPlugin/Modules#AccountGuard 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]. ||
     81||[wiki:AccountManagerPlugin/RegistrationInspector#RegistrationModule RegistrationModule] ||This adds a "Register" link on metanav, next to the Login link, where users can register a new account. The procedure of registration is configurable. ||See [wiki:AccountManagerPlugin/RegistrationInspector#RegistrationModule details].
     82||[wiki:AccountManagerPlugin/RegistrationInspector#EmailVerificationModule 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/RegistrationInspector#EmailVerificationModule details]. ||
     83^1^ Name in acct_mgr-0.3 was `AccountManagerAdminPage`. If you are upgrading to acct_mgr-0.4 from an earlier version, and this feature was enabled using `acct_mgr.admin.AccountManagerAdminPages`, this feature will now be disabled until it is enabled using `acct_mgr.admin.AccountManagerAdminPanel`.[[BR]]
     84
     85The 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:TracWebAdmin plugin. Users logged in with the `TRAC_ADMIN` permission will be able to manage the enabled components:
     86
     87[[Image(components-admin_acct_mgr-0.4.png, border=2)]]
     88
     89Components can also be enabled or disabled in the [trac:TracIni trac.ini] file under the `[components]` section.
     90
     91== Configuration
     92
     93The number of component dependencies, options and their relation to components is currently worked on, see #8930.
     94
     95The [wiki:CookBook/AccountManagerPluginConfiguration configuration cookbook] is the recommended place to look for examples of basic configurations and more.
     96
     97To use the !AccountManager plugin, while logged in as a user with `TRAC_ADMIN` rights, use the "Admin" link on the menubar.
     98
     99You might want to change some permission assignments. For instance, if you remove `TICKET_MODIFY` and `WIKI_MODIFY` permission from the "anonymous" group and add it to the "authenticated" group instead, then only authenticated, logged-in (registered) users can perform ticket modifications and wiki editing.
     100
     101`TRAC_ADMIN` is not strictly required for access to account administration pages provided by !AccountManager. The `ACCTMGR_*` permissions are sufficient, and should even be preferred where appropriate, ie to limit delegation of administrative tasks to just account administration by granting `ACCTMGR_USER_ADMIN`.
     102
     103== About i18n/l10n support
    73104
    74105Starting with acct_mgr-0.3 this plugin has been prepared for localization, and English message texts are the (POSIX) default. If English is not your preferred language, you can:
    … …  
    94125Complaints 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 known Trac issue, Babel has to be installed prior to Trac to get it all working as expected. See the [t:wiki:CookBook/PluginL10N#Compileanduseit l10n cookbook page for Trac plugins] for more details.
    95126
    96 == Setup
    97 
    98 === Components
    99 
    100 To use the features of the !AccountManager some or all of its components need to be enabled.
    101 The available components are mentioned here, but are described in greater details on separate pages linked below.
    102 
    103 ||'''Component'''||'''Description/Purpose'''||'''Recommendation'''||
    104 ||[wiki:AccountManagerPlugin/Modules#AccountManager 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]. ||
    105 ||[wiki:AccountManagerPlugin/Modules#AccountManagerAdminPanel AccountManagerAdminPanel]^1^ ||This component adds new pages to the web admin 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#AccountManagerAdminPanel details]. ||
    106 ||[wiki:AccountManagerPlugin/Modules#AccountModule 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]. ||
    107 ||[wiki:AccountManagerPlugin/Modules#LoginModule 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]. ||
    108 ||[wiki:AccountManagerPlugin/Modules#AccountGuard 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]. ||
    109 ||[wiki:AccountManagerPlugin/RegistrationInspector#RegistrationModule RegistrationModule] ||It adds a “Register” link on metanav^4^. ||Enable users to register a new account with a configurable procedure. See [wiki:AccountManagerPlugin/RegistrationInspector#RegistrationModule details].
    110 ||[wiki:AccountManagerPlugin/RegistrationInspector#EmailVerificationModule 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/RegistrationInspector#EmailVerificationModule details]. ||
    111 ^1^ Name in acct_mgr-0.3 was `AccountManagerAdminPage`. If you are upgrading to acct_mgr-0.4 from an earlier version, and this feature was enabled using `acct_mgr.admin.AccountManagerAdminPages`, this feature will now be disabled until it is enabled using `acct_mgr.admin.AccountManagerAdminPanel`.[[BR]]
    112 ^2^ Found in `trac.ini`.[[BR]]
    113 ^3^ Change their password, or even delete their account, if permission granted by appropriate configuration.[[BR]]
    114 ^4^ Same menu bar as the "Login" link.
    115 
    116 The 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:TracWebAdmin plugin. Users logged in with the `TRAC_ADMIN` permission will be able to manage the enabled components:
    117 
    118 [[Image(components-admin_acct_mgr-0.4.png)]]
    119 
    120 Components can also be enabled or disabled in the [trac:TracIni trac.ini] file under the `[components]` section.
    121 
    122 === Configuration
    123 
    124 The number of component dependencies, options and their relation to components is currently worked on, see #8930.
    125 
    126 The [wiki:CookBook/AccountManagerPluginConfiguration configuration cookbook] is the recommended place to look for examples of basic configurations and more.
    127 
    128 == Post Setup/Configuration
    129 
    130 To use the !AccountManager plugin, while logged in as a user with `TRAC_ADMIN` rights, use the "Admin" link on the menubar.
    131 
    132 You might want to change some permission assignments. For instance, if you remove `TICKET_MODIFY` and `WIKI_MODIFY` permission from the "anonymous" group and add it to the "authenticated" group instead, then only authenticated, logged-in (registered) users can perform ticket modifications and wiki editing.
    133 
    134 `TRAC_ADMIN` is not strictly required for access to account administration pages provided by !AccountManager. The `ACCTMGR_*` permissions are sufficient, and should even be preferred where appropriate, ie to limit delegation of administrative tasks to just account administration by granting `ACCTMGR_USER_ADMIN`.
    135 
    136127== Recent Changes
    137128