Changes between Version 11 and Version 12 of CookBook/AccountManagerPluginConfiguration

Timestamp:

Dec 6, 2012, 2:00:36 AM (11 years ago)

Author:

Steffen Hoffmann

Comment:

move a valuable hint from main plugin page in here, change formatting for all configuration examples

CookBook/AccountManagerPluginConfiguration

@@ -6 +6 @@
 We'll collect some useful configuration examples here to give hints on proper use of available options.
 
+ '''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.
+
 == Basic configuration/Kickstart ==
+!AccountManagerPlugin replaces the traditional Trac login feature with a webform, because [wiki:AccountManagerPlugin/Modules#LoginModule LoginModule] is enabled in all examples below. No additional action is required since acct_mgr-0.4, but older plugin versions required to disable the obsoleted Trac core component explicitly:
+{{{
+#!cfg
+[components]
+trac.web.auth.loginmodule = disabled
+}}}
+
 === !HtPasswdStore ===
 {{{
+#!cfg
 [components]
 acct_mgr.admin.* = enabled
@@ -23 +33 @@
 acct_mgr.svnserve.svnservepasswordstore = disabled
 acct_mgr.web_ui.* = enabled
-trac.web.auth.loginmodule = disabled
 
 [account-manager]
@@ -42 +51 @@
 === !HtDigestStore ===
 {{{
+#!cfg
 [components]
 acct_mgr.admin.* = enabled
@@ -56 +66 @@
 acct_mgr.svnserve.svnservepasswordstore = disabled
 acct_mgr.web_ui.* = enabled
-trac.web.auth.loginmodule = disabled
 
 [account-manager]
@@ -75 +84 @@
 === !SessionStore ===
 {{{
+#!cfg
 [components]
 acct_mgr.admin.* = enabled
@@ -89 +99 @@
 acct_mgr.svnserve.svnservepasswordstore = disabled
 acct_mgr.web_ui.* = enabled
-trac.web.auth.loginmodule = disabled
 
 [account-manager]
@@ -108 +117 @@
 Create the first user through browser-based registration enabled by following additional lines in `components` section of `trac.ini`:
 {{{
+#!cfg
 [components]
 acct_mgr.register.* = enabled
@@ -114 +124 @@
 Don't add another `components` section, just the configuration line with 'enabled' into an existing `components` section. After user creation you may choose to disable registration by uncommenting the [AccountManagerPlugin#RegistrationModule RegistrationModule] setting above or changing it to:
 {{{
+#!cfg
 [components]
 ;need this for first user
@@ -138 +149 @@
 === Persistent Sessions ===
 {{{
+#!cfg
 [account-manager]
 persistent_sessions = true
@@ -149 +161 @@
 To address the demand for authentication information sharing between some/all of the Trac environments in such a setup a login synchronization process has been introduced for acct_mgr-0.4. It relies on a non-default value for the path of `trac_auth` and `trac_auth_session` cookies. Otherwise the cookie wouldn't be recognized as related to different Trac environments by the web browser client:
 {{{
+#!cfg
 [trac]
 auth_cookie_path = /var/www/trac
@@ -161 +174 @@
 
 {{{
+#!cfg
 [components]
 acct_mgr.guard.accountguard = enabled
@@ -166 +180 @@
 
 {{{
+#!cfg
 [account-manager]
 login_attempt_max_count = 0
@@ -175 +190 @@
 ==== Hard Lock-up ====
 {{{
+#!cfg
 [account-manager]
 login_attempt_max_count = 5
@@ -185 +201 @@
 ==== Fixed login delay ====
 {{{
+#!cfg
 [account-manager]
 login_attempt_max_count = 3
@@ -196 +213 @@
 ==== Modestly progressing login delay ====
 {{{
+#!cfg
 [account-manager]
 login_attempt_max_count = 2
@@ -228 +246 @@
 ==== Aggressively progressing, but limited login delay ====
 {{{
+#!cfg
 [account-manager]
 login_attempt_max_count = 4