From 051be1c7bf8eb3b5a2f25bdee273d2fe61e5fff1 Mon Sep 17 00:00:00 2001
From: "bugreport%peshkin.net" <>
Date: Fri, 4 Apr 2008 11:47:24 +0000
Subject: Bug 203869: Update documentation to better describe group controls
r=gerv, a=justdave
---
docs/en/xml/administration.xml | 1220 +++++++++++-----------------------------
1 file changed, 314 insertions(+), 906 deletions(-)
(limited to 'docs')
diff --git a/docs/en/xml/administration.xml b/docs/en/xml/administration.xml
index 8eb7769a4..24aa18954 100644
--- a/docs/en/xml/administration.xml
+++ b/docs/en/xml/administration.xml
@@ -71,7 +71,7 @@
standard type, and Bugzilla does not yet take advantage of features
such as transactions which would justify this speed decrease. The
Bugzilla team are, however, happy to hear about any experiences with
- row level locking and Bugzilla
+ row level locking and Bugzilla.
The shadowdb
parameter was designed to get around this limitation. While only a
@@ -82,7 +82,7 @@
high-traffic Bugzilla databases.
- As a guide, mozilla.org began needing
+ As a guide, on reasonably old hardware, mozilla.org began needing
shadowdb
when they reached around 40,000 Bugzilla users with several hundred
Bugzilla bug changes and comments per day.
@@ -321,7 +321,7 @@
they attempt to perform these actions, and should explain
why the account was disabled.
- Don't disable the administrator account!
+ Don't disable all the administrator accounts!
@@ -418,178 +418,167 @@
-
- Product, Component, Milestone, and Version Administration
+
+ Products
-
- Products
+
+
+ Products
-
-
- Products
+ are the broadest category in Bugzilla, and tend to represent real-world
+ shipping products. E.g. if your company makes computer games,
+ you should have one product per game, perhaps a "Common" product for
+ units of technology used in multiple games, and maybe a few special
+ products (Website, Administration...)
- are the broadest category in Bugzilla, and tend to represent real-world
- shipping products. E.g. if your company makes computer games,
- you should have one product per game, perhaps a "Common" product for
- units of technology used in multiple games, and maybe a few special
- products (Website, Administration...)
+ Many of Bugzilla's settings are configurable on a per-product
+ basis. The number of "votes" available to users is set per-product,
+ as is the number of votes
+ required to move a bug automatically from the UNCONFIRMED status to the
+ NEW status.
- Many of Bugzilla's settings are configurable on a per-product
- basis. The number of "votes" available to users is set per-product,
- as is the number of votes
- required to move a bug automatically from the UNCONFIRMED status to the
- NEW status.
+ To create a new product:
- To create a new product:
+
+
+ Select "products" from the footer
-
-
- Select "products" from the footer
+
-
+
+ Select the "Add" link in the bottom right
+
-
- Select the "Add" link in the bottom right
-
+
+ Enter the name of the product and a description. The
+ Description field may contain HTML.
+
+
-
- Enter the name of the product and a description. The
- Description field may contain HTML.
-
-
+ Don't worry about the "Closed for bug entry", "Maximum Votes
+ per person", "Maximum votes a person can put on a single bug",
+ "Number of votes a bug in this Product needs to automatically get out
+ of the UNCOMFIRMED state", and "Version" options yet. We'll cover
+ those in a few moments.
+
+
- Don't worry about the "Closed for bug entry", "Maximum Votes
- per person", "Maximum votes a person can put on a single bug",
- "Number of votes a bug in this Product needs to automatically get out
- of the UNCOMFIRMED state", and "Version" options yet. We'll cover
- those in a few moments.
-
-
+
+ Components
-
- Components
+ Components are subsections of a Product. E.g. the computer game
+ you are designing may have a "UI"
+ component, an "API" component, a "Sound System" component, and a
+ "Plugins" component, each overseen by a different programmer. It
+ often makes sense to divide Components in Bugzilla according to the
+ natural divisions of responsibility within your Product or
+ company.
- Components are subsections of a Product. E.g. the computer game
- you are designing may have a "UI"
- component, an "API" component, a "Sound System" component, and a
- "Plugins" component, each overseen by a different programmer. It
- often makes sense to divide Components in Bugzilla according to the
- natural divisions of responsibility within your Product or
- company.
-
-
- Each component has a owner and (if you turned it on in the parameters),
- a QA Contact. The owner should be the primary person who fixes bugs in
- that component. The QA Contact should be the person who will ensure
- these bugs are completely fixed. The Owner, QA Contact, and Reporter
- will get email when new bugs are created in this Component and when
- these bugs change. Default Owner and Default QA Contact fields only
- dictate the
- default assignments;
- these can be changed on bug submission, or at any later point in
- a bug's life.
-
- To create a new Component:
-
-
-
- Select the "Edit components" link from the "Edit product"
- page
-
+
+ Each component has a owner and (if you turned it on in the parameters),
+ a QA Contact. The owner should be the primary person who fixes bugs in
+ that component. The QA Contact should be the person who will ensure
+ these bugs are completely fixed. The Owner, QA Contact, and Reporter
+ will get email when new bugs are created in this Component and when
+ these bugs change. Default Owner and Default QA Contact fields only
+ dictate the
+ default assignments;
+ these can be changed on bug submission, or at any later point in
+ a bug's life.
+
+ To create a new Component:
-
- Select the "Add" link in the bottom right.
-
+
+
+ Select the "Edit components" link from the "Edit product"
+ page
+
-
- Fill out the "Component" field, a short "Description",
- the "Initial Owner" and "Initial QA Contact" (if enabled.)
- The Component and Description fields may contain HTML;
- the "Initial Owner" field must be a login name
- already existing in the database.
-
-
-
-
+
+ Select the "Add" link in the bottom right.
+
-
- Versions
+
+ Fill out the "Component" field, a short "Description",
+ the "Initial Owner" and "Initial QA Contact" (if enabled.)
+ The Component and Description fields may contain HTML;
+ the "Initial Owner" field must be a login name
+ already existing in the database.
+
+
+
+
- Versions are the revisions of the product, such as "Flinders
- 3.1", "Flinders 95", and "Flinders 2000". Version is not a multi-select
- field; the usual practice is to select the most recent version with
- the bug.
-
+
+ Versions
- To create and edit Versions:
+ Versions are the revisions of the product, such as "Flinders
+ 3.1", "Flinders 95", and "Flinders 2000". Version is not a multi-select
+ field; the usual practice is to select the earliest version known to have
+ the bug.
+
-
-
- From the "Edit product" screen, select "Edit Versions"
-
+ To create and edit Versions:
-
- You will notice that the product already has the default
- version "undefined". Click the "Add" link in the bottom right.
-
+
+
+ From the "Edit product" screen, select "Edit Versions"
+
-
- Enter the name of the Version. This field takes text only.
- Then click the "Add" button.
-
+
+ You will notice that the product already has the default
+ version "undefined". Click the "Add" link in the bottom right.
+
-
-
+
+ Enter the name of the Version. This field takes text only.
+ Then click the "Add" button.
+
-
- Milestones
+
+
- Milestones are "targets" that you plan to get a bug fixed by. For
- example, you have a bug that you plan to fix for your 3.0 release, it
- would be assigned the milestone of 3.0.
+
+ Milestones
-
- Milestone options will only appear for a Product if you turned
- on the "usetargetmilestone" Param in the "Edit Parameters" screen.
-
-
+ Milestones are "targets" that you plan to get a bug fixed by. For
+ example, you have a bug that you plan to fix for your 3.0 release, it
+ would be assigned the milestone of 3.0.
- To create new Milestones, set Default Milestones, and set
- Milestone URL:
+
+ Milestone options will only appear for a Product if you turned
+ on the "usetargetmilestone" Param in the "Edit Parameters" screen.
+
+
-
-
- Select "Edit milestones" from the "Edit product" page.
-
+ To create new Milestones, set Default Milestones, and set
+ Milestone URL:
-
- Select "Add" in the bottom right corner.
- text
-
+
+
+ Select "Edit milestones" from the "Edit product" page.
+
-
- Enter the name of the Milestone in the "Milestone" field. You
- can optionally set the "sortkey", which is a positive or negative
- number (-255 to 255) that defines where in the list this particular
- milestone appears. This is because milestones often do not
- occur in alphanumeric order For example, "Future" might be
- after "Release 1.2". Select "Add".
-
+
+ Select "Add" in the bottom right corner.
+ text
+
-
- From the Edit product screen, you can enter the URL of a
- page which gives information about your milestones and what
- they mean.
+
+ Enter the name of the Milestone in the "Milestone" field. You
+ can optionally set the "sortkey", which is a positive or negative
+ number (-255 to 255) that defines where in the list this particular
+ milestone appears. This is because milestones often do not
+ occur in alphanumeric order For example, "Future" might be
+ after "Release 1.2". Select "Add".
+
-
- If you want your milestone document to be restricted so
- that it can only be viewed by people in a particular Bugzilla
- group, the best way is to attach the document to a bug in that
- group, and make the URL the URL of that attachment.
-
-
-
-
+
+ From the Edit product screen, you can enter the URL of a
+ page which gives information about your milestones and what
+ they mean.
+
+
@@ -651,92 +640,9 @@
If the makeproductgroups param is on, a new group will be automatically
- created for every new product.
+ created for every new product. It is primarily available for backward
+ compatibility with older sites.
-
-
- On the product edit page, there is a page to edit the
- Group Controls
- for a product and determine which groups are applicable, default,
- and mandatory for each product as well as controlling entry
- for each product and being able to set bugs in a product to be
- totally read-only unless some group restrictions are met.
-
-
-
- For each group, it is possible to specify if membership in that
- group is...
-
-
-
-
- required for bug entry,
-
-
-
-
- Not applicable to this product(NA),
- a possible restriction for a member of the
- group to place on a bug in this product(Shown),
- a default restriction for a member of the
- group to place on a bug in this product(Default),
- or a mandatory restriction to be placed on bugs
- in this product(Mandatory).
-
-
-
-
- Not applicable by non-members to this product(NA),
- a possible restriction for a non-member of the
- group to place on a bug in this product(Shown),
- a default restriction for a non-member of the
- group to place on a bug in this product(Default),
- or a mandatory restriction to be placed on bugs
- in this product when entered by a non-member(Mandatory).
-
-
-
-
- required in order to make any change
- to bugs in this product including comments.
-
-
-
-
- To create Groups:
-
-
-
- Select the groups
- link in the footer.
-
-
-
- Take a moment to understand the instructions on the Edit
- Groups screen, then select the Add Group link.
-
-
-
- Fill out the Group, Description,
- and User RegExp fields.
- User RegExp allows you to automatically
- place all users who fulfill the Regular Expression into the new group.
- When you have finished, click Add.
-
- The User Regexp is a perl regexp and, if not anchored, will match
- any part of an address. So, if you do not want to grant access
- into 'mycompany.com' to 'badperson@mycompany.com.hacker.net', use
- '@mycompany\.com$' as the regexp.
-
-
-
- After you add your new group, edit the new group. On the
- edit page, you can specify other groups that should be included
- in this group and which groups should be permitted to add and delete
- users from this group.
-
-
-
Note that group permissions are such that you need to be a member
of all the groups a bug is in, for whatever
@@ -747,707 +653,213 @@
in order to make any change to bugs in that
product.
-
-
-
-
- Bugzilla Security
-
-
- Poorly-configured MySQL and Bugzilla installations have
- given attackers full access to systems in the past. Please take these
- guidelines seriously, even for Bugzilla machines hidden away behind
- your firewall. 80% of all computer trespassers are insiders, not
- anonymous crackers.
-
-
-
- These instructions must, of necessity, be somewhat vague since
- Bugzilla runs on so many different platforms. If you have refinements
- of these directions, please submit a bug to &bzg-bugs;.
-
-
-
-
- This is not meant to be a comprehensive list of every possible
- security issue regarding the tools mentioned in this section. There is
- no subsitute for reading the information written by the authors of any
- software running on your system.
-
-
-
-
- TCP/IP Ports
-
-
- TCP/IP defines 65,000 some ports for trafic. Of those, Bugzilla
- only needs 1... 2 if you need to use features that require e-mail such
- as bug moving or the e-mail interface from contrib. You should audit
- your server and make sure that you aren't listening on any ports you
- don't need to be. You may also wish to use some kind of firewall
- software to be sure that trafic can only be recieved on ports you
- specify.
-
-
-
-
- MySQL
-
- MySQL ships by default with many settings that should be changed.
- By defaults it allows anybody to connect from localhost without a
- password and have full administrative capabilities. It also defaults to
- not have a root password (this is not the same as
- the system root). Also, many installations default to running
- mysqld as the system root.
-
-
+
+ Creating Groups
+ To create Groups:
+
- Consult the documentation that came with your system for
- information on making mysqld run as an
- unprivleged user.
-
-
-
-
- You should also be sure to disable the anonymous user account
- and set a password for the root user. This is accomplished using the
- following commands:
-
-
-bash$ mysql mysql
-mysql> DELETE FROM user WHERE user = '';
-mysql> UPDATE user SET password = password('new_password') WHERE user = 'root';
-mysql> FLUSH PRIVILEGES;
-
- From this point forward you will need to use
- mysql -u root -p and enter
- new_password when prompted when using the
- mysql client.
-
+ Select the groups
+ link in the footer.
-
+
- If you run MySQL on the same machine as your httpd server, you
- should consider disabling networking from within MySQL by adding
- the following to your /etc/my.conf:
-
-
-[myslqd]
-# Prevent network access to MySQL.
-skip-networking
-
+ Take a moment to understand the instructions on the Edit
+ Groups screen, then select the Add Group link.
-
+
- You may also consider running MySQL, or even all of Bugzilla
- in a chroot jail; however, instructions for doing that are beyond
- the scope of this document.
-
+ Fill out the Group, Description,
+ and User RegExp fields.
+ User RegExp allows you to automatically
+ place all users who fulfill the Regular Expression into the new group.
+ When you have finished, click Add.
+ Users whose email addresses match the regular expression
+ will automatically be members of the group as long as their
+ email addresses continue to match the regular expression.
+
+ This is a change from 2.16 where the regular expression
+ resulted in a user acquiring permanent membership in a group.
+ To remove a user from a group the user was in due to a regular
+ expression in version 2.16 or earlier, the user must be explicitly
+ removed from the group.
+
+
+ If specifying a domain in the regexp, make sure you end
+ the regexp with a $. Otherwise, when granting access to
+ "@mycompany\.com", you will allow access to
+ 'badperson@mycompany.com.cracker.net'. You need to use
+ '@mycompany\.com$' as the regexp.
+
-
-
-
-
-
-
- Daemon Accounts
-
- Many daemons, such as Apache's httpd and MySQL's mysqld default to
- running as either root or nobody. Running
- as root introduces obvious security problems, but the
- problems introduced by running everything as nobody may
- not be so obvious. Basically, if you're running every daemon as
- nobody and one of them gets comprimised, they all get
- comprimised. For this reason it is recommended that you create a user
- account for each daemon.
-
-
-
- You will need to set the webservergroup to
- the group you created for your webserver to run as in
- localconfig. This will allow
- ./checksetup.pl to better adjust the file
- permissions on your Bugzilla install so as to not require making
- anything world-writable.
-
-
-
-
-
-
- Web Server Access Controls
-
- There are many files that are placed in the Bugzilla directory
- area that should not be accessable from the web. Because of the way
- Bugzilla is currently layed out, the list of what should and should
- not be accessible is rather complicated. A new installation method
- is currently in the works which should solve this by allowing files
- that shouldn't be accessible from the web to be placed in directory
- outside the webroot. See
-
- bug 44659 for more information.
-
-
-
- In the main Bugzilla directory, you should:
-
-
- Block:
-
- *.pl
- *localconfig*
- runtests.sh
-
-
-
-
- But allow:
-
- localconfig.js
- localconfig.rdf
-
-
-
-
+ If you plan to use this group to directly control
+ access to bugs, check the "use for bugs" box. Groups
+ not used for bugs are still useful because other groups
+ can include the group as a whole.
-
- In data:
-
-
- Block everything
-
-
- But allow:
-
- duplicates.rdf
-
-
-
-
+ After you add your new group, edit the new group. On the
+ edit page, you can specify other groups that should be included
+ in this group and which groups should be permitted to add and delete
+ users from this group.
-
+
+
+
+
+ Assigning Users to Groups
+ Users can become a member of a group in several ways.
+
- In data/webdot:
-
-
- If you use a remote webdot server:
-
-
- Block everything
-
-
- But allow
-
- *.dot
-
- only for the remote webdot server
-
-
-
-
- Otherwise, if you use a local GraphViz:
-
-
- Block everything
-
-
- But allow:
-
- *.png
- *.gif
- *.jpg
- *.map
-
-
-
-
-
-
- And if you don't use any dot:
-
-
- Block everything
-
-
-
-
+ The user can be explicitly placed in the group by editing
+ the user's own profile
-
- In Bugzilla:
-
-
- Block everything
-
-
+ The group can include another group of which the user is
+ a member.
-
- In template:
-
-
- Block everything
-
-
+ The user's email address can match a regular expression
+ that the group specifies to automatically grant membership to
+ the group.
-
-
-
- Bugzilla ships with the ability to generate
- .htaccess files instructing
- Apache which files
- should and should not be accessible. For more information, see
- .
-
-
-
- You should test to make sure that the files mentioned above are
- not accessible from the Internet, especially your
- localconfig file which contains your database
- password. To test, simply point your web browser at the file; for
- example, to test mozilla.org's installation, we'd try to access
- . You should
- get a 403Forbidden
- error.
-
-
-
- Not following the instructions in this section, including
- testing, may result in sensitive information being globally
- accessible.
-
-
-
-
- You should check to see if instructions
- have been included for your web server. You should also compare those
- instructions with this list to make sure everything is properly
- accounted for.
-
-
-
-
-
-
-
-
- Template Customization
-
-
- One of the large changes for 2.16 was the templatization of the
- entire user-facing UI, using the
- Template Toolkit.
- Administrators can now configure the look and feel of Bugzilla without
- having to edit Perl files or face the nightmare of massive merge
- conflicts when they upgrade to a newer version in the future.
-
-
-
- Templatization also makes localized versions of Bugzilla possible,
- for the first time. As of version 2.18, it's possible to have Bugzilla's language determined by
- the user's browser. More information is available in
- .
-
-
-
- What to Edit
-
- There are two different ways of editing of Bugzilla's templates,
- and which you use depends mainly on how you upgrade Bugzilla. The
- template directory structure is that there's a top level directory,
- template, which contains a directory for
- each installed localization. The default English templates are
- therefore in en. Underneath that, there
- is the default directory and optionally the
- custom directory. The default
- directory contains all the templates shipped with Bugzilla, whereas
- the custom directory does not exist at first and
- must be created if you want to use it.
-
-
-
- The first method of making customizations is to directly edit the
- templates in template/en/default. This is
- probably the best method for small changes if you are going to use
- the CVS method of upgrading, because if you then execute a
- cvs update, any template fixes will get
- automagically merged into your modified versions.
-
-
-
- If you use this method, your installation will break if CVS conflicts
- occur.
-
-
-
- The other method is to copy the templates into a mirrored directory
- structure under template/en/custom. The templates
- in this directory automatically override those in default.
- This is the technique you
- need to use if you use the overwriting method of upgrade, because
- otherwise your changes will be lost. This method is also better if
- you are using the CVS method of upgrading and are going to make major
- changes, because it is guaranteed that the contents of this directory
- will not be touched during an upgrade, and you can then decide whether
- to continue using your own templates, or make the effort to merge your
- changes into the new versions by hand.
-
-
-
- If you use this method, your installation may break if incompatible
- changes are made to the template interface. If such changes are made
- they will be documented in the release notes, provided you are using a
- stable release of Bugzilla. If you use using unstable code, you will
- need to deal with this one yourself, although if possible the changes
- will be mentioned before they occur in the deprecations section of the
- previous stable release's release notes.
-
-
-
-
- Don't directly edit the compiled templates in
- data/template/* - your
- changes will be lost when Template Toolkit recompiles them.
-
-
-
-
- It is recommended that you run ./checksetup.pl
- after any template edits, especially if you've created a new file in
- the custom directory.
-
-
-
-
-
- How To Edit Templates
-
-
- The syntax of the Template Toolkit language is beyond the scope of
- this guide. It's reasonably easy to pick up by looking at the current
- templates; or, you can read the manual, available on the
- Template Toolkit home
- page. However, you should particularly remember (for security
- reasons) to always HTML filter things which come from the database or
- user input, to prevent cross-site scripting attacks.
-
-
-
- However, one thing you should take particular care about is the need
- to properly HTML filter data that has been passed into the template.
- This means that if the data can possibly contain special HTML characters
- such as <, and the data was not intended to be HTML, they need to be
- converted to entity form, ie <. You use the 'html' filter in the
- Template Toolkit to do this. If you fail to do this, you may open up
- your installation to cross-site scripting attacks.
-
-
-
- Also note that Bugzilla adds a few filters of its own, that are not
- in standard Template Toolkit. In particular, the 'url_quote' filter
- can convert characters that are illegal or have special meaning in URLs,
- such as &, to the encoded form, ie %26. This actually encodes most
- characters (but not the common ones such as letters and numbers and so
- on), including the HTML-special characters, so there's never a need to
- HTML filter afterwards.
-
-
-
- Editing templates is a good way of doing a "poor man's custom fields".
- For example, if you don't use the Status Whiteboard, but want to have
- a free-form text entry box for "Build Identifier", then you can just
- edit the templates to change the field labels. It's still be called
- status_whiteboard internally, but your users don't need to know that.
-
-
-
-
- If you are making template changes that you intend on submitting back
- for inclusion in standard Bugzilla, you should read the relevant
- sections of the
- Developers'
- Guide.
-
-
+
-
- Template Formats
-
-
- Some CGIs have the ability to use more than one template. For
- example, buglist.cgi can output bug lists as RDF or two
- different forms of HTML (complex and simple). (Try this out
- by appending &format=simple to a buglist.cgi
- URL on your Bugzilla installation.) This
- mechanism, called template 'formats', is extensible.
-
-
-
- To see if a CGI supports multiple output formats, grep the
- CGI for "ValidateOutputFormat". If it's not present, adding
- multiple format support isn't too hard - see how it's done in
- other CGIs.
-
-
-
- To make a new format template for a CGI which supports this,
- open a current template for
- that CGI and take note of the INTERFACE comment (if present.) This
- comment defines what variables are passed into this template. If
- there isn't one, I'm afraid you'll have to read the template and
- the code to find out what information you get.
-
-
+ Assigning Group Controls to Products
- Write your template in whatever markup or text style is appropriate.
+ On the product edit page, there is a page to edit the
+ Group Controls
+ for a product. This allows you to
+ configure how a group relates to the product.
+ Groups may be applicable, default,
+ and mandatory as well as used to control entry
+ or used to make bugs in the product
+ totally read-only unless the group restrictions are met.
- You now need to decide what content type you want your template
- served as. Open up the localconfig file and find the
- $contenttypes
- variable. If your content type is not there, add it. Remember
- the three- or four-letter tag assigned to you content type.
- This tag will be part of the template filename.
+ For each group, it is possible to specify if membership in that
+ group is...
+
+
+
+ required for bug entry,
+
+
+
+
+ Not applicable to this product(NA),
+ a possible restriction for a member of the
+ group to place on a bug in this product(Shown),
+ a default restriction for a member of the
+ group to place on a bug in this product(Default),
+ or a mandatory restriction to be placed on bugs
+ in this product(Mandatory).
+
+
+
+
+ Not applicable by non-members to this product(NA),
+ a possible restriction for a non-member of the
+ group to place on a bug in this product(Shown),
+ a default restriction for a non-member of the
+ group to place on a bug in this product(Default),
+ or a mandatory restriction to be placed on bugs
+ in this product when entered by a non-member(Mandatory).
+
+
+
+
+ required in order to make any change
+ to bugs in this product including comments.
+
+
+
+ These controls are often described in this order, so a
+ product that requires a user to be a member of group "foo"
+ to enter a bug and then requires that the bug stay resticted
+ to group "foo" at all times and that only members of group "foo"
+ can edit the bug even if they otherwise could see the bug would
+ have its controls summarized by...
+
+foo: ENTRY, MANDATORY/MANDATORY, CANEDIT
+
-
- Save the template as <stubname>-<formatname>.<contenttypetag>.tmpl.
- Try out the template by calling the CGI as
- <cginame>.cgi?format=<formatname> .
-
-
-
- Particular Templates
-
-
- There are a few templates you may be particularly interested in
- customizing for your installation.
-
-
-
- index.html.tmpl:
- This is the Bugzilla front page.
-
-
-
- global/header.html.tmpl:
- This defines the header that goes on all Bugzilla pages.
- The header includes the banner, which is what appears to users
- and is probably what you want to edit instead. However the
- header also includes the HTML HEAD section, so you could for
- example add a stylesheet or META tag by editing the header.
-
-
-
- global/banner.html.tmpl:
- This contains the "banner", the part of the header that appears
- at the top of all Bugzilla pages. The default banner is reasonably
- barren, so you'll probably want to customize this to give your
- installation a distinctive look and feel. It is recommended you
- preserve the Bugzilla version number in some form so the version
- you are running can be determined, and users know what docs to read.
-
-
-
- global/footer.html.tmpl:
- This defines the footer that goes on all Bugzilla pages. Editing
- this is another way to quickly get a distinctive look and feel for
- your Bugzilla installation.
-
-
-
- bug/create/user-message.html.tmpl:
- This is a message that appears near the top of the bug reporting page.
- By modifying this, you can tell your users how they should report
- bugs.
-
-
-
- bug/process/midair.html.tmpl:
- This is the page used if two people submit simultaneous changes to the
- same bug. The second person to submit their changes will get this page
- to tell them what the first person did, and ask if they wish to
- overwrite those changes or go back and revisit the bug. The default
- title and header on this page read "Mid-air collision detected!" If
- you work in the aviation industry, or other environment where this
- might be found offensive (yes, we have true stories of this happening)
- you'll want to change this to something more appropriate for your
- environment.
-
-
-
- bug/create/create.html.tmpl and
- bug/create/comment.txt.tmpl:
- You may wish to get bug submitters to give certain bits of structured
- information, each in a separate input widget, for which there is not a
- field in the database. The bug entry system has been designed in an
- extensible fashion to enable you to define arbitrary fields and widgets,
- and have their values appear formatted in the initial
- Description, rather than in database fields. An example of this
- is the mozilla.org
- guided
- bug submission form.
-
-
-
- To make this work, create a custom template for
- enter_bug.cgi (the default template, on which you
- could base it, is create.html.tmpl),
- and either call it create.html.tmpl or use a format and
- call it create-<formatname>.html.tmpl.
- Put it in the custom/bug/create
- directory. In it, add widgets for each piece of information you'd like
- collected - such as a build number, or set of steps to reproduce.
-
-
-
- Then, create a template like
- custom/bug/create/comment.txt.tmpl, also named
- after your format if you are using one, which
- references the form fields you have created. When a bug report is
- submitted, the initial comment attached to the bug report will be
- formatted according to the layout of this template.
-
-
-
- For example, if your enter_bug template had a field
- <input type="text" name="buildid" size="30">
- and then your comment.txt.tmpl had
- BuildID: [% form.buildid %]
- then
- BuildID: 20020303
- would appear in the initial checkin comment.
-
-
-
-
-
- Configuring Bugzilla to Detect the User's Language
-
- Begining in version 2.18, it's now possible to have the users web browser tell Bugzilla
- which language templates to use for each visitor (using the HTTP_ACCEPT
- header). For this to work, Bugzilla needs to have the correct language
- templates installed for the version of Bugzilla you are using. Many
- language templates can be obtained from . Instructions
- for submitting new languages are also available from that location.
-
-
- After untarring the localizations (or creating your own) in the
- [Bugzilla_Root]/template directory,
- you must update the parameter to contain any
- localizations you'd like to permit. You may also wish to set the
- parameter to something other than
- en if you don't want Engish to be the default language.
-
+ Common Applications of Group Controls
+
+ General User Access With Security Group
+ To permit any user to file bugs in each product (A, B, C...)
+ and to permit any user to submit those bugs into a security
+ group....
+
+Product A...
+security: SHOWN/SHOWN
+Product B...
+security: SHOWN/SHOWN
+Product C...
+security: SHOWN/SHOWN
+
+
+
+ General User Access With A Security Product
+ To permit any user to file bugs in a Security product
+ while keeping those bugs from becoming visible to anyone
+ outside the securityworkers group unless a member of the
+ securityworkers group removes that restriction....
+
+Product Security...
+securityworkers: DEFAULT/MANDATORY
+
+
+
+ Product Isolation With Common Group
+ To permit users of product A to access the bugs for
+ product A, users of product B to access product B, and support
+ staff to access both, 3 groups are needed
+
+
+ Support: Contains members of the support staff.
+
+
+ AccessA: Contains users of product A and the Support group.
+
+
+ AccessB: Contains users of product B and the Support group.
+
+
+ Once these 3 groups are defined, the products group controls
+ can be set to..
+
+Product A...
+AccessA: ENTRY, MANDATORY/MANDATORY
+Product B...
+AccessB: ENTRY, MANDATORY/MANDATORY
+
+ Optionally, the support group could be permitted to make
+ bugs inaccessible to the users and could be permitted to publish
+ bugs relevant to all users in a common product that is read-only
+ to anyone outside the support group. That configuration could
+ be...
+
+Product A...
+AccessA: ENTRY, MANDATORY/MANDATORY
+Support: SHOWN/NA
+Product B...
+AccessB: ENTRY, MANDATORY/MANDATORY
+Support: SHOWN/NA
+Product Common...
+Support: ENTRY, DEFAULT/MANDATORY, CANEDIT
+
+
-
-
- Change Permission Customization
-
-
-
- This feature should be considered experimental; the Bugzilla code you
- will be changing is not stable, and could change or move between
- versions. Be aware that if you make modifications to it, you may have
- to re-make them or port them if Bugzilla changes internally between
- versions.
-
-
-
-
- Companies often have rules about which employees, or classes of employees,
- are allowed to change certain things in the bug system. For example,
- only the bug's designated QA Contact may be allowed to VERIFY the bug.
- Bugzilla has been
- designed to make it easy for you to write your own custom rules to define
- who is allowed to make what sorts of value transition.
-
-
-
- For maximum flexibility, customizing this means editing Bugzilla's Perl
- code. This gives the administrator complete control over exactly who is
- allowed to do what. The relevant function is called
- CheckCanChangeField(),
- and is found in process_bug.cgi in your
- Bugzilla directory. If you open that file and grep for
- "sub CheckCanChangeField", you'll find it.
-
-
-
- This function has been carefully commented to allow you to see exactly
- how it works, and give you an idea of how to make changes to it. Certain
- marked sections should not be changed - these are the "plumbing" which
- makes the rest of the function work. In between those sections, you'll
- find snippets of code like:
- # Allow the owner to change anything.
- if ($ownerid eq $whoid) {
- return 1;
- }
- It's fairly obvious what this piece of code does.
-
-
-
- So, how does one go about changing this function? Well, simple changes
- can be made just be removing pieces - for example, if you wanted to
- prevent any user adding a comment to a bug, just remove the lines marked
- "Allow anyone to change comments." And if you want the reporter to have
- no special rights on bugs they have filed, just remove the entire section
- which refers to him.
-
-
-
- More complex customizations are not much harder. Basically, you add
- a check in the right place in the function, i.e. after all the variables
- you are using have been set up. So, don't look at $ownerid before
- $ownerid has been obtained from the database. You can either add a
- positive check, which returns 1 (allow) if certain conditions are true,
- or a negative check, which returns 0 (deny.) E.g.:
- if ($field eq "qacontact") {
- if (Bugzilla->user->groups("quality_assurance")) {
- return 1;
- }
- else {
- return 0;
- }
- }
- This says that only users in the group "quality_assurance" can change
- the QA Contact field of a bug. Getting more weird:
- if (($field eq "priority") &&
- (Bugzilla->user->email =~ /.*\@example\.com$/))
- {
- if ($oldvalue eq "P1") {
- return 1;
- }
- else {
- return 0;
- }
- }
- This says that if the user is trying to change the priority field,
- and their email address is @example.com, they can only do so if the
- old value of the field was "P1". Not very useful, but illustrative.
-
-
-
- For a list of possible field names, look in
- data/versioncache for the list called
- @::log_columns. If you need help writing custom
- rules for your organization, ask in the newsgroup.
-
-
-
Upgrading to New Releases
@@ -1619,8 +1031,8 @@ bash$ ./checksetup.pl
revisions to go from the most recent revision to the new one. You could
also read the release notes and grab the patches attached to the
mentioned bug, but it is safer to use the released patch file as
- sometimes patches get changed before they get checked in (for minor
- spelling fixes and the like). It is also theorectically possible to
+ sometimes patches get changed before they get checked in.
+ It is also theoretically possible to
scour the fixed bug list and pick and choose which patches to apply
from a point release, but this is not recommended either as what you'll
end up with is a hodge podge Bugzilla that isn't really any version.
@@ -1650,10 +1062,6 @@ patching file globals.pl
-
-
- &integration;
-