From e43fe9ab3b7d997b2d141d177de0429d73a2b67a Mon Sep 17 00:00:00 2001
From: "lpsolit%gmail.com" <>
Date: Fri, 4 Apr 2008 11:47:57 +0000
Subject: Docs patch for bug 119485: update documentation about user account
administration - Patch by me, r=justdave
---
docs/en/xml/administration.xml | 155 +++++++++++++++++++++++++++--------------
1 file changed, 102 insertions(+), 53 deletions(-)
(limited to 'docs/en')
diff --git a/docs/en/xml/administration.xml b/docs/en/xml/administration.xml
index e9d48804e..f27ca462c 100644
--- a/docs/en/xml/administration.xml
+++ b/docs/en/xml/administration.xml
@@ -339,9 +339,9 @@
If you wish to add more administrative users, add them to
- the "admin" group and, optionally, add edit the tweakparams, editusers,
+ the "admin" group and, optionally, edit the tweakparams, editusers,
creategroups, editcomponents, and editkeywords groups to add the
- entire admin group to those groups.
+ entire admin group to those groups (which is the case by default).
@@ -349,62 +349,88 @@
Managing Other Users
+
+ Searching for existing users
+
+
+ If you have editusers
privileges or if you are allowed
+ to grant privileges for some groups, the Users
link
+ appears in the footer.
+
+
+
+ The first screen you get is a search form to search for existing user
+ accounts. You can run searches based either on the ID, real name or
+ login name (i.e. the email address in most cases) of users. You can
+ search in different ways the listbox to the right of the text entry
+ box. You can match by case-insensitive substring (the default),
+ regular expression, a reverse regular expression
+ match, which finds every user name which does NOT match the regular
+ expression, or the exact string if you know exactly who you are looking for.
+
+
+
+ You can also restrict your search to users being in some specific group.
+ By default, the restriction is turned off. Then you get a list of
+ users matching your critera, and clicking their login name lets you
+ edit their properties.
+
+
+
Creating new users
- Your users can create their own user accounts by clicking the
- "New Account" link at the bottom of each page (assuming they
- aren't logged in as someone else already.) However, should you
- desire to create user accounts ahead of time, here is how you do
- it.
+
+ Self-registration
-
-
- After logging in, click the "Users" link at the footer of
- the query page, and then click "Add a new user".
-
+
+ By default, users can create their own user accounts by clicking the
+ New Account
link at the bottom of each page (assuming
+ they aren't logged in as someone else already). If you want to disable
+ this self-registration, or if you want to restrict who can create his
+ own user account, you have to edit the createemailregexp
+ parameter in the Configuration
page, see
+ .
+
+
-
- Fill out the form presented. This page is self-explanatory.
- When done, click "Submit".
+
+ Accounts created by an administrator
-
- Adding a user this way will
- not
-
- send an email informing them of their username and password.
- While useful for creating dummy accounts (watchers which
- shuttle mail to another system, for instance, or email
- addresses which are a mailing list), in general it is
- preferable to log out and use the
- New Account
-
- button to create users, as it will pre-populate all the
- required fields and also notify the user of her account name
- and password.
-
-
-
+
+ Users with editusers
privileges, such as administrators,
+ can create user accounts for other users:
+
+
+
+
+ After logging in, click the "Users" link at the footer of
+ the query page, and then click "Add a new user".
+
+
+
+ Fill out the form presented. This page is self-explanatory.
+ When done, click "Submit".
+
+
+ Adding a user this way will not
+ send an email informing them of their username and password.
+ While useful for creating dummy accounts (watchers which
+ shuttle mail to another system, for instance, or email
+ addresses which are a mailing list), in general it is
+ preferable to log out and use the New Account
+ button to create users, as it will pre-populate all the
+ required fields and also notify the user of her account name
+ and password.
+
+
+
+
Modifying Users
- To see a specific user, search for their login name
- in the box provided on the "Edit Users" page. To see all users,
- leave the box blank.
-
- You can search in different ways the listbox to the right
- of the text entry box. You can match by
- case-insensitive substring (the default),
- regular expression, or a
- reverse
- regular expression match, which finds every user name which does NOT
- match the regular expression. (Please see
- the man regexp
- manual page for details on regular expression syntax.)
-
-
Once you have found your user, you can change the following
fields:
@@ -413,9 +439,9 @@
Login Name:
This is generally the user's full email address. However, if you
- have are using the emailsuffix Param, this may just be the user's
- login name. Note that users can now change their login names
- themselves (to any valid email address.)
+ have are using the emailsuffix
parameter, this may
+ just be the user's login name. Note that users can now change their
+ login names themselves (to any valid email address).
@@ -434,6 +460,15 @@
+
+
+ Bugmail Disabled:
+ Mark this checkbox to disable bugmail and whinemail completely
+ for this account. This checkbox replaces the data/nomail file
+ which existed in older versions of Bugzilla.
+
+
+
Disable Text:
@@ -449,8 +484,8 @@
mail from Bugzilla; furthermore, they will not be able
to log in themselves to change their own preferences and
stop it. If you want an account (disabled or active) to
- stop receiving mail, add the account name (one account
- per line) to the file data/nomail.
+ stop receiving mail, simply check the
+ Bugmail Disabled
checkbox above.
@@ -548,7 +583,21 @@
-
+
+
+
+ If the allowuserdeletion
parameter is turned on, see
+ , then you can also delete user accounts.
+ Note that this is most of the time not the best thing to do. If only
+ a warning in a yellow box is displayed, then the deletion is safe.
+ If a warning is also displayed in a red box, then you should NOT try
+ to delete the user account, else you will get referential integrity
+ problems in your database, which can lead to unexpected behavior,
+ such as bugs not appearing in bug lists anymore, or data displaying
+ incorrectly. You have been warned!
+
+
+
Impersonating Users
--
cgit v1.2.3-24-g4f1b