Or, I just got this cool thing installed. Now what the heck do I
- do with it?
-
So you followed "Bugzilla Installation" to the
- letter, and logged into Bugzilla for the very first time with your
- super-duper god account. You sit, contentedly staring at the
- Bugzilla Query Screen, the worst of the whole mad business of
- installing this terrific program behind you. It seems, though, you
- have nothing yet to query! Your first act of business should be to
- setup the operating parameters for Bugzilla so you can get busy
- getting data into your bug tracker.
-
The people listed below have made enormous contributions to the
- creation of this Guide, through their dedicated hacking efforts,
+ creation of this Guide, through their writing, dedicated hacking efforts,
numerous e-mail and IRC support sessions, and overall excellent
contribution to the Bugzilla community:
Matthew P. Barnson
- for pulling together the Bugzilla Guide and shepherding it to 2.14.
+ for the Herculaean task of pulling together the Bugzilla Guide and
+ shepherding it to 2.14.
Tara
- Hernandez for keeping Bugzilla development going
- strong after Terry left Mozilla.org
+>Tara Hernandez
+ for keeping Bugzilla development going
+ strong after Terry left mozilla.org
Dave Lawrence for
- providing insight into the key differences between Red Hat's
+>
+ for providing insight into the key differences between Red Hat's
customized Bugzilla, and being largely responsible for the "Red
Hat Bugzilla" appendix
Zach Liption, Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen,
- Ron Teitelbaum, Jacob Steenhagen, Joe Robins.
+ Ron Teitelbaum, Jacob Steenhagen, Joe Robins, Gervase Markham.
CVS integration is best accomplished, at this point, using
- the Bugzilla Email Gateway. There have been some files
- submitted to allow greater CVS integration, but we need to make
- certain that Bugzilla is not tied into one particular software
- management package.
CVS integration is best accomplished, at this point, using the
+ Bugzilla Email Gateway. There have been some files submitted to allow
+ greater CVS integration, but we need to make certain that Bugzilla is not
+ tied into one particular software management package.
Follow the instructions in the FAQ for enabling Bugzilla e-mail
- integration. Ensure that your check-in script sends an email to
- your Bugzilla e-mail gateway with the subject of Follow the instructions in the FAQ for enabling Bugzilla e-mail
+ integration. Ensure that your check-in script sends an email to your
+ Bugzilla e-mail gateway with the subject of
+ "[Bug
- XXXX]", and you can have CVS check-in comments append
- to your Bugzilla bug. If you have your check-in script include
- an @resolution field, you can even change the Bugzilla bug
- state.
-
"[Bug XXXX]"
+
+ , and you can have CVS check-in comments append to your Bugzilla bug. If
+ you have your check-in script include an @resolution field, you can even
+ change the Bugzilla bug state.
This document really needs to be updated with more fleshed out information about primary keys, interrelationships, and maybe some nifty tables to document dependencies. Any takers?
-
This document really needs to be updated with more fleshed out
+ information about primary keys, interrelationships, and maybe some nifty
+ tables to document dependencies. Any takers?
If you were like me, at this point you're totally clueless
- about the internals of MySQL, and if it weren't for this
- executive order from the Vice President you couldn't care less
- about the difference between a If you were like me, at this point you're totally clueless about
+ the internals of MySQL, and if it weren't for this executive order from
+ the Vice President you couldn't care less about the difference between
+ a
+ "bigint" and a
-
+
+ and a
+ "tinyint" entry in MySQL. I recommend you refer
- to the MySQL documentation, available at
+
+ entry in MySQL. I recommend you refer to the MySQL documentation,
+ available at
+ MySQL.com. Below are the basics you need to know about the Bugzilla database. Check the chart above for more details.
-
+
+ . Below are the basics you need to know about the Bugzilla database.
+ Check the chart above for more details.
To connect to your database:
-
To connect to your database:
bash#
+
+ mysql
+
+ -u root
-
If this works without asking you for a password,
- If this works without asking you for a password,
+ shame on you! You should have
- locked your security down like the installation
- instructions told you to. You can find details on
- locking down your database in the Bugzilla FAQ in this
- directory (under "Security"), or more robust security
- generalities in the MySQL searchable documentation at
- http://www.mysql.com/php/manual.php3?section=Privilege_system .
-
+
+ ! You should have locked your security down like the installation
+ instructions told you to. You can find details on locking down
+ your database in the Bugzilla FAQ in this directory (under
+ "Security"), or more robust security generalities in the MySQL
+ searchable documentation at
+ http://www.mysql.com/php/manual.php3?section=Privilege_system
+ .
You should now be at a prompt that looks like
- this:
You should now be at a prompt that looks like this:
mysql>
+
At the prompt, if At the prompt, if
+ "bugs" is the name
- you chose in the
+
+ is the name you chose in the
+ localconfig file
- for your Bugzilla database, type:
+
+ file for your Bugzilla database, type:
mysql
+
+ use bugs;
+
Don't forget the Don't forget the
+ ";" at the end of
- each line, or you'll be kicking yourself later.
+
+ at the end of each line, or you'll be kicking yourself
+ later.
Imagine your MySQL database as a series of
- spreadsheets, and you won't be too far off. If you use this
- command:
Imagine your MySQL database as a series of spreadsheets, and
+ you won't be too far off. If you use this command:
mysql>
+
+ show tables from bugs;
+
you'll be able to see all the
- you'll be able to see all the
+ "spreadsheets" (tables) in your database. It
- is similar to a file system, only faster and more robust for
- certain types of operations.
+
+ (tables) in your database. It is similar to a file system, only
+ faster and more robust for certain types of operations.
From the command issued above, ou should have some
- output that looks like this:
-
From the command issued above, ou should have some output that
+ looks like this:
+
-
- Here's an overview of what each table does. Most columns in each table have
-descriptive names that make it fairly trivial to figure out their jobs.
-
-attachments: This table stores all attachments to bugs. It tends to be your
-largest table, yet also generally has the fewest entries because file
-attachments are so (relatively) large.
-
-bugs: This is the core of your system. The bugs table stores most of the
-current information about a bug, with the exception of the info stored in the
-other tables.
-
-bugs_activity: This stores information regarding what changes are made to bugs
-when -- a history file.
-
-cc: This tiny table simply stores all the CC information for any bug which has
-any entries in the CC field of the bug. Note that, like most other tables in
-Bugzilla, it does not refer to users by their user names, but by their unique
-userid, stored as a primary key in the profiles table.
-
-components: This stores the programs and components (or products and
-components, in newer Bugzilla parlance) for Bugzilla. Curiously, the "program"
-(product) field is the full name of the product, rather than some other unique
-identifier, like bug_id and user_id are elsewhere in the database.
-
-dependencies: Stores data about those cool dependency trees.
-
-fielddefs: A nifty table that defines other tables. For instance, when you
-submit a form that changes the value of "AssignedTo" this table allows
-translation to the actual field name "assigned_to" for entry into MySQL.
-
-groups: defines bitmasks for groups. A bitmask is a number that can uniquely
-identify group memberships. For instance, say the group that is allowed to
-tweak parameters is assigned a value of "1", the group that is allowed to edit
-users is assigned a "2", and the group that is allowed to create new groups is
-assigned the bitmask of "4". By uniquely combining the group bitmasks (much
-like the chmod command in UNIX,) you can identify a user is allowed to tweak
-parameters and create groups, but not edit users, by giving him a bitmask of
-"5", or a user allowed to edit users and create groups, but not tweak
-parameters, by giving him a bitmask of "6" Simple, huh?
- If this makes no sense to you, try this at the mysql prompt:
-mysql> select * from groups;
- You'll see the list, it makes much more sense that way.
-
-keyworddefs: Definitions of keywords to be used
-
-keywords: Unlike what you'd think, this table holds which keywords are
-associated with which bug id's.
-
-logincookies: This stores every login cookie ever assigned to you for every
-machine you've ever logged into Bugzilla from. Curiously, it never does any
-housecleaning -- I see cookies in this file I've not used for months. However,
-since Bugzilla never expires your cookie (for convenience' sake), it makes
-sense.
-
-longdescs: The meat of bugzilla -- here is where all user comments are stored!
-You've only got 2^24 bytes per comment (it's a mediumtext field), so speak
-sparingly -- that's only the amount of space the Old Testament from the Bible
-would take (uncompressed, 16 megabytes). Each comment is keyed to the
-bug_id to which it's attached, so the order is necessarily chronological, for
-comments are played back in the order in which they are received.
-
-milestones: Interesting that milestones are associated with a specific product
-in this table, but Bugzilla does not yet support differing milestones by
-product through the standard configuration interfaces.
-
-namedqueries: This is where everybody stores their "custom queries". Very
-cool feature; it beats the tar out of having to bookmark each cool query you
-construct.
-
-products: What products you have, whether new bug entries are allowed for the
-product, what milestone you're working toward on that product, votes, etc. It
-will be nice when the components table supports these same features, so you
-could close a particular component for bug entry without having to close an
-entire product...
-
-profiles: Ahh, so you were wondering where your precious user information was
-stored? Here it is! With the passwords in plain text for all to see! (but
-sshh... don't tell your users!)
-
-profiles_activity: Need to know who did what when to who's profile? This'll
-tell you, it's a pretty complete history.
-
-shadowlog: I could be mistaken here, but I believe this table tells you when
-your shadow database is updated and what commands were used to update it. We
-don't use a shadow database at our site yet, so it's pretty empty for us.
-
-versions: Version information for every product
-
-votes: Who voted for what when
-
-watch: Who (according to userid) is watching who's bugs (according to their
-userid).
-
-
-===
-THE DETAILS
-===
-
- Ahh, so you're wondering just what to do with the information above? At the
-mysql prompt, you can view any information about the columns in a table with
-this command (where "table" is the name of the table you wish to view):
-
-mysql> show columns from table;
-
- You can also view all the data in a table with this command:
-
-mysql> select * from table;
-
- -- note: this is a very bad idea to do on, for instance, the "bugs" table if
-you have 50,000 bugs. You'll be sitting there a while until you ctrl-c or
-50,000 bugs play across your screen.
-
- You can limit the display from above a little with the command, where
-"column" is the name of the column for which you wish to restrict information:
-
-mysql> select * from table where (column = "some info");
-
- -- or the reverse of this
-
-mysql> select * from table where (column != "some info");
-
- Let's take our example from the introduction, and assume you need to change
-the word "verified" to "approved" in the resolution field. We know from the
-above information that the resolution is likely to be stored in the "bugs"
-table. Note we'll need to change a little perl code as well as this database
-change, but I won't plunge into that in this document. Let's verify the
-information is stored in the "bugs" table:
-
-mysql> show columns from bugs
-
- (exceedingly long output truncated here)
-| bug_status| enum('UNCONFIRMED','NEW','ASSIGNED','REOPENED','RESOLVED','VERIFIED','CLOSED')||MUL | UNCONFIRMED||
-
- Sorry about that long line. We see from this that the "bug status" column is
-an "enum field", which is a MySQL peculiarity where a string type field can
-only have certain types of entries. While I think this is very cool, it's not
-standard SQL. Anyway, we need to add the possible enum field entry
-'APPROVED' by altering the "bugs" table.
-
-mysql> ALTER table bugs CHANGE bug_status bug_status
- -> enum("UNCONFIRMED", "NEW", "ASSIGNED", "REOPENED", "RESOLVED",
- -> "VERIFIED", "APPROVED", "CLOSED") not null;
-
- (note we can take three lines or more -- whatever you put in before the
-semicolon is evaluated as a single expression)
-
-Now if you do this:
-
-mysql> show columns from bugs;
-
- you'll see that the bug_status field has an extra "APPROVED" enum that's
-available! Cool thing, too, is that this is reflected on your query page as
-well -- you can query by the new status. But how's it fit into the existing
-scheme of things?
- Looks like you need to go back and look for instances of the word "verified"
-in the perl code for Bugzilla -- wherever you find "verified", change it to
-"approved" and you're in business (make sure that's a case-insensitive search).
-Although you can query by the enum field, you can't give something a status
-of "APPROVED" until you make the perl changes. Note that this change I
-mentioned can also be done by editing checksetup.pl, which automates a lot of
-this. But you need to know this stuff anyway, right?
-
- I hope this database tutorial has been useful for you. If you have comments
-to add, questions, concerns, etc. please direct them to
-mbarnson@excitehome.net. Please direct flames to /dev/null :) Have a nice
-day!
-
-
-
-===
-LINKS
-===
-
-Great MySQL tutorial site:
-http://www.devshed.com/Server_Side/MySQL/
-
-
Here's an overview of what each table does. Most
+ columns in each table have descriptive names that make it fairly
+ trivial to figure out their jobs. attachments: This table stores all
+ attachments to bugs. It tends to be your largest table, yet also
+ generally has the fewest entries because file attachments are so
+ (relatively) large. bugs: This is the core of your system. The bugs
+ table stores most of the current information about a bug, with the
+ exception of the info stored in the other tables. bugs_activity: This
+ stores information regarding what changes are made to bugs when -- a
+ history file. cc: This tiny table simply stores all the CC
+ information for any bug which has any entries in the CC field of the
+ bug. Note that, like most other tables in Bugzilla, it does not refer
+ to users by their user names, but by their unique userid, stored as a
+ primary key in the profiles table. components: This stores the
+ programs and components (or products and components, in newer
+ Bugzilla parlance) for Bugzilla. Curiously, the "program" (product)
+ field is the full name of the product, rather than some other unique
+ identifier, like bug_id and user_id are elsewhere in the database.
+ dependencies: Stores data about those cool dependency trees.
+ fielddefs: A nifty table that defines other tables. For instance,
+ when you submit a form that changes the value of "AssignedTo" this
+ table allows translation to the actual field name "assigned_to" for
+ entry into MySQL. groups: defines bitmasks for groups. A bitmask is a
+ number that can uniquely identify group memberships. For instance,
+ say the group that is allowed to tweak parameters is assigned a value
+ of "1", the group that is allowed to edit users is assigned a "2",
+ and the group that is allowed to create new groups is assigned the
+ bitmask of "4". By uniquely combining the group bitmasks (much like
+ the chmod command in UNIX,) you can identify a user is allowed to
+ tweak parameters and create groups, but not edit users, by giving him
+ a bitmask of "5", or a user allowed to edit users and create groups,
+ but not tweak parameters, by giving him a bitmask of "6" Simple, huh?
+ If this makes no sense to you, try this at the mysql prompt:
+ mysql> select * from groups; You'll see the list, it makes much
+ more sense that way. keyworddefs: Definitions of keywords to be used
+ keywords: Unlike what you'd think, this table holds which keywords
+ are associated with which bug id's. logincookies: This stores every
+ login cookie ever assigned to you for every machine you've ever
+ logged into Bugzilla from. Curiously, it never does any housecleaning
+ -- I see cookies in this file I've not used for months. However,
+ since Bugzilla never expires your cookie (for convenience' sake), it
+ makes sense. longdescs: The meat of bugzilla -- here is where all
+ user comments are stored! You've only got 2^24 bytes per comment
+ (it's a mediumtext field), so speak sparingly -- that's only the
+ amount of space the Old Testament from the Bible would take
+ (uncompressed, 16 megabytes). Each comment is keyed to the bug_id to
+ which it's attached, so the order is necessarily chronological, for
+ comments are played back in the order in which they are received.
+ milestones: Interesting that milestones are associated with a
+ specific product in this table, but Bugzilla does not yet support
+ differing milestones by product through the standard configuration
+ interfaces. namedqueries: This is where everybody stores their
+ "custom queries". Very cool feature; it beats the tar out of having
+ to bookmark each cool query you construct. products: What products
+ you have, whether new bug entries are allowed for the product, what
+ milestone you're working toward on that product, votes, etc. It will
+ be nice when the components table supports these same features, so
+ you could close a particular component for bug entry without having
+ to close an entire product... profiles: Ahh, so you were wondering
+ where your precious user information was stored? Here it is! With the
+ passwords in plain text for all to see! (but sshh... don't tell your
+ users!) profiles_activity: Need to know who did what when to who's
+ profile? This'll tell you, it's a pretty complete history. shadowlog:
+ I could be mistaken here, but I believe this table tells you when
+ your shadow database is updated and what commands were used to update
+ it. We don't use a shadow database at our site yet, so it's pretty
+ empty for us. versions: Version information for every product votes:
+ Who voted for what when watch: Who (according to userid) is watching
+ who's bugs (according to their userid). === THE DETAILS === Ahh, so
+ you're wondering just what to do with the information above? At the
+ mysql prompt, you can view any information about the columns in a
+ table with this command (where "table" is the name of the table you
+ wish to view): mysql> show columns from table; You can also view
+ all the data in a table with this command: mysql> select * from
+ table; -- note: this is a very bad idea to do on, for instance, the
+ "bugs" table if you have 50,000 bugs. You'll be sitting there a while
+ until you ctrl-c or 50,000 bugs play across your screen. You can
+ limit the display from above a little with the command, where
+ "column" is the name of the column for which you wish to restrict
+ information: mysql> select * from table where (column = "some
+ info"); -- or the reverse of this mysql> select * from table where
+ (column != "some info"); Let's take our example from the
+ introduction, and assume you need to change the word "verified" to
+ "approved" in the resolution field. We know from the above
+ information that the resolution is likely to be stored in the "bugs"
+ table. Note we'll need to change a little perl code as well as this
+ database change, but I won't plunge into that in this document. Let's
+ verify the information is stored in the "bugs" table: mysql> show
+ columns from bugs (exceedingly long output truncated here) |
+ bug_status|
+ enum('UNCONFIRMED','NEW','ASSIGNED','REOPENED','RESOLVED','VERIFIED','CLOSED')||MUL
+ | UNCONFIRMED|| Sorry about that long line. We see from this that the
+ "bug status" column is an "enum field", which is a MySQL peculiarity
+ where a string type field can only have certain types of entries.
+ While I think this is very cool, it's not standard SQL. Anyway, we
+ need to add the possible enum field entry 'APPROVED' by altering the
+ "bugs" table. mysql> ALTER table bugs CHANGE bug_status bug_status
+ -> enum("UNCONFIRMED", "NEW", "ASSIGNED", "REOPENED", "RESOLVED",
+ -> "VERIFIED", "APPROVED", "CLOSED") not null; (note we can take
+ three lines or more -- whatever you put in before the semicolon is
+ evaluated as a single expression) Now if you do this: mysql> show
+ columns from bugs; you'll see that the bug_status field has an extra
+ "APPROVED" enum that's available! Cool thing, too, is that this is
+ reflected on your query page as well -- you can query by the new
+ status. But how's it fit into the existing scheme of things? Looks
+ like you need to go back and look for instances of the word
+ "verified" in the perl code for Bugzilla -- wherever you find
+ "verified", change it to "approved" and you're in business (make sure
+ that's a case-insensitive search). Although you can query by the enum
+ field, you can't give something a status of "APPROVED" until you make
+ the perl changes. Note that this change I mentioned can also be done
+ by editing checksetup.pl, which automates a lot of this. But you need
+ to know this stuff anyway, right? I hope this database tutorial has
+ been useful for you. If you have comments to add, questions,
+ concerns, etc. please direct them to mbarnson@excitehome.net. Please
+ direct flames to /dev/null :) Have a nice day! === LINKS === Great
+ MySQL tutorial site:
+ http://www.devshed.com/Server_Side/MySQL/
No liability for the contents of this document can be accepted.
Use the concepts, examples, and other content at your own risk.
- As this is a new edition of this document, there may be errors
- and inaccuracies that may damage your system. Use of this
- document may cause your girlfriend to leave you, your cats to
- pee on your furniture and clothing, your computer to cease
- functioning, your boss to fire you, and global thermonuclear
- war. Proceed with caution.
+ This document may contain errors
+ and inaccuracies that may damage your system, cause your partner
+ to leave you, your boss to fire you, your cats to
+ pee on your furniture and clothing, and global thermonuclear
+ war. Proceed with caution.
All copyrights are held by their respective owners, unless
@@ -113,7 +112,7 @@ NAME="disclaimer">1.3. DisclaimerAppendix B. Software Download Links
LinuxDoc Software:
- http://www.linuxdoc.org/
- (for documentation maintenance)
+>(But remember, Bundle::Bugzilla will install all the modules for you.)
Here are some miscellaneous notes about possible issues you
- main run into when you begin your Bugzilla installation.
- Reference platforms for Bugzilla installation are Redhat Linux
- 7.2, Linux-Mandrake 8.0, and Solaris 8.
Here are some miscellaneous notes about possible issues you main
+ run into when you begin your Bugzilla installation. Reference platforms
+ for Bugzilla installation are Redhat Linux 7.2, Linux-Mandrake 8.0, and
+ Solaris 8.
If you are installing Bugzilla on S.u.S.e. Linux, or some
- other distributions with If you are installing Bugzilla on S.u.S.e. Linux, or some other
+ distributions with
+ "paranoid" security
- options, it is possible that the checksetup.pl script may fail
- with the error:
+
+ security options, it is possible that the checksetup.pl script may fail
+ with the error:
+ cannot chdir(/var/spool/mqueue):
- Permission denied This is because your
- cannot chdir(/var/spool/mqueue): Permission
+ denied
+
+ This is because your
+ /var/spool/mqueue directory has a mode of
-
+
+ directory has a mode of
+ "drwx------". Type
+
+ . Type
+ chmod 755
- chmod 755
+ /var/spool/mqueue as root to
- fix this problem.
-
+
+
+ as root to fix this problem.
Bugzilla may be installed on Macintosh OS X (10), which is a
- unix-based (BSD) operating system. Everything required for
- Bugzilla on OS X will install cleanly, but the optional GD
- perl module which is used for bug charting requires some
- additional setup for installation. Please see the Mac OS X
- installation section below for details
-
Bugzilla may be installed on Macintosh OS X (10), which is a
+ unix-based (BSD) operating system. Everything required for Bugzilla on
+ OS X will install cleanly, but the optional GD perl module which is
+ used for bug charting requires some additional setup for installation.
+ Please see the Mac OS X installation section below for details
Release Notes for Bugzilla 2.16 are available at
- Release Notes for Bugzilla &bz-ver; are available at
+ docs/rel_notes.txt in your Bugzilla
- source distribution.
-
+
+ in your Bugzilla source distribution.
The preferred documentation for Bugzilla is available in
- docs/, with a variety of document types available. Please
- refer to these documents when installing, configuring, and
- maintaining your Bugzilla installation.
-
The preferred documentation for Bugzilla is available in docs/,
+ with a variety of document types available. Please refer to these
+ documents when installing, configuring, and maintaining your Bugzilla
+ installation.
Bugzilla is not a package where you can just plop it in a directory,
- twiddle a few things, and you're off. Installing Bugzilla assumes you
- know your variant of UNIX or Microsoft Windows well, are familiar with the
- command line, and are comfortable compiling and installing a plethora
- of third-party utilities. To install Bugzilla on Win32 requires
- fair Perl proficiency, and if you use a webserver other than Apache you
- should be intimately familiar with the security mechanisms and CGI
- environment thereof.
-
Bugzilla is not a package where you can just plop it in a
+ directory, twiddle a few things, and you're off. Installing Bugzilla
+ assumes you know your variant of UNIX or Microsoft Windows well, are
+ familiar with the command line, and are comfortable compiling and
+ installing a plethora of third-party utilities. To install Bugzilla on
+ Win32 requires fair Perl proficiency, and if you use a webserver other
+ than Apache you should be intimately familiar with the security
+ mechanisms and CGI environment thereof.
Bugzilla has not undergone a complete security review. Security holes
- may exist in the code. Great care should be taken both in the installation
- and usage of this software. Carefully consider the implications of
- installing other network services with Bugzilla.
-
Bugzilla has not undergone a complete security review. Security
+ holes may exist in the code. Great care should be taken both in the
+ installation and usage of this software. Carefully consider the
+ implications of installing other network services with Bugzilla.PrevNextInstallationGeneral Installation Notes
- You can't. However, the administrative account can, by simply opening
- your user account in editusers.cgi and changing the login name.
+ New in 2.16 - go to the Account section of the Preferences. You will
+ be emailed at both addresses for confirmation.
Things aren't quite that grim these days, however. Terry pretty much
- sums up much of the thinking many of us have for Bugzilla, but there
- is light on the horizon for database-independence! Here are some options:
-
Red Hat Bugzilla:
- Runs a modified Bugzilla 2.8 atop an Oracle database.
-
Interzilla:
- A project to run Bugzilla on Interbase. No code released yet, however.
-
Bugzilla 3.0: One of the primary stated goals
- is multiple database support.
-
- Red Hat Bugzilla is arguably more user-friendly, customizable, and scalable
- than stock Bugzilla. Check it out at
- http://bugzilla.redhat.com and the sources at ftp://people.redhat.com/dkl/.
- They've set their Bugzilla up to work with Oracle out of the box.
- Note that Redhat Bugzilla is based upon the 2.8 Bugzilla tree;
- Bugzilla has made some tremendous advances since the 2.8 release.
- Why not download both Bugzillas to check out the differences for
- yourself?
-
Dave Lawrence, the original Red Hat Bugzilla maintainer, mentions:
-
This information is somewhat dated; I last updated it
- 7 June 2000. Please see the "Variants" section of "The Bugzilla Guide"
- for more up-to-date information regarding Red Hat Bugzilla.
-
- Loki Games has a customized version of Bugzilla available at
- http://fenris.lokigames.com. There are some advantages to using Fenris, chief being separation of comments based upon user privacy level, data hiding, forced login for any data retrieval, and some additional fields. Loki has mainted their code, originally a fork from the Bugzilla 2.8 code base, and it is quite a bit different than stock Bugzilla at this point. I recommend you stick with official Bugzilla version 2.16 rather than using a fork, but it's up to you.
-
- It's possible to get the footer on the static index page using
- Server Side Includes (SSI). The trick to doing this is making
- sure that your web server is set up to allow SSI and specifically,
- the #exec directive. You should also rename index.html
- to index.shtml.
-
After you've done all that, you can add the following line to
- index.shtml:
-
This line will be replaced with the actual HTML for the footer
- when the page is requested, so you should put this line where you
- want the footer to appear.
-
Because this method depends on being able to use a #exec directive,
- and most ISP's will not allow that, there is an alternative method.
- You could have a small script (such as api.cgi)
- that basically looks like:
-
Check
http://www.mozilla.org/projects/bugzilla/
http://www.bugzilla.org/ for details.
- Once you download it, untar it, read the Bugzilla Guide.
+ Read the other parts of this Guide for installation instructions.
- The Bugzilla code has not undergone a complete security audit.
- It is recommended that you closely examine permissions on your Bugzilla
+ The Bugzilla code has undergone a reasonably complete security audit,
+ and user-facing CGIs run under Perl's taint mode. However,
+ it is recommended that you closely examine permissions on your Bugzilla
installation, and follow the recommended security guidelines found
in The Bugzilla Guide.
If you are using an alternate Mail Transport Agent (MTA other than
- sendmail), make sure the options given in the "processmail" script for all
+ sendmail), make sure the options given in the "processmail" and other
+ scripts for all
instances of "sendmail" are correct for your MTA.
- Red Hat Bugzilla, mentioned above, works with Oracle. The current version
+ Red Hat Bugzilla works with Oracle. The current version
from Mozilla.org does not have this capability. Unfortunately, though
you will sacrifice a lot of the really great features available in
- Bugzilla 2.10 and 2.12 if you go with the 2.8-based Redhat version.
-
- You've almost certainly enabled the "shadow database", but for some
- reason it hasn't been updated for all your bugs. This is the database
- against which queries are run, so that really complex or slow queries won't
- lock up portions of the database for other users. You can turn off the
- shadow database in editparams.cgi. If you wish to continue using the shadow
- database, then as your "bugs" user run "./syncshadowdb -syncall" from the
- command line in the bugzilla installation directory to recreate your shadow
- database. After it finishes, be sure to check the params and make sure that
- "queryagainstshadowdb" is still turned on. The syncshadowdb program turns it
- off if it was on, and is supposed to turn it back on when completed; that
- way, if it crashes in the middle of recreating the database, it will stay
- off forever until someone turns it back on by hand. Apparently, it doesn't
- always do that yet.
+ Bugzilla 2.14 and 2.16 if you go with the 2.8-based Redhat version.
- If you're sure your MySQL parameters are correct, you might want turn
- "strictvaluechecks" OFF in editparams.cgi. If you have "usebugsentry" set
- "On", you also cannot submit a bug as readable by more than one group with
- "strictvaluechecks" ON.
-
- This should only happen with Bugzilla 2.16 if you are
- using the "shadow database" feature, and your
- shadow database is out of sync. Try running
- syncshadowdb
- -syncall to make sure your shadow
- database is in synch with your primary database.
-
- The following couple entries are deprecated in favor of the Windows installation
- instructions available in the "Administration" portion of "The Bugzilla Guide".
- However, they are provided here for historical interest and insight.
-
- 1. #!C:/perl/bin/perl had to be added to every perl file.
- 2. Converted to Net::SMTP to handle mail messages instead of
- /usr/bin/sendmail.
- 3. The crypt function isn't available on Windows NT (at least none that I
- am aware), so I made encrypted passwords = plaintext passwords.
- 4. The system call to diff had to be changed to the Cygwin diff.
- 5. This was just to get a demo running under NT, it seems to be working
- good, and I have inserted almost 100 bugs from another bug tracking
- system. Since this work was done just to get an in-house demo, I am NOT
- planning on making a patch for submission to Bugzilla. If you would
- like a zip file, let me know.
-
-Q: Hmm, couldn't figure it out from the general instructions above. How
-about step-by-step?
-A: Sure! Here ya go!
-
- 1. Install IIS 4.0 from the NT Option Pack #4.
- 2. Download and install Active Perl.
- 3. Install the Windows GNU tools from Cygwin. Make sure to add the bin
- directory to your system path. (Everyone should have these, whether
- they decide to use Bugzilla or not. :-) )
- 4. Download relevant packages from ActiveState at
- http://www.activestate.com/packages/zips/. + DBD-Mysql.zip
- 5. Extract each zip file with WinZip, and install each ppd file using the
- notation: ppm install <module>.ppd
- 6. Install Mysql. *Note: If you move the default install from c:\mysql,
- you must add the appropriate startup parameters to the NT service. (ex.
- -b e:\\programs\\mysql)
- 7. Download any Mysql client. http://www.mysql.com/download_win.html
- 8. Setup MySql. (These are the commands that I used.)
-
- I. Cleanup default database settings.
- C:\mysql\bin\mysql -u root mysql
- mysql> DELETE FROM user WHERE Host='localhost' AND User='';
- mysql> quit
- C:\mysql\bin\mysqladmin reload
-
- II. Set password for root.
- C:\mysql\bin\mysql -u root mysql
- mysql> UPDATE user SET Password=PASSWORD('new_password')
- WHERE user='root';
- mysql> FLUSH PRIVILEGES;
- mysql> quit
- C:\mysql\bin\mysqladmin -u root reload
-
- III. Create bugs user.
- C:\mysql\bin\mysql -u root -p
- mysql> insert into user (host,user,password)
- values('localhost','bugs','');
- mysql> quit
- C:\mysql\bin\mysqladmin -u root reload
-
- IV. Create the bugs database.
- C:\mysql\bin\mysql -u root -p
- mysql> create database bugs;
-
- V. Give the bugs user access to the bugs database.
- mysql> insert into db
- (host,db,user,select_priv,insert_priv,update_priv,delete_priv,create_priv,drop_priv)
- values('localhost','bugs','bugs','Y','Y','Y','Y','Y','N')
- mysql> quit
- C:\mysql\bin\mysqladmin -u root reload
- 9. Run the table scripts to setup the bugs database.
- 10. Change CGI.pm to use the following regular expression because of
- differing backslashes in NT versus UNIX.
- o $0 =~ m:[^\\]*$:;
- 11. Had to make the crypt password = plain text password in the database.
- (Thanks to Andrew Lahser" <andrew_lahser@merck.com>" on this one.) The
- files that I changed were:
- o globals.pl
- o CGI.pl
- o alternately, you can try commenting all references to 'crypt'
- string and replace them with similar lines but without encrypt()
- or crypr() functions insida all files.
- 12. Replaced sendmail with Windmail. Basically, you have to come up with a
- sendmail substitute for NT. Someone said that they used a Perl module
- (Net::SMTP), but I was trying to save time and do as little Perl coding
- as possible.
- 13. Added "perl" to the beginning of all Perl system calls that use a perl
- script as an argument and renamed processmail to processmail.pl.
- 14. In processmail.pl, I added binmode(HANDLE) before all read() calls. I'm
- not sure about this one, but the read() under NT wasn't counting the
- EOLs without the binary read."
-
- We are developing in that direction. You can follow progress on this
- at
http://bugzilla.mozilla.org/show_bug.cgi?id=16775. Some functionality
- is available in Bugzilla 2.12, and is available as "quicksearch.html"
+ The interface was simplified by a UI designer for 2.16. Further
+ suggestions for improvement are welcome, but we won't sacrifice power for
+ simplicity.
You can view bugs marked for 2.16 release
+>
You can view bugs marked for 2.18 release
here.
- This list includes bugs for the 2.16 release that have already
+ This list includes bugs for the 2.18 release that have already
been fixed and checked into CVS. Please consult the
Upload your patch as a unified DIFF (having used "diff -u" against
+>
Upload your patch as a unified diff (having used "diff -u" against
the current sources checked out of CVS),
or new source file by clicking
"Create a new attachment" link on the bug page you've just created, and
include any descriptions of database changes you may make, into the bug
- ID you submitted in step #1. Be sure and click the "Patch" radio
- button to indicate the text you are sending is a patch!
+ ID you submitted in step #1. Be sure and click the "Patch" checkbox
+ to indicate the text you are sending is a patch!
Installation General NotesGeneral Installation NotesPrevChapter 3. InstallationChapter 4. Installation
Bugzilla optimizes database lookups by storing all relatively static
- information in the versioncache file, located in the data/ subdirectory
- under your installation directory.
-
Bugzilla optimizes database lookups by storing all relatively
+ static information in the versioncache file, located in the data/
+ subdirectory under your installation directory.
If you make a change to the structural data in your database
- (the versions table for example), or to the
- If you make a change to the structural data in your database (the
+ versions table for example), or to the
+ "constants" encoded in defparams.pl, you will
- need to remove the cached content from the data directory
- (by doing a
+
+ encoded in defparams.pl, you will need to remove the cached content
+ from the data directory (by doing a
+ "rm data/versioncache"), or your
- changes won't show up.
-
+
+ ), or your changes won't show up.
That file gets automatically regenerated whenever it's more than an
- hour old, so Bugzilla will eventually notice your changes by itself, but
- generally you want it to notice right away, so that you can test things.
-
That file gets automatically regenerated whenever it's more than
+ an hour old, so Bugzilla will eventually notice your changes by itself,
+ but generally you want it to notice right away, so that you can test
+ things.
A plain Bugzilla is fairly easy to upgrade from one version to a newer one.
- However, things get a bit more complicated if you've made changes to
- Bugzilla's code. In this case, you may have to re-make or reapply those
- changes.
- It is recommended that you take a backup of your database and your entire
- Bugzilla installation before attempting an upgrade. You can upgrade a 'clean'
- installation by untarring a new tarball over the old installation. If you
- are upgrading from 2.12 or later, you can type A plain Bugzilla is fairly easy to upgrade from one version to a
+ newer one. However, things get a bit more complicated if you've made
+ changes to Bugzilla's code. In this case, you may have to re-make or
+ reapply those changes. It is recommended that you take a backup of your
+ database and your entire Bugzilla installation before attempting an
+ upgrade. You can upgrade a 'clean' installation by untarring a new
+ tarball over the old installation. If you are upgrading from 2.12 or
+ later, you can type
+ cvs -z3
- update, and resolve conflicts if there are any.
-
cvs -z3 update
+
+ , and resolve conflicts if there are any.
Because the developers of Bugzilla are constantly adding new tables, columns
- and fields, you'll probably get SQL errors if you just update the code and
- attempt to use Bugzilla. Always run the checksetup.pl script whenever
- you upgrade your installation.
-
Because the developers of Bugzilla are constantly adding new
+ tables, columns and fields, you'll probably get SQL errors if you just
+ update the code and attempt to use Bugzilla. Always run the
+ checksetup.pl script whenever you upgrade your installation.
If you are running Bugzilla version 2.8 or lower, and wish to upgrade to
- the latest version, please consult the file, "UPGRADING-pre-2.8" in the
- Bugzilla root directory after untarring the archive.
-
If you are running Bugzilla version 2.8 or lower, and wish to
+ upgrade to the latest version, please consult the file,
+ "UPGRADING-pre-2.8" in the Bugzilla root directory after untarring the
+ archive.
To enhance the security of your Bugzilla installation,
- Bugzilla will generate
- To enhance the security of your Bugzilla installation, Bugzilla
+ will generate
+ .htaccess files
- which the Apache webserver can use to restrict access to
- the bugzilla data files. The checksetup script will
- generate the
+
+
+ files which the Apache webserver can use to restrict access to the
+ bugzilla data files. The checksetup script will generate the
+ .htaccess files. These .htaccess files
- will not work with Apache 1.2.x - but this has security holes, so you
- shouldn't be using it anyway.
-
-
+
+ files. These .htaccess files will not work with Apache 1.2.x - but this
+ has security holes, so you shouldn't be using it anyway.
+
If you are using an alternate provider of
- If you are using an alternate provider of
+ webdot services for graphing
- (as described when viewing
-
+
+ services for graphing (as described when viewing
+ editparams.cgi in your web
- browser), you will need to change the ip address in
-
+
+ in your web browser), you will need to change the ip address in
+ data/webdot/.htaccess to the ip
- address of the webdot server that you are using.
-
+
+ to the ip address of the webdot server that you are using.
-
The default .htaccess file may not provide adequate access
- restrictions, depending on your web server configuration.
- Be sure to check the <Directory> entries for your
- Bugzilla directory so that the The default .htaccess file may not provide adequate access
+ restrictions, depending on your web server configuration. Be sure to
+ check the <Directory> entries for your Bugzilla directory so that
+ the
+ .htaccess
- file is allowed to override web server defaults. For instance,
- let's assume your installation of Bugzilla is installed to
- /usr/local/bugzilla. You should have
- this <Directory> entry in your
+
+ . You should have this <Directory> entry in your
+ httpd.conf
- file:
-
The important part above is The important part above is
+ "AllowOverride All".
- Without that, the
+
+ . Without that, the
+ .htaccess file created by
-
+
+ file created by
+ checksetup.pl will not have sufficient
- permissions to protect your Bugzilla installation.
-
+
+ will not have sufficient permissions to protect your Bugzilla
+ installation.
If you are using Internet Information Server or other web
- server which does not observe If you are using Internet Information Server or other web server
+ which does not observe
+ .htaccess
- conventions, you can disable their creation by editing
- localconfig and setting the
-
+
+ and setting the
+ $create_htaccess variable to
-
+
+ variable to
+ 0.
-
It is possible for a user, by mistake or on purpose, to access
- the database many times in a row which can result in very slow
- access speeds for other users. If your Bugzilla installation
- is experiencing this problem , you may install the Apache
- module It is possible for a user, by mistake or on purpose, to access
+ the database many times in a row which can result in very slow access
+ speeds for other users. If your Bugzilla installation is experiencing
+ this problem , you may install the Apache module
+ mod_throttle which can limit
- connections by ip-address. You may download this module at
-
+
+ which can limit connections by ip-address. You may download this module
+ at
+ http://www.snert.com/Software/Throttle/. Follow the instructions to install into your Apache install. This module only functions with the Apache web server!. You may use the
http://www.snert.com/Software/Throttle/
+
+ . Follow the instructions to install into your Apache install.
+ This module only functions with the Apache web
+ server!
+
+ . You may use the
+ ThrottleClientIP command provided by this module to accomplish this goal. See the
+
+ command provided by this module to accomplish this goal. See the
+ Module Instructions for more information.
http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3.
+ Executing the following code snippet from a UNIX command shell will
+ rectify the problem if your Bugzilla installation is intended for an
+ English-speaking audience. As always, be sure your Bugzilla
+ installation has a good backup before making changes, and I recommend
+ you understand what the script is doing before executing it.
bash# cd $BUGZILLA_HOME; for i in `ls *.cgi`; \
- do cat $i | sed 's/Content-type\: text\/html/Content-Type: text\/html\; charset=ISO-8859-1/' >$i.tmp; \
- mv $i.tmp $i; done
-
bash# cd <your_bugzilla_dir>;
+ for i in `ls *.cgi`; \ do
+ cat $i | sed 's/Content-type\: text\/html/Content-Type: text\/html\;
+ charset=ISO-8859-1/' >$i.tmp; \ mv $i.tmp $i;
+ done
+
All this one-liner command does is search for all instances of
- All this one-liner command does is search for all instances of
+ "Content-type: text/html" and replaces it with
-
+
+ and replaces it with
+ "Content-Type: text/html; charset=ISO-8859-1".
- This specification prevents possible Javascript attacks on the
- browser, and is suggested for all English-speaking sites. For
- non-english-speaking Bugzilla sites, I suggest changing
-
+
+ . This specification prevents possible Javascript attacks on the
+ browser, and is suggested for all English-speaking sites. For
+ non-English-speaking Bugzilla sites, I suggest changing
+ "ISO-8859-1", above, to , above, to
+ "UTF-8".
-
This document was originally adapted from the Bonsai
- installation instructions by Terry Weissman
- <terry@mozilla.org>.
-
The February 25, 1999 re-write of this page was done by Ry4an
- Brase <ry4an@ry4an.org>, with some edits by Terry
- Weissman, Bryce Nesbitt, Martin Pool, & Dan Mosedale (But
- don't send bug reports to them; report them using bugzilla, at http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla ).
-
This document was heavily modified again Wednesday, March 07
- 2001 to reflect changes for Bugzilla 2.12 release by Matthew
- P. Barnson. The securing MySQL section should be changed to
- become standard procedure for Bugzilla installations.
-
4.4.6. cannot chdir(/var/spool/mqueue)
Finally, the README in its entirety was marked up in SGML and
- included into the Guide on April 24, 2001 by Matt Barnson.
- Since that time, it's undergone extensive modification as
- Bugzilla grew.
+>If you are installing Bugzilla on SuSE Linux, or some other
+ distributions with
+ "paranoid"
+ security options, it is possible that the checksetup.pl script may fail
+ with the error:
+ cannot chdir(/var/spool/mqueue): Permission
+ denied.
Comments from people using this Guide for the first time are
- particularly welcome.
+>
This is because your
+ /var/spool/mqueue
+ directory has a mode of
+ "drwx------". Type
+ chmod 755
+ /var/spool/mqueue
+
+ as root to fix this problem.
PrevNextBSD Installation NotesMac OS X Installation Notes
Each version of the License is given a distinguishing
- version number. If the Document specifies that a particular
- numbered version of this License "or any later version" applies to
- it, you have the option of following the terms and conditions
- either of that specified version or of any later version that has
- been published (not as a draft) by the Free Software Foundation.
- If the Document does not specify a version number of this License,
- you may choose any version ever published (not as a draft) by the
- Free Software Foundation.
Each version of the License is given a distinguishing version
+ number. If the Document specifies that a particular numbered version of
+ this License "or any later version" applies to it, you have the option of
+ following the terms and conditions either of that specified version or of
+ any later version that has been published (not as a draft) by the Free
+ Software Foundation. If the Document does not specify a version number of
+ this License, you may choose any version ever published (not as a draft)
+ by the Free Software Foundation.
A compilation of the Document or its derivatives with other
- separate and independent documents or works, in or on a volume of
- a storage or distribution medium, does not as a whole count as a
- Modified Version of the Document, provided no compilation
- copyright is claimed for the compilation. Such a compilation is
- called an "aggregate", and this License does not apply to the
- other self-contained works thus compiled with the Document, on
- account of their being thus compiled, if they are not themselves
- derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to
- these copies of the Document, then if the Document is less than
- one quarter of the entire aggregate, the Document's Cover Texts
- may be placed on covers that surround only the Document within the
- aggregate. Otherwise they must appear on covers around the whole
- aggregate.
If the Cover Text requirement of section 3 is applicable to these
+ copies of the Document, then if the Document is less than one quarter of
+ the entire aggregate, the Document's Cover Texts may be placed on covers
+ that surround only the Document within the aggregate. Otherwise they must
+ appear on covers around the whole aggregate.
8. TRANSLATION
Translation is considered a kind of modification, so you may
- distribute translations of the Document under the terms of section
- 4. Replacing Invariant Sections with translations requires
- special permission from their copyright holders, but you may
- include translations of some or all Invariant Sections in addition
- to the original versions of these Invariant Sections. You may
- include a translation of this License provided that you also
- include the original English version of this License. In case of
- a disagreement between the translation and the original English
- version of this License, the original English version will
- prevail.
Apache web server, and other NCSA-compliant web servers,
- observe the convention of using files in directories
- called Apache web server, and other NCSA-compliant web servers,
+ observe the convention of using files in directories called
+ .htaccess files. These
- restrict parameters of the web server. In Bugzilla, they
- are used to restrict access to certain files which would
- otherwise compromise your installation. For instance, the
-
+
+ to restrict access to certain files. In Bugzilla, they are used
+ to keep secret files which would otherwise
+ compromise your installation - e.g. the
+ localconfig file contains the
- password to your database. If this information were
- generally available, and remote access to your database
- turned on, you risk corruption of your database by
- computer criminals or the curious.
-
+
+ file contains the password to your database. If this information were
+ generally available, and remote access to your database turned on,
+ you risk corruption of your database by computer criminals or the
+ curious.
A
In this context, Apache is the web server most
- commonly used for serving up
- In this context, Apache is the web server most commonly used
+ for serving up
+ Bugzilla pages. Contrary to
- popular belief, the apache web server has nothing to do
- with the ancient and noble Native American tribe, but
- instead derived its name from the fact that it was
-
+
+ pages. Contrary to popular belief, the apache web server has nothing
+ to do with the ancient and noble Native American tribe, but instead
+ derived its name from the fact that it was
+ "a patchy" version of the original
-
+
+ version of the original
+ NCSA world-wide-web server.
+
+ world-wide-web server.
B
A A
+ "Bug" in Bugzilla refers to an issue
- entered into the database which has an associated number,
- assignments, comments, etc. Some also refer to a
-
+
+ in Bugzilla refers to an issue entered into the database which has an
+ associated number, assignments, comments, etc. Some also refer to a
+ "tickets" or
+ or
+ "issues"; in the
- context of Bugzilla, they are synonymous.
-
;
+ in the context of Bugzilla, they are synonymous.
Each Bugzilla Bug is assigned a number that uniquely
- identifies that Bug. The Bug associated with a Bug Number
- can be pulled up via a query, or easily from the very
- front page by typing the number in the "Find" box.
-
Each Bugzilla Bug is assigned a number that uniquely identifies
+ that Bug. The Bug associated with a Bug Number can be pulled up via a
+ query, or easily from the very front page by typing the number in the
+ "Find" box.
A Bug has stages through which it must pass before
- becoming a A Bug has stages through which it must pass before becoming a
+ "closed bug", including
- acceptance, resolution, and verification. The ,
+ including acceptance, resolution, and verification. The
+ "Bug
- Life Cycle" is moderately flexible according to
- the needs of the organization using it, though.
"Bug Life Cycle"
+
+ is moderately flexible according to the needs of the organization
+ using it, though.
Bugzilla is the industry-standard bug tracking system. It
- is quite popular among Open Source enthusiasts.
-
Bugzilla is the industry-standard bug tracking system. It is
+ quite popular among Open Source enthusiasts.
A Component is a subsection of a Product. It should be a
- narrow category, tailored to your organization. All
- Products must contain at least one Component (and, as a
- matter of fact, creating a Product with no Components will
- create an error in Bugzilla).
-
A Component is a subsection of a Product. It should be a narrow
+ category, tailored to your organization. All Products must contain at
+ least one Component (and, as a matter of fact, creating a Product
+ with no Components will create an error in Bugzilla).
CPAN stands for the
-
+
+ stands for the
+ "Comprehensive Perl Archive Network". CPAN
- maintains a large number of extremely useful
-
+
+ . CPAN maintains a large number of extremely useful
+ Perl modules. By themselves, Perl
- modules generally do nothing, but when used as part of a
- larger program, they provide much-needed algorithms and
- functionality.
+
+ modules. By themselves, Perl modules generally do nothing, but when
+ used as part of a larger program, they provide much-needed algorithms
+ and functionality.
D
A daemon is a computer program which runs in the
- background. In general, most daemons are started at boot
- time via System V init scripts, or through RC scripts on
- BSD-based systems. A daemon is a computer program which runs in the background. In
+ general, most daemons are started at boot time via System V init
+ scripts, or through RC scripts on BSD-based systems.
+ mysqld, the
- MySQL server, and ,
+ the MySQL server, and
+ apache, a web
- server, are generally run as daemons.
,
+ a web server, are generally run as daemons.
The word The word
+ "Groups" has a very special
- meaning to Bugzilla. Bugzilla's main security mechanism
- comes by lumping users into groups, and assigning those
- groups certain privileges to
-
+
+ has a very special meaning to Bugzilla. Bugzilla's main security
+ mechanism comes by lumping users into groups, and assigning those
+ groups certain privileges to
+ Products and
-
+
+ and
+ Components in the
-
+
+ in the
+ Bugzilla database.
+
+ database.
M
mysqld is the name of the
- mysqld is the name of the
+ daemon for the MySQL database. In
- general, it is invoked automatically through the use of
- the System V init scripts on GNU/Linux and AT&T System
- V-based systems, such as Solaris and HP/UX, or through the
- RC scripts on BSD-based systems.
+
+ for the MySQL database. In general, it is invoked automatically
+ through the use of the System V init scripts on GNU/Linux and
+ AT&T System V-based systems, such as Solaris and HP/UX, or
+ through the RC scripts on BSD-based systems.
P
A Product is a broad category of types of bugs. In
- general, there are several Components to a Product. A
- Product also defines a default Group (used for Bug
- Security) for all bugs entered into components beneath
- it.
A Product is a broad category of types of bugs. In general,
+ there are several Components to a Product. A Product may also define a
+ group (used for security) for all bugs entered into
+ components beneath it.
First written by Larry Wall, Perl is a remarkable
- program language. It has the benefits of the flexibility
- of an interpreted scripting language (such as shell
- script), combined with the speed and power of a compiled
- language, such as C. First written by Larry Wall, Perl is a remarkable program
+ language. It has the benefits of the flexibility of an interpreted
+ scripting language (such as shell script), combined with the speed
+ and power of a compiled language, such as C.
+ Bugzilla is
- maintained in Perl.
+
+ is maintained in Perl.
Q
"QA", ,
+ "Q/A", and
- , and
+ "Q.A." are short for
+ are short for
+ "Quality
- Assurance". In most large software development
- organizations, there is a team devoted to ensuring the
- product meets minimum standards before shipping. This
- team will also generally want to track the progress of
- bugs over their life cycle, thus the need for the
- "Quality Assurance".
+ In most large software development organizations, there is a team
+ devoted to ensuring the product meets minimum standards before
+ shipping. This team will also generally want to track the progress of
+ bugs over their life cycle, thus the need for the
+ "QA Contact" field in a Bug.
+
+ field in a Bug.
The property of a function looking back at itself for
- something. "GNU", for instance, stands for
- , for instance, stands for
+ "GNU's Not UNIX", thus recursing upon itself
- for definition. For further clarity, see Infinite
- Loop.
,
+ thus recursing upon itself for definition. For further clarity, see
+ Infinite Loop.
S
SGML
+
SGML stands for
+
+ stands for
+ "Standard
- Generalized Markup Language". Created in the
- 1980's to provide an extensible means to maintain
- documentation based upon content instead of presentation,
- "Standard Generalized Markup Language".
+ Created in the 1980's to provide an extensible means to maintain
+ documentation based upon content instead of presentation,
+ SGML has withstood the test of time as
- a robust, powerful language.
-
+
+ has withstood the test of time as a robust, powerful language.
+ XML is the
-
+
+
+ is the
+ "baby brother" of SGML; any valid
-
+
+ of SGML; any valid
+ XML document it, by definition, a valid
-
+
+ document it, by definition, a valid
+ SGML document. The document you are
- reading is written and maintained in
-
+
+ document. The document you are reading is written and maintained in
+ SGML, and is also valid
- ,
+ and is also valid
+ XML if you modify the Document Type
- Definition.
+
+ if you modify the Document Type Definition.
Target Milestones are Product goals. They are
- configurable on a per-Product basis. Most software
- development houses have a concept of
- Target Milestones are Product goals. They are configurable on a
+ per-Product basis. Most software development houses have a concept of
+
+ "milestones" where the people funding a
- project expect certain functionality on certain dates.
- Bugzilla facilitates meeting these milestones by giving
- you the ability to declare by which milestone a bug will be
- fixed, or an enhancement will be implemented.
-
+
+ where the people funding a project expect certain functionality on
+ certain dates. Bugzilla facilitates meeting these milestones by
+ giving you the ability to declare by which milestone a bug will be
+ fixed, or an enhancement will be implemented.
This is the cryptic response sent by Bugzilla when a
- query returned no results. It is just a goofy way of
- saying "Zero Bugs Found".
This is the cryptic response sent by Bugzilla when a query
+ returned no results. It is just a goofy way of saying "Zero Bugs
+ Found".
The following portion of documentation comes from my
- answer to an old discussion of Keystone, a cool product that
- does trouble-ticket tracking for IT departments. I wrote this
- post to the Keystone support group regarding MySQL grant
- table permissions, and how to use them effectively. It is
- badly in need of updating, as I believe MySQL has added a
- field or two to the grant tables since this time, but it
- serves as a decent introduction and troubleshooting document
- for grant table issues. I used Keynote to track my troubles
- until I discovered Bugzilla, which gave me a whole new set of
- troubles to work on : ) Although it is of limited use, it
- still has SOME use, thus it's still included.
The following portion of documentation comes from my answer to an
+ old discussion of Keystone, a cool product that does trouble-ticket
+ tracking for IT departments. I wrote this post to the Keystone support
+ group regarding MySQL grant table permissions, and how to use them
+ effectively. It is badly in need of updating, as I believe MySQL has
+ added a field or two to the grant tables since this time, but it serves
+ as a decent introduction and troubleshooting document for grant table
+ issues. I used Keynote to track my troubles until I discovered
+ Bugzilla, which gave me a whole new set of troubles to work on : )
+ Although it is of limited use, it still has SOME use, thus it's still
+ included.
Please note, however, that I was a relatively new user to
- MySQL at the time. Some of my suggestions, particularly in
- how to set up security, showed a terrible lack of
- security-related database experience.
-
Please note, however, that I was a relatively new user to MySQL
+ at the time. Some of my suggestions, particularly in how to set up
+ security, showed a terrible lack of security-related database
+ experience.
-From matt_barnson@singletrac.com Wed Jul 7 09:00:07 1999
-Date: Mon, 1 Mar 1999 21:37:04 -0700
-From: Matthew Barnson matt_barnson@singletrac.com
-To: keystone-users@homeport.org
-Subject: [keystone-users] Grant Tables FAQ
-
- [The following text is in the "iso-8859-1" character set]
- [Your display is set for the "US-ASCII" character set]
- [Some characters may be displayed incorrectly]
-
-Maybe we can include this rambling message in the Keystone FAQ? It gets
-asked a lot, and the only option current listed in the FAQ is
-"--skip-grant-tables".
-
-Really, you can't go wrong by reading section 6 of the MySQL manual, at
-http://www.mysql.com/Manual/manual.html. I am sure their description is
-better than mine.
-
-MySQL runs fine without permissions set up correctly if you run the mysql
-daemon with the "--skip-grant-tables" option. Running this way denies
-access to nobody. Unfortunately, unless you've got yourself firewalled it
-also opens the potential for abuse if someone knows you're running it.
-
-Additionally, the default permissions for MySQL allow anyone at localhost
-access to the database if the database name begins with "test_" or is named
-"test" (i.e. "test_keystone"). You can change the name of your database in
-the keystone.conf file ($sys_dbname). This is the way I am doing it for
-some of my databases, and it works fine.
-
-The methods described below assume you're running MySQL on the same box as
-your webserver, and that you don't mind if your $sys_dbuser for Keystone has
-superuser access. See near the bottom of this message for a description of
-what each field does.
-
-Method #1:
-
-1. cd /var/lib
- #location where you'll want to run /usr/bin/mysql_install_db shell
-script from to get it to work.
-
-2. ln -s mysql data
- # soft links the "mysql" directory to "data", which is what
-mysql_install_db expects. Alternately, you can edit mysql_install_db and
-change all the "./data" references to "./mysql".
-
-3. Edit /usr/bin/mysql_install_db with your favorite text editor (vi,
-emacs, jot, pico, etc.)
-A) Copy the "INSERT INTO db VALUES
-('%','test\_%','','Y','Y','Y','Y','Y','Y');" and paste it immediately after
-itself. Chage the 'test\_%' value to 'keystone', or the value of
-$sys_dbname in keystone.conf.
-B) If you are running your keystone database with any user, you'll need to
-copy the "INSERT INTO user VALUES
-('localhost','root','','Y','Y','Y','Y','Y','Y','Y','Y','Y','Y');" line after
-itself and change 'root' to the name of the keystone database user
-($sys_dbuser) in keystone.conf.
-
- # adds entries to the script to create grant tables for specific
-hosts and users. The user you set up has super-user access ($sys_dbuser) --
-you may or may not want this. The layout of mysql_install_db is really very
-uncomplicated.
-
-4. /usr/bin/mysqladmin shutdown
- # ya gotta shut it down before you can reinstall the grant tables!
-
-5. rm -i /var/lib/mysql/mysql/*.IS?' and answer 'Y' to the deletion
-questions.
- # nuke your current grant tables. This WILL NOT delete any other
-databases than your grant tables.
-
-6. /usr/bin/mysql_install_db
- # run the script you just edited to install your new grant tables.
-
-7. mysqladmin -u root password (new_password)
- # change the root MySQL password, or else anyone on localhost can
-login to MySQL as root and make changes. You can skip this step if you want
-keystone to connect as root with no password.
-
-8. mysqladmin -u (webserver_user_name) password (new_password)
- # change the password of the $sys_dbuser. Note that you will need
-to change the password in the keystone.conf file as well in $sys_dbpasswd,
-and if your permissions are set up incorrectly anybody can type the URL to
-your keystone.conf file and get the password. Not that this will help them
-much if your permissions are set to @localhost.
-
-
-
-Method #2: easier, but a pain reproducing if you have to delete your grant
-tables. This is the "recommended" method for altering grant tables in
-MySQL. I don't use it because I like the other way :)
-
-shell> mysql --user=root keystone
-
-mysql> GRANT
-SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,DROP,RELOAD,SHUTDOWN,PROCESS,
-FILE,
- ON keystone.*
- TO <$sys_dbuser name>@localhost
- IDENTIFIED BY '(password)'
- WITH GRANT OPTION;
-
-OR
-
-mysql> GRANT ALL PRIVILEGES
- ON keystone.*
- TO <$sys_dbuser name>@localhost
- IDENTIFIED BY '(password)'
- WITH GRANT OPTION;
-
- # this grants the required permissions to the keystone ($sys_dbuser)
-account defined in keystone.conf. However, if you are runnning many
-different MySQL-based apps, as we are, it's generally better to edit the
-mysql_install_db script to be able to quickly reproduce your permissions
-structure again. Note that the FILE privelege and WITH GRANT OPTION may not
-be in your best interest to include.
-
-
-GRANT TABLE FIELDS EXPLANATION:
-Quick syntax summary: "%" in MySQL is a wildcard. I.E., if you are
-defining your DB table and in the 'host' field and enter '%', that means
-that any host can access that database. Of course, that host must also have
-a valid db user in order to do anything useful. 'db'=name of database. In
-our case, it should be "keystone". "user" should be your "$sys_dbuser"
-defined in keystone.conf. Note that you CANNOT add or change a password by
-using the "INSERT INTO db (X)" command -- you must change it with the mysql
--u command as defined above. Passwords are stored encrypted in the MySQL
-database, and if you try to enter it directly into the table they will not
-match.
-
-TABLE: USER. Everything after "password" is a privelege granted (Y/N).
-This table controls individual user global access rights.
-
-'host','user','password','select','insert','update','delete','index','alter'
-,'create','drop','grant','reload','shutdown','process','file'
-
-TABLE: DB. This controls access of USERS to databases.
-
-'host','db','user','select','insert','update','delete','index','alter','crea
-te','drop','grant'
-
-TABLE: HOST. This controls which HOSTS are allowed what global access
-rights. Note that the HOST table, USER table, and DB table are very closely
-connected -- if an authorized USER attempts an SQL request from an
-unauthorized HOST, she's denied. If a request from an authorized HOST is
-not an authorized USER, it is denied. If a globally authorized USER does
-not have rights to a certain DB, she's denied. Get the picture?
-
-'host','db','select','insert','update','delete','index','alter','create','dr
-op','grant'
-
-
-You should now have a working knowledge of MySQL grant tables. If there is
-anything I've left out of this answer that you feel is pertinent, or if my
-instructions don't work for you, please let me know and I'll re-post this
-letter again, corrected. I threw it together one night out of exasperation
-for all the newbies who don't know squat about MySQL yet, so it is almost
-guaranteed to have errors.
-
-Once again, you can't go wrong by reading section 6 of the MySQL manual. It
-is more detailed than I!
-http://www.mysql.com/Manual/manual.html.
-
-
From matt_barnson@singletrac.com Wed Jul 7 09:00:07 1999
+ Date: Mon, 1 Mar 1999 21:37:04 -0700 From: Matthew Barnson
+ matt_barnson@singletrac.com To: keystone-users@homeport.org Subject:
+ [keystone-users] Grant Tables FAQ [The following text is in the
+ "iso-8859-1" character set] [Your display is set for the "US-ASCII"
+ character set] [Some characters may be displayed incorrectly] Maybe we
+ can include this rambling message in the Keystone FAQ? It gets asked a
+ lot, and the only option current listed in the FAQ is
+ "--skip-grant-tables". Really, you can't go wrong by reading section 6 of
+ the MySQL manual, at http://www.mysql.com/Manual/manual.html. I am sure
+ their description is better than mine. MySQL runs fine without
+ permissions set up correctly if you run the mysql daemon with the
+ "--skip-grant-tables" option. Running this way denies access to nobody.
+ Unfortunately, unless you've got yourself firewalled it also opens the
+ potential for abuse if someone knows you're running it. Additionally, the
+ default permissions for MySQL allow anyone at localhost access to the
+ database if the database name begins with "test_" or is named "test"
+ (i.e. "test_keystone"). You can change the name of your database in the
+ keystone.conf file ($sys_dbname). This is the way I am doing it for some
+ of my databases, and it works fine. The methods described below assume
+ you're running MySQL on the same box as your webserver, and that you
+ don't mind if your $sys_dbuser for Keystone has superuser access. See
+ near the bottom of this message for a description of what each field
+ does. Method #1: 1. cd /var/lib #location where you'll want to run
+ /usr/bin/mysql_install_db shell script from to get it to work. 2. ln -s
+ mysql data # soft links the "mysql" directory to "data", which is what
+ mysql_install_db expects. Alternately, you can edit mysql_install_db and
+ change all the "./data" references to "./mysql". 3. Edit
+ /usr/bin/mysql_install_db with your favorite text editor (vi, emacs, jot,
+ pico, etc.) A) Copy the "INSERT INTO db VALUES
+ ('%','test\_%','','Y','Y','Y','Y','Y','Y');" and paste it immediately
+ after itself. Chage the 'test\_%' value to 'keystone', or the value of
+ $sys_dbname in keystone.conf. B) If you are running your keystone
+ database with any user, you'll need to copy the "INSERT INTO user VALUES
+ ('localhost','root','','Y','Y','Y','Y','Y','Y','Y','Y','Y','Y');" line
+ after itself and change 'root' to the name of the keystone database user
+ ($sys_dbuser) in keystone.conf. # adds entries to the script to create
+ grant tables for specific hosts and users. The user you set up has
+ super-user access ($sys_dbuser) -- you may or may not want this. The
+ layout of mysql_install_db is really very uncomplicated. 4.
+ /usr/bin/mysqladmin shutdown # ya gotta shut it down before you can
+ reinstall the grant tables! 5. rm -i /var/lib/mysql/mysql/*.IS?' and
+ answer 'Y' to the deletion questions. # nuke your current grant tables.
+ This WILL NOT delete any other databases than your grant tables. 6.
+ /usr/bin/mysql_install_db # run the script you just edited to install
+ your new grant tables. 7. mysqladmin -u root password (new_password) #
+ change the root MySQL password, or else anyone on localhost can login to
+ MySQL as root and make changes. You can skip this step if you want
+ keystone to connect as root with no password. 8. mysqladmin -u
+ (webserver_user_name) password (new_password) # change the password of
+ the $sys_dbuser. Note that you will need to change the password in the
+ keystone.conf file as well in $sys_dbpasswd, and if your permissions are
+ set up incorrectly anybody can type the URL to your keystone.conf file
+ and get the password. Not that this will help them much if your
+ permissions are set to @localhost. Method #2: easier, but a pain
+ reproducing if you have to delete your grant tables. This is the
+ "recommended" method for altering grant tables in MySQL. I don't use it
+ because I like the other way :) shell> mysql --user=root keystone
+ mysql> GRANT
+ SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,DROP,RELOAD,SHUTDOWN,PROCESS,
+ FILE, ON keystone.* TO <$sys_dbuser name>@localhost IDENTIFIED BY
+ '(password)' WITH GRANT OPTION; OR mysql> GRANT ALL PRIVILEGES ON
+ keystone.* TO <$sys_dbuser name>@localhost IDENTIFIED BY
+ '(password)' WITH GRANT OPTION; # this grants the required permissions to
+ the keystone ($sys_dbuser) account defined in keystone.conf. However, if
+ you are runnning many different MySQL-based apps, as we are, it's
+ generally better to edit the mysql_install_db script to be able to
+ quickly reproduce your permissions structure again. Note that the FILE
+ privelege and WITH GRANT OPTION may not be in your best interest to
+ include. GRANT TABLE FIELDS EXPLANATION: Quick syntax summary: "%" in
+ MySQL is a wildcard. I.E., if you are defining your DB table and in the
+ 'host' field and enter '%', that means that any host can access that
+ database. Of course, that host must also have a valid db user in order to
+ do anything useful. 'db'=name of database. In our case, it should be
+ "keystone". "user" should be your "$sys_dbuser" defined in keystone.conf.
+ Note that you CANNOT add or change a password by using the "INSERT INTO
+ db (X)" command -- you must change it with the mysql -u command as
+ defined above. Passwords are stored encrypted in the MySQL database, and
+ if you try to enter it directly into the table they will not match.
+ TABLE: USER. Everything after "password" is a privelege granted (Y/N).
+ This table controls individual user global access rights.
+ 'host','user','password','select','insert','update','delete','index','alter'
+ ,'create','drop','grant','reload','shutdown','process','file' TABLE: DB.
+ This controls access of USERS to databases.
+ 'host','db','user','select','insert','update','delete','index','alter','crea
+ te','drop','grant' TABLE: HOST. This controls which HOSTS are allowed
+ what global access rights. Note that the HOST table, USER table, and DB
+ table are very closely connected -- if an authorized USER attempts an SQL
+ request from an unauthorized HOST, she's denied. If a request from an
+ authorized HOST is not an authorized USER, it is denied. If a globally
+ authorized USER does not have rights to a certain DB, she's denied. Get
+ the picture?
+ 'host','db','select','insert','update','delete','index','alter','create','dr
+ op','grant' You should now have a working knowledge of MySQL grant
+ tables. If there is anything I've left out of this answer that you feel
+ is pertinent, or if my instructions don't work for you, please let me
+ know and I'll re-post this letter again, corrected. I threw it together
+ one night out of exasperation for all the newbies who don't know squat
+ about MySQL yet, so it is almost guaranteed to have errors. Once again,
+ you can't go wrong by reading section 6 of the MySQL manual. It is more
+ detailed than I! http://www.mysql.com/Manual/manual.html.
PrevChapter 2. Using BugzillaChapter 3. Using Bugzilla
This section contains information for end-users of Bugzilla.
- If you are administering a Bugzilla installation, please consult the
- Installing and Administering Bugzilla portions of this Guide.
-
Landfill,
+ which you are welcome to play with. However, it does not necessarily
+ have all Bugzilla features enabled, and often runs cutting-edge versions
+ of Bugzilla for testing, so some things may work slightly differently
+ than mentioned here.
Click the Click the
+ "Open a new Bugzilla account" link, enter your
- email address and, optionally, your name in the spaces provided,
- then click
+
+ link, enter your email address and, optionally, your name in the
+ spaces provided, then click
+ "Create Account".
-
+
+ .
Within moments, you should receive an email to the address
- you provided above, which contains your login name
- (generally the same as the email address), and a password
- you can use to access your account. This password is
- randomly generated, and can be changed to something more memorable.
-
Within moments, you should receive an email to the address
+ you provided above, which contains your login name (generally the
+ same as the email address), and a password you can use to access
+ your account. This password is randomly generated, and can be
+ changed to something more memorable.
Click the Click the
+ "Log In" link in the yellow area at
- the bottom of the page in your browser, enter your
- email address and password into the spaces provided, and click
-
+ link in the yellow area at the bottom of the page in your browser,
+ enter your email address and password into the spaces provided, and
+ click
+ "Login".
-
You are now logged in. Bugzilla uses cookies for authentication, so
- (unless your IP address changes) you should not have to log in again.
-
You are now logged in. Bugzilla uses cookies for authentication,
+ so (unless your IP address changes) you should not have to log in
+ again.
Bug 1 on Landfill
+
+ is a good example. Note that the labels for most fields are hyperlinks;
+ clicking them will take you to context-sensitive help on that
+ particular field.
Product and Component:
- Bugs are divided up by Product and Component, with a Product having one
- or more Components in it. For example, bugzilla.mozilla.org's
- "Bugzilla" Product is composed of several Components:
-
+
+ : Bugs are divided up by Product and Component, with a Product
+ having one or more Components in it. For example,
+ bugzilla.mozilla.org's "Bugzilla" Product is composed of several
+ Components:
+
Administration,
- Administration of a bugzilla installation, including
- editcomponents.cgi,
- editgroups.cgi,
- editkeywords.cgi,
- editparams.cgi,
- editproducts.cgi,
- editusers.cgi,
- editversions.cgi, and
- sanitycheck.cgi.
-
Administration:
+ Administration of a Bugzilla installation.
Bugzilla-General,
+>
Bugzilla-General:
Anything that doesn't fit in the other components, or spans
- multiple components.
-
Creating/Changing Bugs,
- Creating, changing, and viewing bugs.
- enter_bug.cgi,
- post_bug.cgi,
- show_bug.cgi and
- process_bug.cgi.
-
Creating/Changing Bugs:
+ Creating, changing, and viewing bugs.
Documentation,
- The bugzilla documentation, including anything in the
- docs/ directory and The Bugzilla Guide
-
-
Documentation:
+ The Bugzilla documentation, including The Bugzilla Guide.
Email,
- Anything to do with email sent by Bugzilla.
- processmail
-
Email:
+ Anything to do with email sent by Bugzilla.
Installation,
- The installation process of Bugzilla. This includes
- checksetup.pl and whatever else it evolves into.
-
Installation:
+ The installation process of Bugzilla.
Query/Buglist,
- Anything to do with searching for bugs and viewing the buglists.
- query.cgi and
- buglist.cgi
-
Query/Buglist:
+ Anything to do with searching for bugs and viewing the
+ buglists.
Reporting/Charting,
- Getting reports from Bugzilla.
- reports.cgi and
- duplicates.cgi
-
Reporting/Charting:
+ Getting reports from Bugzilla.
User Accounts,
+>
User Accounts:
Anything about managing a user account from the user's perspective.
- userprefs.cgi, saved queries, creating accounts,
- changing passwords, logging in, etc.
-
User Interface,
+>
User Interface:
General issues having to do with the user interface cosmetics (not
- functionality) including cosmetic issues, HTML templates, etc.
-
-
Status and Resolution:
- A bug passes through several Statuses in its lifetime, and ends up in the
- RESOLVED status, with one of a set of Resolutions (e.g. FIXED, INVALID.)
- The different possible
- values for Status and Resolution on your installation will be documented
- in the context-sensitive help for those items.
-
Status and Resolution:
+
+ These define exactly what state the bug is in - from not even
+ being confirmed as a bug, through to being fixed and the fix
+ confirmed by Quality Assurance. The different possible values for
+ Status and Resolution on your installation should be documented in the
+ context-sensitive help for those items.
Assigned To:
- The person responsible for fixing the bug.
-
Assigned To:
+ The person responsible for fixing the bug.
URL:
- A URL associated with the bug, if any.
-
URL:
+ A URL associated with the bug, if any.
Summary:
- A one-sentence summary of the problem.
-
Summary:
+ A one-sentence summary of the problem.
Status Whiteboard: (a.k.a. Whiteboard) A
- free-form text area for adding short notes and tags to a bug.
-
Status Whiteboard:
+ (a.k.a. Whiteboard) A free-form text area for adding short notes
+ and tags to a bug.
Keywords:
- The administrator can define keywords which you can use to tag and
- categorise bugs - e.g. The Mozilla Project has keywords like crash
- and regression.
-
Keywords:
+ The administrator can define keywords which you can use to tag and
+ categorise bugs - e.g. The Mozilla Project has keywords like crash
+ and regression.
Platform and OS:
- These indicate the computing environment where the bug was found.
-
Platform and OS:
+ These indicate the computing environment where the bug was
+ found.
Version:
- The "Version" field is usually used for versions of a product which have
- been released, and is set to indicate which versions of a Component
- have the particular problem the bug report is about.
-
Version:
+ The "Version" field is usually used for versions of a product which
+ have been released, and is set to indicate which versions of a
+ Component have the particular problem the bug report is
+ about.
Priority:
- The bug assignee uses this field to prioritise his or her bugs. It's
- a good idea not to change this on other people's bugs.
-
Priority:
+ The bug assignee uses this field to prioritise his or her bugs.
+ It's a good idea not to change this on other people's bugs.
Severity:
- This indicates how severe the problem is - from blocker ("application
- unusable") to trivial ("minor cosmetic issue"). You can also use this
- field to indicate whether a bug is an enhancement request.
-
Severity:
+ This indicates how severe the problem is - from blocker
+ ("application unusable") to trivial ("minor cosmetic issue"). You
+ can also use this field to indicate whether a bug is an enhancement
+ request.
Target:
- (a.k.a. Target Milestone) A future version by which the bug is to be
- fixed. e.g. The Bugzilla Project's milestones for future
- Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are
- not restricted to numbers, thought - you can use any text strings,
- such as dates.
-
Target:
+ (a.k.a. Target Milestone) A future version by which the bug is to
+ be fixed. e.g. The Bugzilla Project's milestones for future
+ Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not
+ restricted to numbers, thought - you can use any text strings, such
+ as dates.
Reporter:
- The person who filed the bug.
-
Reporter:
+ The person who filed the bug.
CC list:
- A list of people who get mail when the bug changes.
-
CC list:
+ A list of people who get mail when the bug changes.
Attachments:
- You can attach files (e.g. testcases or patches) to bugs. If there are
- any attachments, they are listed in this section.
-
Attachments:
+ You can attach files (e.g. testcases or patches) to bugs. If there
+ are any attachments, they are listed in this section.
Dependencies:
- If this bug cannot be fixed unless other bugs are fixed (depends on), or
- this bug stops other bugs being fixed (blocks), their numbers are
- recorded here.
-
Dependencies:
+ If this bug cannot be fixed unless other bugs are fixed (depends
+ on), or this bug stops other bugs being fixed (blocks), their
+ numbers are recorded here.
Votes:
- Whether this bug has any votes.
-
Votes:
+ Whether this bug has any votes.
Additional Comments:
- You can add your two cents to the bug discussion here, if you have
- something worthwhile to say.
-
Additional Comments:
+ You can add your two cents to the bug discussion here, if you have
+ something worthwhile to say.
The Search page has controls for selecting different possible values
- for all of the fields in a bug, as described above. Once you've defined
- a search, you can either run it, or save it as a Remembered Query, which
- can optionally appear in the footer of your pages.
-
The Search page has controls for selecting different possible
+ values for all of the fields in a bug, as described above. Once you've
+ defined a search, you can either run it, or save it as a Remembered
+ Query, which can optionally appear in the footer of your pages.
If you run a search, a list of matching bugs will be returned.
- The default search is to return all open bugs on the system -
- don't try running this search on a Bugzilla installation with
- a lot of bugs!
-
If you run a search, a list of matching bugs will be returned.
+ The default search is to return all open bugs on the system - don't try
+ running this search on a Bugzilla installation with a lot of
+ bugs!
The format of the list is configurable. For example, it can be
- sorted by clicking the column headings. Other useful features
- can be accessed using the links at the bottom of the list:
-
The format of the list is configurable. For example, it can be
+ sorted by clicking the column headings. Other useful features can be
+ accessed using the links at the bottom of the list:
+
Long Format: this gives you a large page
- with a non-editable summary of the fields of each bug.
Long Format:
+
+ this gives you a large page with a non-editable summary of the fields
+ of each bug.
Change Columns: change the bug
- attributes which appear in the list.
Change Columns:
+
+ change the bug attributes which appear in the list.
Change several bugs at once: If
- your account is sufficiently empowered, you can make the same
- change to all the bugs in the list - for example, changing their
- owner.
Change several bugs at once:
+
+ If your account is sufficiently empowered, you can make the same
+ change to all the bugs in the list - for example, changing their
+ owner.
Send mail to bug owners: Sends mail
- to the owners of all bugs on the list.
Send mail to bug owners:
+
+ Sends mail to the owners of all bugs on the list.
Edit this query: If you didn't
- get exactly the results you were looking for, you can
- return to the Query page through this link and make small
- revisions to the query you just made so you get more
- accurate results.
Edit this query:
+
+ If you didn't get exactly the results you were looking for, you can
+ return to the Query page through this link and make small revisions
+ to the query you just made so you get more accurate results.
And all this time, I thought we were taking bugs out...
3.1.5. Filing Bugs
Years of bug writing experience has been distilled for your reading
- pleasure into the Years of bug writing experience has been distilled for your
+ reading pleasure into the
+
Bug Writing Guidelines.
-While some of the advice is Mozilla-specific, the basic principles of reporting Reproducible, Specific bugs, isolating the Product you are using, the Version of the Product, the Component which failed, the Hardware Platform, and Operating System you were using at the time of the failure go a long way toward ensuring accurate, responsible fixes for the bug that bit you.
-
Bug Writing Guidelines
+
+ . While some of the advice is Mozilla-specific, the basic principles of
+ reporting Reproducible, Specific bugs, isolating the Product you are
+ using, the Version of the Product, the Component which failed, the
+ Hardware Platform, and Operating System you were using at the time of
+ the failure go a long way toward ensuring accurate, responsible fixes
+ for the bug that bit you.
The procedure for filing a test bug is as follows:
-
The procedure for filing a test bug is as follows:
Fill in the fields.
- Bugzilla should have made reasonable guesses, based upon
- your browser, for the "Platform" and "OS" drop-down
- boxes. If they are wrong, change them.
-
Fill in the fields. Bugzilla should have made reasonable
+ guesses, based upon your browser, for the "Platform" and "OS"
+ drop-down boxes. If they are wrong, change them.
Indiana, it feels like we walking on fortune cookies!
These ain't fortune cookies, kid...
3.2. User Preferences
Customized User Preferences offer tremendous versatility to your
- individual Bugzilla experience. Let's plunge into what you can
- do! The first step is to click the "Edit prefs" link at the
- footer of each page once you have logged in to Landfill.
-
Once you have logged in, you can customise various aspects of
+ Bugzilla via the "Edit prefs" link in the page footer.
+ The preferences are split into four tabs:
On this page, you can change your basic Account Settings,
- including your password and full name. For security reasons,
- in order to change anything on this page you must type your
- On this tab, you can change your basic account information,
+ including your password, email address and real name. For security
+ reasons, in order to change anything on this page you must type your
+ current password into the "Old
- Password" field. If you wish to change your
- password, type the new password you want into the
+ password into the
+ "New
- Password" field and again into the "Re-enter
- new password" field to ensure you typed your new
- password correctly. Select the "Submit" button
- and you are done.
-
"Password"
+ field at the top of the page.
+ If you attempt to change your email address, a confirmation
+ email is sent to both the old and new addresses, with a link to use to
+ confirm the change. This helps to prevent account hijacking.
Here you can reduce or increase the amount of email sent you
- from Bugzilla. Although this is referred to as
- "Advanced Email Filtering Options", they are,
- in fact, the standard email filter set. All of them are
- self-explanatory, but you can use the filters in interesting
- ways. For instance, some people (notably Quality Assurance
- personnel) often only care to receive updates regarding a
- bug when the bug changes state, so they can track bugs on
- their flow charts and know when it is time to pull the bug
- onto a quality assurance platform for inspection. Other
- people set up email gateways to
- Bonsai, the Mozilla automated CVS management system or Tinderbox, the Mozilla automated build management system, and
- restrict which types of Bugzilla information are fed to
- these systems..
-
On this tab you can reduce or increase the amount of email sent
+ you from Bugzilla, opting in our out depending on your relationship to
+ the bug and the change that was made to it. (Note that you can also do
+ client-side filtering using the X-Bugzilla-Reason header which Bugzilla
+ adds to all bugmail.)
By entering user email names, delineated by commas, into the
+ "Users to watch" text entry box you can receive a copy of all the
+ bugmail of other users (security settings permitting.) This powerful
+ functionality enables seamless transitions as developers change
+ projects, managers wish to get in touch with the issues faced by their
+ direct reports, or users go on vacation.
This option may not be available in all Bugzilla
- installations, depending upon the preferences of the
- systems administrator responsible for the setup of your
- Bugzilla. However, if you really want this functionality,
- ask her to "enable newemailtech in Params" and "make it
- the default for all new users", referring her to the
- Administration section of this Guide.
-
The ability to watch other users may not be available in all
+ Bugzilla installations. If you can't see it, ask your
+ administrator.
Disregard the warnings about "experimental and bleeding
- edge"; the code to handle email in a cleaner manner than
- that historically used for Bugzilla is quite robust and
- well-tested now.
-
I recommend you enable the option, "Click here to sign up
- (and risk any bugs)". Your email-box will thank you for it.
- The fundamental shift in "newemailtech" is away from
- standard UNIX "diff" output, which is quite ugly, to a
- prettier, better laid-out email.
-
This option may not be available in all Bugzilla
- installations, depending upon the preferences of the
- systems administrator responsible for the setup of your
- Bugzilla. However, if you really want this functionality,
- ask her to "enable watchers in Params".
-
By entering user email names into the "Users to watch" text
- entry box, delineated by commas, you can watch bugs of other
- users. This powerful functionality enables seamless
- transitions as developers change projects, managers wish to
- get in touch with the issues faced by their direct reports,
- or users go on vacation. If any of these three situations
- apply to you, you will undoubtedly find this feature quite
- convenient.
-
By default, this page is quite barren. However, go explore
- the Query Page some more; you will find that you can store
- numerous queries on the server, so if you regularly run a
- particular query it is just a drop-down menu away. On this
- page of Preferences, if you have many stored queries you can
- elect to have them always one-click away!
-
If you have many stored queries on the server, here you will
- find individual drop-downs for each stored query. Each
- drop-down gives you the option of that query appearing on the
- footer of every page in Bugzilla! This gives you powerful
- one-click access to any complex searches you may set up, and
- is an excellent way to impress your boss...
-
By default, the "My Bugs" link appears at the bottom of
- each page. However, this query gives you both the bugs you
- have reported, as well as those you are assigned. One of
- the most common uses for this page is to remove the "My
- Bugs" link, replacing it with two other queries, commonly
- called "My Bug Reports" and "My Bugs" (but only referencing
- bugs assigned to you). This allows you to distinguish those
- bugs you have reported from those you are assigned. I
- commonly set up complex Boolean queries in the Query page
- and link them to my footer in this page. When they are
- significantly complex, a one-click reference can save hours
- of work.
On the Search page, you can store queries in Bugzilla, so if you
+ regularly run a particular query it is just a drop-down menu away.
+ Once you have a stored query, you can come
+ here to request that it also be displayed in your page footer.
This is a purely informative page which outlines your current
- permissions on this installation of Bugzilla. If you have
- permissions to grant certain permissions to other users, the
- "other users" link appears on this page as well as the footer.
- For more information regarding user administration, please
- consult the Administration section of this Guide.
-
This is a purely informative page which outlines your current
+ permissions on this installation of Bugzilla - what product groups you
+ are in, and whether you can edit bugs or perform various administration
+ functions.
These installation instructions are presented assuming you are
- installing on a UNIX or completely POSIX-compliant system. If
- you are installing on Microsoft Windows or another oddball
- operating system, please consult the appropriate sections in
- this installation guide for notes on how to be successful.
-
This is the 2.16 version of The Bugzilla Guide. If you are
+>
This is the 2.16 version of The Bugzilla Guide. It is so named
+ to match the current version of Bugzilla. If you are
reading this from any source other than those below, please
check one of these mirrors to make sure you are reading an
up-to-date version of the Guide.
@@ -110,15 +111,27 @@ TARGET="_top"
>
There are a lot of common libraries and utilities out there
- that Apple did not include with Mac OS X, but which run
- perfectly well on it. The GD library, which Bugzilla needs to
- do bug graphs, is one of these.
-
There are a lot of common libraries and utilities out there that
+ Apple did not include with Mac OS X, but which run perfectly well on it.
+ The GD library, which Bugzilla needs to do bug graphs, is one of
+ these.
The easiest way to get a lot of these is with a program called
- Fink, which is similar in nature to the CPAN installer, but
- installs common GNU utilities. Fink is available from
- <http://sourceforge.net/projects/fink/>.
-
The easiest way to get a lot of these is with a program called
+ Fink, which is similar in nature to the CPAN installer, but installs
+ common GNU utilities. Fink is available from
+ <http://sourceforge.net/projects/fink/>.
Follow the instructions for setting up Fink. Once it's
- installed, you'll want to run the following as root:
- Follow the instructions for setting up Fink. Once it's installed,
+ you'll want to run the following as root:
+ fink install gd
It will prompt you for a number of dependencies, type 'y' and
- hit enter to install all of the dependencies. Then watch it
- work.
-
It will prompt you for a number of dependencies, type 'y' and hit
+ enter to install all of the dependencies. Then watch it work.
To prevent creating conflicts with the software that Apple
- installs by default, Fink creates its own directory tree at
- /sw where it installs most of the software that it installs.
- This means your libraries and headers for libgd will be at
- /sw/lib and /sw/include instead of /usr/lib and
- /usr/local/include. Because of these changed locations for
- the libraries, the Perl GD module will not install directly
- via CPAN (it looks for the specific paths instead of getting
- them from your environment). But there's a way around that
- :-)
-
To prevent creating conflicts with the software that Apple installs
+ by default, Fink creates its own directory tree at /sw where it installs
+ most of the software that it installs. This means your libraries and
+ headers for libgd will be at /sw/lib and /sw/include instead of /usr/lib
+ and /usr/local/include. Because of these changed locations for the
+ libraries, the Perl GD module will not install directly via CPAN (it
+ looks for the specific paths instead of getting them from your
+ environment). But there's a way around that :-)
Instead of typing Instead of typing
+ "install GD" at the
-
+ at the
+ cpan> prompt, type
+ prompt, type
+ look
- GD. This should go through the motions of
- downloading the latest version of the GD module, then it will
- open a shell and drop you into the build directory. Apply the
- following patch to the Makefile.PL file (save the patch into a
- file and use the command look GD.
+ This should go through the motions of downloading the latest version of
+ the GD module, then it will open a shell and drop you into the build
+ directory. Apply this patch
+ to the Makefile.PL file (save the
+ patch into a file and use the command
+ patch <
- patchfile:
+>patch < patchfile.
-
---- GD-1.33/Makefile.PL Fri Aug 4 16:59:22 2000
-+++ GD-1.33-darwin/Makefile.PL Tue Jun 26 01:29:32 2001
-@@ -3,8 +3,8 @@
- warn "NOTICE: This module requires libgd 1.8.3 or higher (shared library version 4.X).\n";
-
- # =====> PATHS: CHECK AND ADJUST <=====
--my @INC = qw(-I/usr/local/include -I/usr/local/include/gd);
--my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/usr/local/lib );
-+my @INC = qw(-I/sw/include -I/sw/include/gd -I/usr/local/include -I/usr/local/include/gd);
-+my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/sw/lib -L/usr/local/lib);
- my @LIBS = qw(-lgd -lpng -lz);
-
- # FEATURE FLAGS
-@@ -23,7 +23,7 @@
-
- push @LIBS,'-lttf' if $TTF;
- push @LIBS,'-ljpeg' if $JPEG;
--push @LIBS, '-lm' unless $^O eq 'MSWin32';
-+push @LIBS, '-lm' unless ($^O =~ /^MSWin32|darwin$/);
-
- # FreeBSD 3.3 with libgd built from ports croaks if -lXpm is specified
- if ($^O ne 'freebsd' && $^O ne 'MSWin32') {
-
-
-
-
Then, run these commands to finish the installation of the perl module:
-
Then, run these commands to finish the installation of the GD
+ module:
+
perl Makefile.PL
+
make
+
make test
+
make install
+
And don't forget to run And don't forget to run
+ exit to get back to cpan.
After installation, follow the checklist below to help ensure
- that you have a successful installation. If you do not see a
- recommended setting for a parameter, consider leaving it at the
- default while you perform your initial tests on your Bugzilla
- setup.
-
After installation, follow the checklist below.
+ If you do not see a recommended
+ setting for a parameter, consider leaving it at the default while you
+ perform your initial tests on your Bugzilla setup.
Bring up editparams.cgi in your web
- browser. This should be available as the "edit
- parameters" link from any Bugzilla screen once you
- have logged in.
-
Log in to Bugzilla using the username and password
+ you defined for the administrator during installation.
The "maintainer" is the email address of
- the person responsible for maintaining this Bugzilla
- installation. The maintainer need not be a valid Bugzilla
- user. Error pages, error emails, and administrative mail
- will be sent with the maintainer as the return email
- address.
Bring up
+ editparams.cgi
+ in your web browser (link in footer.) This screen allows you
+ to change most of Bugzilla's operating parameters. Each comes
+ with an explanation, and you should go down the list, deciding
+ on what you want to do about each.
+
Set "maintainer" to your email address.
- This allows Bugzilla's error messages to display your email
- address and allow people to contact you for help.
-
+ maintainer:
+ The maintainer parameter is the email address of the person
+ responsible for maintaining this
+ Bugzilla installation. The address need not be that of a valid Bugzilla
+ account.
The "urlbase" parameter defines the fully
- qualified domain name and web server path to your Bugzilla
- installation.
urlbase:
+ This parameter defines the fully qualified domain name and web
+ server path to your Bugzilla installation.
For example, if your bugzilla query page is
- http://www.foo.com/bugzilla/query.cgi, set your
- For example, if your Bugzilla query page is
+ http://www.foo.com/bugzilla/query.cgi,
+ set your "urlbase" is http://www.foo.com/bugzilla/.
-
+ to http://www.foo.com/bugzilla/.
"usebuggroups" dictates whether or not to
- implement group-based security for Bugzilla. If set,
- Bugzilla bugs can have an associated groupmask defining
- which groups of users are allowed to see and edit the
- bug.
Set "usebuggroups" to "on" usebuggroups:
+ Thisdictates whether or not to implement group-based security for
+ Bugzilla. If set, Bugzilla bugs can have an associated 'group',
+ defining which users are allowed to see and edit the
+ bug.
Set "usebuggroups" to "on"
+ only if you
- may wish to restrict access to products. I suggest leaving
- this parameter
+ if you may wish to restrict access to particular bugs to certain
+ groups of users. I suggest leaving
+ this parameter off while initially
- testing your Bugzilla.
-
+ while initially testing your Bugzilla.
"usebuggroupsentry", when set to
- usebuggroupsentry:
+ When set to "on", requires that all bugs have an associated
- groupmask when submitted. This parameter is made for those
- installations where product isolation is a necessity.
-
Set "usebuggroupsentry" to "on" if you absolutely need to
- restrict access to bugs from the moment they are submitted
- through resolution. Once again, if you are simply testing
- your installation, I suggest against turning this parameter
- on; the strict security checking may stop you from being
- able to modify your new entries.
-
, this
+ puts all bugs be placed in the group for their product immediately
+ after creation.
You run into an interesting problem when Bugzilla reaches a
- high level of continuous activity. MySQL supports only
- table-level write locking. What this means is that if
- someone needs to make a change to a bug, they will lock the
- entire table until the operation is complete. Locking for
- write also blocks reads until the write is complete. The
- shadowdb:
+ You run into an interesting problem when Bugzilla reaches a
+ high level of continuous activity. MySQL supports only table-level
+ write locking. What this means is that if someone needs to make a
+ change to a bug, they will lock the entire table until the operation
+ is complete. Locking for write also blocks reads until the write is
+ complete. The
+ "shadowdb" parameter was designed to get around
- this limitation. While only a single user is allowed to
- write to a table at a time, reads can continue unimpeded on
- a read-only shadow copy of the database. Although your
- database size will double, a shadow database can cause an
- enormous performance improvement when implemented on
- extremely high-traffic Bugzilla databases.
-
Set "shadowdb" to "bug_shadowdb" if you will be running a
- *very* large installation of Bugzilla. The shadow database
- enables many simultaneous users to read and write to the
- database without interfering with one another.
-
+ parameter was designed to get around this limitation. While only a
+ single user is allowed to write to a table at a time, reads can
+ continue unimpeded on a read-only shadow copy of the database.
+ Although your database size will double, a shadow database can cause
+ an enormous performance improvement when implemented on extremely
+ high-traffic Bugzilla databases.
As a guide, mozilla.org began needing
+ "shadowdb"
+ when they reached around 40,000 Bugzilla users with several hundred
+ Bugzilla bug changes and comments per day.
The value of the parameter defines the name of the
+ shadow bug database.
+ Set "shadowdb" to e.g. "bug_shadowdb" if you will be running a
+ *very* large installation of Bugzilla.
+
Enabling "shadowdb" can adversely affect the stability
- of your installation of Bugzilla. You should regularly
- check that your database is in sync. It is often
- advisable to force a shadow database sync nightly via
- Enabling "shadowdb" can adversely affect the stability of
+ your installation of Bugzilla. You should regularly check that your
+ database is in sync. It is often advisable to force a shadow
+ database sync nightly via
+ "cron".
-
Once again, in testing you should avoid this option
- -- use it if or when you need to use
- it, and have repeatedly run into the problem it was designed
- to solve -- very long wait times while attempting to commit
- a change to the database. Mozilla.org began needing
- "shadowdb" when they reached around 40,000
- Bugzilla users with several hundred Bugzilla bug changes and
- comments per day.
+>
If you use the "shadowdb" option, it is only natural that
- you should turn the "queryagainstshadowdb" option "On" as
- well. Otherwise you are replicating data into a shadow
- database for no reason!
-
If you use the "shadowdb" option, it is only natural that you
+ should turn the "queryagainstshadowdb" option on as well. Otherwise
+ you are replicating data into a shadow database for no reason!
"headerhtml", "footerhtml",
- "errorhtml", "bannerhtml", and
- "blurbhtml" are all templates which control
- display of headers, footers, errors, banners, and additional
- data. We could go into some detail regarding the usage of
- these, but it is really best just to monkey around with them
- a bit to see what they do. I strongly recommend you copy
- your data/params file somewhere safe
- before playing with these values, though. If they are
- changed dramatically, it may make it impossible for you to
- display Bugzilla pages to fix the problem until you have
- restored your data/params file.
If you have custom logos or HTML you must put in place to
- fit within your site design guidelines, place the code in
- the "headerhtml", "footerhtml", "errorhtml", "bannerhtml",
- or "blurbhtml" text boxes.
-
The "headerhtml" text box is the HTML printed out
- before any other code on the page,
- except the CONTENT-TYPE header sent by the Bugzilla
- engine. If you have a special banner, put the code for
- it in "bannerhtml". You may want to leave these settings
- at the defaults initially.
-
-
shutdownhtml:
+
+ If you need to shut down Bugzilla to perform administration, enter
+ some descriptive HTML here and anyone who tries to use Bugzilla will
+ receive a page to that effect.
+
"passwordmail" is rather simple. Every
- time a user creates an account, the text of this parameter
- is read as the text to send to the new user along with their
- password message.
Add any text you wish to the "passwordmail" parameter box.
- For instance, many people choose to use this box to give a
- quick training blurb about how to use Bugzilla at your site.
-
passwordmail:
+
+ Every time a user creates an account, the text of
+ this parameter (with substitutions) is sent to the new user along with
+ their password message.
Add any text you wish to the "passwordmail" parameter box. For
+ instance, many people choose to use this box to give a quick training
+ blurb about how to use Bugzilla at your site.
"useqacontact" allows you to define an
- email address for each component, in addition to that of the
- default owner, who will be sent carbon copies of incoming
- bugs. The critical difference between a QA Contact and an
- Owner is that the QA Contact follows the component. If you
- reassign a bug from component A to component B, the QA
- Contact for that bug will change with the reassignment,
- regardless of owner.
"usestatuswhiteboard" defines whether you
- wish to have a free-form, overwritable field associated with
- each bug. The advantage of the Status Whiteboard is that it
- can be deleted or modified with ease, and provides an
- easily-searchable field for indexing some bugs that have
- some trait in common. Many people will put "help
- wanted", "stalled", or "waiting
- on reply from somebody" messages into the Status
- Whiteboard field so those who peruse the bugs are aware of
- their status even more than that which can be indicated by
- the Resolution fields.
Do you want to use the QA Contact ("useqacontact") and
- status whiteboard ("usestatuswhiteboard") fields? These
- fields are useful because they allow for more flexibility,
- particularly when you have an existing Quality Assurance
- and/or Release Engineering team, but they may not be needed
- for many smaller installations.
-
useqacontact:
+
+ This allows you to define an email address for each component, in
+ addition
+ to that of the default owner, who will be sent carbon copies of
+ incoming bugs.
Set "whinedays" to the amount of days you want to let bugs
- go in the "New" or "Reopened" state before notifying people
- they have untouched new bugs. If you do not plan to use
- this feature, simply do not set up the whining cron job
- described in the installation instructions, or set this
- value to "0" (never whine).
-
usestatuswhiteboard:
+ This defines whether you wish to have a free-form, overwritable field
+ associated with each bug. The advantage of the Status Whiteboard is
+ that it can be deleted or modified with ease, and provides an
+ easily-searchable field for indexing some bugs that have some trait
+ in common.
+
"commenton" fields allow you to dictate
- what changes can pass without comment, and which must have a
- comment from the person who changed them. Often,
- administrators will allow users to add themselves to the CC
- list, accept bugs, or change the Status Whiteboard without
- adding a comment as to their reasons for the change, yet
- require that most other changes come with an
- explanation.
whinedays:
+ Set this to the number of days you want to let bugs go
+ in the NEW or REOPENED state before notifying people they have
+ untouched new bugs. If you do not plan to use this feature, simply do
+ not set up the whining cron job described in the installation
+ instructions, or set this value to "0" (never whine).
Set the "commenton" options according to your site policy.
- It is a wise idea to require comments when users resolve,
- reassign, or reopen bugs at the very least.
-
commenton*:
+ All these
+ fields allow you to dictate what changes can pass without comment,
+ and which must have a comment from the person who changed them.
+ Often, administrators will allow users to add themselves to the CC
+ list, accept bugs, or change the Status Whiteboard without adding a
+ comment as to their reasons for the change, yet require that most
+ other changes come with an explanation.
Set the "commenton" options according to your site policy. It
+ is a wise idea to require comments when users resolve, reassign, or
+ reopen bugs at the very least.
+
It is generally far better to require a developer
- comment when resolving bugs than not. Few things are
- more annoying to bug database users than having a
- developer mark a bug "fixed" without any comment as to
- what the fix was (or even that it was truly fixed!)
-
It is generally far better to require a developer comment
+ when resolving bugs than not. Few things are more annoying to bug
+ database users than having a developer mark a bug "fixed" without
+ any comment as to what the fix was (or even that it was truly
+ fixed!)
-
The "supportwatchers" option can be an
- exceptionally powerful tool in the hands of a power Bugzilla
- user. By enabling this option, you allow users to receive
- email updates whenever other users receive email updates.
- This is, of course, subject to the groupset restrictions on
- the bug; if the supportwatchers:
+
+ Turning on this option allows users to ask to receive copies of
+ all a particular other user's bug email. This is, of
+ course, subject to the groupset restrictions on the bug; if the
+ "watcher" would not normally be
- allowed to view a bug, the watcher cannot get around the
- system by setting herself up to watch the bugs of someone
- with bugs outside her privileges. She would still only
- receive email updates for those bugs she could normally
- view.
For Bugzilla sites which require strong inter-Product
- security to prevent snooping, watchers are not a good
- idea.
However, for most sites you should set
- "supportwatchers" to "On". This feature is
- helpful for team leads to monitor progress in their
- respective areas, and can offer many other benefits, such as
- allowing a developer to pick up a former engineer's bugs
- without requiring her to change all the information in the
- bug.
-
+ would not normally be allowed to view a bug, the watcher cannot get
+ around the system by setting herself up to watch the bugs of someone
+ with bugs outside her privileges. They would still only receive email
+ updates for those bugs she could normally view.
Product, Component, Milestone, and Version
- AdministrationProduct, Component, Milestone, and Version AdministrationChapter 4. Administering BugzillaChapter 5. Administering Bugzilla
5.3.1. ProductsFormerly, and in some spots still, called
- "Programs"
Products
Products are
- the broadest category in Bugzilla, and you should have the
- least of these. If your company makes computer games, you
- should have one product per game, and possibly a few special
- products (website, meetings...)
-
A Product (formerly called "Program", and still referred to
- that way in some portions of the source code) controls some
- very important functions. The number of "votes" available for
- users to vote for the most important bugs is set per-product,
- as is the number of votes required to move a bug automatically
- from the UNCONFIRMED status to the NEW status. One can close
- a Product for further bug entry and define various Versions
- available from the Edit product screen.
-
+
+ are the broadest category in Bugzilla, and you should have the least of
+ these. If your company makes computer games, you should have one
+ product per game, and possibly a few special products (website,
+ meetings...)
A Product (formerly called "Program", and still referred to that
+ way in some portions of the source code) controls some very important
+ functions. The number of "votes" available for users to vote for the
+ most important bugs is set per-product, as is the number of votes
+ required to move a bug automatically from the UNCONFIRMED status to the
+ NEW status. One can close a Product for further bug entry and define
+ various Versions available from the Edit product screen.
To create a new product:
Select "components" from the yellow footer
-
Select "components" from the yellow footer
It may seem counterintuitive to click "components" when
- you want to edit the properties associated with
- Products. This is one of a long list of things we want
- in Bugzilla 3.0...
-
It may seem counterintuitive to click "components" when you
+ want to edit the properties associated with Products. This is one
+ of a long list of things we want in Bugzilla 3.0...
Select the "Add" link to the right of "Add a new product".
-
Select the "Add" link to the right of "Add a new
+ product".
Enter the name of the product and a description. The
- Description field is free-form.
-
Enter the name of the product and a description. The
+ Description field is free-form.
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.
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
+
+ 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; the
- Owner and QA Contact fields in a bug are otherwise unrelated
- to the Component.
-
+
+ ; the Owner and QA Contact fields in a bug are otherwise unrelated to
+ the Component.
To create a new Component:
-
To create a new Component:
Select the "Edit components" link from the "Edit product"
- page
-
Select the "Edit components" link from the "Edit product"
+ page
Select the "Add" link to the right of the "Add a new
- component" text on the "Select Component" page.
-
Select the "Add" link to the right of the "Add a new
+ component" text on the "Select Component" page.
Fill out the "Component" field, a short "Description", and
- the "Initial Owner". The Component and Description fields
- are free-form; the "Initial Owner" field must be that of a
- user ID already existing in the database. If the initial
- owner does not exist, Bugzilla will refuse to create the
- component.
-
Fill out the "Component" field, a short "Description", and
+ the "Initial Owner". The Component and Description fields are
+ free-form; the "Initial Owner" field must be that of a user ID
+ already existing in the database. If the initial owner does not
+ exist, Bugzilla will refuse to create the component.
+
Is your "Default Owner" a user who is not yet in the
- database? No problem.
-
Is your "Default Owner" a user who is not yet in the
+ database? No problem.
+
Select the "Log out" link on the footer of the
- page.
-
Select the "Log out" link on the footer of the
+ page.
Select the "New Account" link on the footer of
- the "Relogin" page
-
Select the "New Account" link on the footer of the
+ "Relogin" page
Type in the email address of the default owner
- you want to create in the "E-mail address"
- field, and her full name in the "Real name"
- field, then select the "Submit Query" button.
-
Type in the email address of the default owner you want
+ to create in the "E-mail address" field, and her full name in
+ the "Real name" field, then select the "Submit Query"
+ button.
Now select "Log in" again, type in your login
- information, and you can modify the product to
- use the Default Owner information you require.
-
Now select "Log in" again, type in your login
+ information, and you can modify the product to use the
+ Default Owner information you require.
-
-
Either Edit more components or return to the Bugzilla
- Query Page. To return to the Product you were editing, you
- must select the Components link as before.
-
Either Edit more components or return to the Bugzilla Query
+ Page. To return to the Product you were editing, you must select
+ the Components link as before.
Versions are the revisions of the product, such as "Flinders
- 3.1", "Flinders 95", and "Flinders 2000". Using Versions
- helps you isolate code changes and are an aid in reporting.
-
-
Versions are the revisions of the product, such as "Flinders
+ 3.1", "Flinders 95", and "Flinders 2000". Using Versions helps you
+ isolate code changes and are an aid in reporting.
+
From the "Edit product" screen, select "Edit Versions"
-
From the "Edit product" screen, select "Edit Versions"
You will notice that the product already has the default
- version "undefined". If your product doesn't use version
- numbers, you may want to leave this as it is or edit it so
- that it is "---". You can then go back to the edit
- versions page and add new versions to your product.
-
You will notice that the product already has the default
+ version "undefined". If your product doesn't use version numbers,
+ you may want to leave this as it is or edit it so that it is "---".
+ You can then go back to the edit versions page and add new versions
+ to your product.
Otherwise, click the "Add" button to the right of the "Add
- a new version" text.
-
Otherwise, click the "Add" button to the right of the "Add a
+ new version" text.
Enter the name of the Version. This can be free-form
- characters up to the limit of the text box. Then select
- the "Add" button.
-
Enter the name of the Version. This can be free-form
+ characters up to the limit of the text box. Then select the "Add"
+ button.
At this point you can select "Edit" to edit more Versions,
- or return to the "Query" page, from which you can navigate
- back to the product through the "components" link at the
- foot of the Query page.
-
At this point you can select "Edit" to edit more Versions, or
+ return to the "Query" page, from which you can navigate back to the
+ product through the "components" link at the foot of the Query
+ page.
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. Or, you
- have a bug that you plan to fix for 2.8, this would have a
- milestone of 2.8.
-
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. Or, you have a bug that you
+ plan to fix for 2.8, this would have a milestone of 2.8.
Milestone options will only appear for a Product if you
- turned the "usetargetmilestone" field in the "Edit
- Parameters" screen "On".
-
Milestone options will only appear for a Product if you turned
+ the "usetargetmilestone" field in the "Edit Parameters" screen
+ "On".
To create new Milestones, set Default Milestones, and set
- Milestone URL:
-
To create new Milestones, set Default Milestones, and set
+ Milestone URL:
Select "edit milestones"
-
Select "edit milestones"
Select "Add" to the right of the "Add a new milestone"
- text
-
Select "Add" to the right of the "Add a new milestone"
+ text
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. Select "Add".
-
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. Select "Add".
If you want to add more milestones, select the "Edit"
- link. If you don't, well shoot, you have to go back to the
- "query" page and select "components" again, and make your
- way back to the Product you were editing.
-
If you want to add more milestones, select the "Edit" link.
+ If you don't, well shoot, you have to go back to the "query" page
+ and select "components" again, and make your way back to the
+ Product you were editing.
+
This is another in the list of unusual user interface
- decisions that we'd like to get cleaned up. Shouldn't
- there be a link to the effect of "edit the Product I
- was editing when I ended up here"? In any case,
- clicking "components" in the footer takes you back to
- the "Select product" screen, from which you can begin
- editing your product again.
-
This is another in the list of unusual user interface
+ decisions that we'd like to get cleaned up. Shouldn't there be a
+ link to the effect of "edit the Product I was editing when I
+ ended up here"? In any case, clicking "components" in the footer
+ takes you back to the "Select product" screen, from which you can
+ begin editing your product again.
-
From the Edit product screen again (once you've made your
- way back), enter the URL for a description of what your
- milestones are for this product in the "Milestone URL"
- field. It should be of the format
- "http://www.foo.com/bugzilla/product_milestones.html"
-
Some common uses of this field include product
- descriptions, product roadmaps, and of course a simple
- description of the meaning of each milestone.
-
From the Edit product screen again (once you've made your way
+ back), enter the URL for a description of what your milestones are
+ for this product in the "Milestone URL" field. It should be of the
+ format "http://www.foo.com/bugzilla/product_milestones.html"
Some common uses of this field include product descriptions,
+ product roadmaps, and of course a simple description of the meaning
+ of each milestone.
If you're using Target Milestones, the "Default Milestone"
- field must have some kind of entry. If you really don't
- care if people set coherent Target Milestones, simply
- leave this at the default, "---". However, controlling
- and regularly updating the Default Milestone field is a
- powerful tool when reporting the status of projects.
-
If you're using Target Milestones, the "Default Milestone"
+ field must have some kind of entry. If you really don't care if
+ people set coherent Target Milestones, simply leave this at the
+ default, "---". However, controlling and regularly updating the
+ Default Milestone field is a powerful tool when reporting the
+ status of projects.
The concept of "voting" is a poorly understood, yet powerful
- feature for the management of open-source projects. Each user
- is assigned so many Votes per product, which they can freely
- reassign (or assign multiple votes to a single bug). This
- allows developers to gauge user need for a particular
- enhancement or bugfix. By allowing bugs with a certain number
- of votes to automatically move from "UNCONFIRMED" to "NEW",
- users of the bug system can help high-priority bugs garner
- attention so they don't sit for a long time awaiting triage.
-
The daunting challenge of Votes is deciding where you draw the
- line for a "vocal majority". If you only have a user base of
- 100 users, setting a low threshold for bugs to move from
- UNCONFIRMED to NEW makes sense. As the Bugzilla user base
- expands, however, these thresholds must be re-evaluated. You
- should gauge whether this feature is worth the time and close
- monitoring involved, and perhaps forego implementation until
- you have a critical mass of users who demand it.
-
5.3.5. Voting
The concept of "voting" is a poorly understood, yet powerful
+ feature for the management of open-source projects. Each user is
+ assigned so many Votes per product, which they can freely reassign (or
+ assign multiple votes to a single bug). This allows developers to gauge
+ user need for a particular enhancement or bugfix. By allowing bugs with
+ a certain number of votes to automatically move from "UNCONFIRMED" to
+ "NEW", users of the bug system can help high-priority bugs garner
+ attention so they don't sit for a long time awaiting triage.
The daunting challenge of Votes is deciding where you draw the
+ line for a "vocal majority". If you only have a user base of 100 users,
+ setting a low threshold for bugs to move from UNCONFIRMED to NEW makes
+ sense. As the Bugzilla user base expands, however, these thresholds
+ must be re-evaluated. You should gauge whether this feature is worth
+ the time and close monitoring involved, and perhaps forego
+ implementation until you have a critical mass of users who demand
+ it.
To modify Voting settings:
4.3.5. Voting
Navigate to the "Edit product" screen for the Product you
- wish to modify
-
Navigate to the "Edit product" screen for the Product you
+ wish to modify
Set "Maximum Votes per person" to your calculated value.
- Setting this field to "0" disables voting.
-
Set "Maximum Votes per person" to your calculated value.
+ Setting this field to "0" disables voting.
Set "Maximum Votes a person can put on a single bug" to
- your calculated value. It should probably be some number
- lower than the "Maximum votes per person". Setting this
- field to "0" disables voting, but leaves the voting
- options open to the user. This is confusing.
-
Set "Maximum Votes a person can put on a single bug" to your
+ calculated value. It should probably be some number lower than the
+ "Maximum votes per person". Setting this field to "0" disables
+ voting, but leaves the voting options open to the user. This is
+ confusing.
Set "Number of votes a bug in this product needs to
- automatically get out of the UNCONFIRMED state" to your
- calculated number. Setting this field to "0" disables
- the automatic move of bugs from UNCONFIRMED to NEW. Some
- people advocate leaving this at "0", but of what use are
- Votes if your Bugzilla user base is unable to affect which
- bugs appear on Development radar?
-
Set "Number of votes a bug in this product needs to
+ automatically get out of the UNCONFIRMED state" to your calculated
+ number. Setting this field to "0" disables the automatic move of
+ bugs from UNCONFIRMED to NEW. Some people advocate leaving this at
+ "0", but of what use are Votes if your Bugzilla user base is unable
+ to affect which bugs appear on Development radar?
+
You should probably set this number to higher than a
- small coalition of Bugzilla users can influence it.
- Most sites use this as a "referendum" mechanism -- if
- users are able to vote a bug out of UNCONFIRMED, it is
- a You should probably set this number to higher than a small
+ coalition of Bugzilla users can influence it. Most sites use this
+ as a "referendum" mechanism -- if users are able to vote a bug
+ out of UNCONFIRMED, it is a
+ really bad bug!
-
+
+ bad bug!
-
Once you have adjusted the values to your preference,
- select the "Update" button.
-
Once you have adjusted the values to your preference, select
+ the "Update" button.
Groups can be very useful in bugzilla, because they allow
- users to isolate bugs or products that should only be seen by
- certain people. Groups can also be a complicated minefield of
- interdependencies and weirdness if mismanaged.
-
-
Groups can be very useful in bugzilla, because they allow users
+ to isolate bugs or products that should only be seen by certain people.
+ Groups can also be a complicated minefield of interdependencies and
+ weirdness if mismanaged.
+
Groups only work if you enable the "usebuggroups"
- paramater. In addition, if the "usebuggroupsentry" parameter
- is "On", one can restrict access to products by groups, so
- that only members of a product group are able to view bugs
- within that product. Group security in Bugzilla can be divided
- into two categories: Generic and Product-Based.
-
+
+ Groups only work if you enable the "usebuggroups" paramater. In
+ addition, if the "usebuggroupsentry" parameter is "On", one can
+ restrict access to products by groups, so that only members of a
+ product group are able to view bugs within that product. Group security
+ in Bugzilla can be divided into two categories: Generic and
+ Product-Based.
Groups in Bugzilla are a complicated beast that evolved out
- of very simple user permission bitmasks, apparently itself
- derived from common concepts in UNIX access controls. A
- "bitmask" is a fixed-length number whose value can describe
- one, and only one, set of states. For instance, UNIX file
- permissions are assigned bitmask values: "execute" has a
- value of 1, "write" has a value of 2, and "read" has a
- value of 4. Add them together, and a file can be read,
- written to, and executed if it has a bitmask of "7". (This
- is a simplified example -- anybody who knows UNIX security
- knows there is much more to it than this. Please bear with
- me for the purpose of this note.) The only way a bitmask
- scheme can work is by doubling the bit count for each value.
- Thus if UNIX wanted to offer another file permission, the
- next would have to be a value of 8, then the next 16, the
- next 32, etc.
-
Similarly, Bugzilla offers a bitmask to define group
- permissions, with an internal limit of 64. Several are
- already occupied by built-in permissions. The way around
- this limitation is to avoid assigning groups to products if
- you have many products, avoid bloating of group lists, and
- religiously prune irrelevant groups. In reality, most
- installations of Bugzilla support far fewer than 64 groups,
- so this limitation has not hit for most sites, but it is on
- the table to be revised for Bugzilla 3.0 because it
- interferes with the security schemes of some administrators.
-
Groups in Bugzilla are a complicated beast that evolved out of
+ very simple user permission bitmasks, apparently itself derived from
+ common concepts in UNIX access controls. A "bitmask" is a
+ fixed-length number whose value can describe one, and only one, set
+ of states. For instance, UNIX file permissions are assigned bitmask
+ values: "execute" has a value of 1, "write" has a value of 2, and
+ "read" has a value of 4. Add them together, and a file can be read,
+ written to, and executed if it has a bitmask of "7". (This is a
+ simplified example -- anybody who knows UNIX security knows there is
+ much more to it than this. Please bear with me for the purpose of
+ this note.) The only way a bitmask scheme can work is by doubling the
+ bit count for each value. Thus if UNIX wanted to offer another file
+ permission, the next would have to be a value of 8, then the next 16,
+ the next 32, etc.
Similarly, Bugzilla offers a bitmask to define group
+ permissions, with an internal limit of 64. Several are already
+ occupied by built-in permissions. The way around this limitation is
+ to avoid assigning groups to products if you have many products,
+ avoid bloating of group lists, and religiously prune irrelevant
+ groups. In reality, most installations of Bugzilla support far fewer
+ than 64 groups, so this limitation has not hit for most sites, but it
+ is on the table to be revised for Bugzilla 3.0 because it interferes
+ with the security schemes of some administrators.
To enable Generic Group Security ("usebuggroups"):
-
To enable Generic Group Security ("usebuggroups"):
Turn "On" "usebuggroups" in the "Edit Parameters" screen.
-
Turn "On" "usebuggroups" in the "Edit Parameters"
+ screen.
You will generally have no groups set up. Select the
- "groups" link in the footer.
-
You will generally have no groups set up. Select the "groups"
+ link in the footer.
Take a moment to understand the instructions on the "Edit
- Groups" screen. Once you feel confident you understand
- what is expected of you, select the "Add Group" link.
-
Take a moment to understand the instructions on the "Edit
+ Groups" screen. Once you feel confident you understand what is
+ expected of you, select the "Add Group" link.
Fill out the "New Name" (remember, no spaces!), "New
- Description", and "New User RegExp" fields. "New User
- RegExp" allows you to automatically place all users who
- fulfill the Regular Expression into the new group.
-
-
Fill out the "New Name" (remember, no spaces!), "New
+ Description", and "New User RegExp" fields. "New User RegExp"
+ allows you to automatically place all users who fulfill the Regular
+ Expression into the new group.
+
When you have finished, select the Add
- button.
-
+
+ When you have finished, select the Add button.
To enable Product-Based Group Security (usebuggroupsentry):
-
To enable Product-Based Group Security
+ (usebuggroupsentry):
Don't forget that you only have 64 groups masks available,
- total, for your installation of Bugzilla! If you plan on
- having more than 50 products in your individual Bugzilla
- installation, and require group security for your products,
- you should consider either running multiple Bugzillas or
- using Generic Group Security instead of Product-Based
- ("usebuggroupsentry") Group Security.
-
Don't forget that you only have 64 groups masks available,
+ total, for your installation of Bugzilla! If you plan on having more
+ than 50 products in your individual Bugzilla installation, and
+ require group security for your products, you should consider either
+ running multiple Bugzillas or using Generic Group Security instead of
+ Product-Based ("usebuggroupsentry") Group Security.
Turn "On" "usebuggroups" and "usebuggroupsentry" in the
- "Edit Parameters" screen.
-
Turn "On" "usebuggroups" and "usebuggroupsentry" in the "Edit
+ Parameters" screen.
"usebuggroupsentry" has the capacity to prevent the
- administrative user from directly altering bugs because
- of conflicting group permissions. If you plan on using
- "usebuggroupsentry", you should plan on restricting
- administrative account usage to administrative duties
- only. In other words, manage bugs with an unpriveleged
- user account, and manage users, groups, Products, etc.
- with the administrative account.
-
"usebuggroupsentry" has the capacity to prevent the
+ administrative user from directly altering bugs because of
+ conflicting group permissions. If you plan on using
+ "usebuggroupsentry", you should plan on restricting
+ administrative account usage to administrative duties only. In
+ other words, manage bugs with an unpriveleged user account, and
+ manage users, groups, Products, etc. with the administrative
+ account.
You will generally have no Groups set up, unless you
- enabled "usebuggroupsentry" prior to creating any
- Products. To create "Generic Group Security" groups,
- follow the instructions given above. To create
- Product-Based Group security, simply follow the
- instructions for creating a new Product. If you need to
- add users to these new groups as you create them, you will
- find the option to add them to the group available under
- the "Edit User" screens.
-
You will generally have no Groups set up, unless you enabled
+ "usebuggroupsentry" prior to creating any Products. To create
+ "Generic Group Security" groups, follow the instructions given
+ above. To create Product-Based Group security, simply follow the
+ instructions for creating a new Product. If you need to add users
+ to these new groups as you create them, you will find the option to
+ add them to the group available under the "Edit User"
+ screens.
You may find this example illustrative for how bug groups work.
-
You may find this example illustrative for how bug groups work.
+
Apache's Apache's
+ mod_rewrite module lets you do some truly amazing things with URL rewriting. Here are a couple of examples of what you can do.
+
+ module lets you do some truly amazing things with URL rewriting. Here are
+ a couple of examples of what you can do.
Make it so if someone types
- Make it so if someone types
+ http://www.foo.com/12345,
- Bugzilla spits back
- http://www.foo.com/show_bug.cgi?id=12345. Try setting up
- your VirtualHost section for Bugzilla with a rule like
- this:
+
+ , Bugzilla spits back http://www.foo.com/show_bug.cgi?id=12345. Try
+ setting up your VirtualHost section for Bugzilla with a rule like
+ this:
Red Hat Bugzilla is probably the most popular Bugzilla variant
- on the planet. One of the major benefits of Red Hat Bugzilla is
- the ability to work with Oracle, MySQL, and PostGreSQL databases
- serving as the back-end, instead of just MySQL. Dave Lawrence
- has worked very hard to keep Red Hat Bugzilla up-to-date, and
- many people prefer the snappier-looking page layout of Red Hat
- Bugzilla to the default Mozilla-standard formatting.
-
Red Hat Bugzilla is probably the most popular Bugzilla variant on
+ the planet. One of the major benefits of Red Hat Bugzilla is the ability
+ to work with Oracle, MySQL, and PostGreSQL databases serving as the
+ back-end, instead of just MySQL. Dave Lawrence has worked very hard to
+ keep Red Hat Bugzilla up-to-date, and many people prefer the
+ snappier-looking page layout of Red Hat Bugzilla to the default
+ Mozilla-standard formatting.
Integration of Perforce with Bugzilla, once patches are applied,
- is seamless. Perforce replication information will appear below
- the comments of each bug. Be certain you have a matching set of
- patches for the Bugzilla version you are installing. p4dti is
- designed to support multiple defect trackers, and maintains its
- own documentation for it. Please consult the pages linked above
- for further information.
-
Integration of Perforce with Bugzilla, once patches are applied, is
+ seamless. Perforce replication information will appear below the comments
+ of each bug. Be certain you have a matching set of patches for the
+ Bugzilla version you are installing. p4dti is designed to support
+ multiple defect trackers, and maintains its own documentation for it.
+ Please consult the pages linked above for further information.
Putting your money in a wall safe is better protection than
- depending on the fact that no one knows that you hide your
- money in a mayonnaise jar in your fridge.
Poorly-configured MySQL, Bugzilla, and FTP 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.
-
Poorly-configured MySQL, Bugzilla, and FTP 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.
Ensure you are running at least MysQL version 3.22.32 or
- newer. Earlier versions had notable security holes and
- poorly secured default configuration choices.
-
Ensure you are running at least MysQL version 3.22.32 or newer.
+ Earlier versions had notable security holes and poorly secured
+ default configuration choices.
The MySQL Privilege System
+
+ until you can recite it from memory!
At the very least, ensure you password the "mysql -u root"
- account and the "bugs" account, establish grant table
- rights (consult the Keystone guide in Appendix C: The
- Bugzilla Database for some easy-to-use details) that do
- not allow CREATE, DROP, RELOAD, SHUTDOWN, and PROCESS for
- user "bugs". I wrote up the Keystone advice back when I
- knew far less about security than I do now : )
-
At the very least, ensure you password the "mysql -u root"
+ account and the "bugs" account, establish grant table rights (consult
+ the Keystone guide in Appendix C: The Bugzilla Database for some
+ easy-to-use details) that do not allow CREATE, DROP, RELOAD,
+ SHUTDOWN, and PROCESS for user "bugs". I wrote up the Keystone advice
+ back when I knew far less about security than I do now : )
Lock down /etc/inetd.conf. Heck, disable inet entirely on
- this box. It should only listen to port 25 for Sendmail
- and port 80 for Apache.
-
Lock down /etc/inetd.conf. Heck, disable inet entirely on this
+ box. It should only listen to port 25 for Sendmail and port 80 for
+ Apache.
Do not run Apache as Do not run Apache as
+ "nobody". This will
- require very lax permissions in your Bugzilla directories.
- Run it, instead, as a user with a name, set via your
- httpd.conf file.
-
+
+ . This will require very lax permissions in your Bugzilla
+ directories. Run it, instead, as a user with a name, set via your
+ httpd.conf file.
+
"nobody" is a real user on UNIX systems.
- Having a process run as user id
+
+ is a real user on UNIX systems. Having a process run as user id
+ "nobody"
- is absolutely no protection against system crackers
- versus using any other user account. As a general
- security measure, I recommend you create unique user
- ID's for each daemon running on your system and, if
- possible, use "chroot" to jail that process away from
- the rest of your system.
-
-
Ensure you have adequate access controls for the
- $BUGZILLA_HOME/data/ and $BUGZILLA_HOME/shadow/
- directories, as well as the $BUGZILLA_HOME/localconfig and
- $BUGZILLA_HOME/globals.pl files. The localconfig file
- stores your "bugs" user password, which would be terrible
- to have in the hands of a criminal, while the "globals.pl"
- stores some default information regarding your
- installation which could aid a system cracker. In
- addition, some files under $BUGZILLA_HOME/data/ store
- sensitive information, and $BUGZILLA_HOME/shadow/ stores
- bug information for faster retrieval. If you fail to
- secure these directories and this file, you will expose
- bug information to those who may not be allowed to see it.
-
Ensure you have adequate access controls for the
+ $BUGZILLA_HOME/data/ and $BUGZILLA_HOME/shadow/ directories, as well
+ as the $BUGZILLA_HOME/localconfig and $BUGZILLA_HOME/globals.pl
+ files. The localconfig file stores your "bugs" user password, which
+ would be terrible to have in the hands of a criminal, while the
+ "globals.pl" stores some default information regarding your
+ installation which could aid a system cracker. In addition, some
+ files under $BUGZILLA_HOME/data/ store sensitive information, and
+ $BUGZILLA_HOME/shadow/ stores bug information for faster retrieval.
+ If you fail to secure these directories and this file, you will
+ expose bug information to those who may not be allowed to see
+ it.
Bugzilla provides default .htaccess files to protect the
- most common Apache installations. However, you should
- verify these are adequate according to the site-wide
- security policy of your web server, and ensure that the
- .htaccess files are allowed to "override" default
- permissions set in your Apache configuration files.
- Covering Apache security is beyond the scope of this
- Guide; please consult the Apache documentation for
- details.
-
Bugzilla provides default .htaccess files to protect the most
+ common Apache installations. However, you should verify these are
+ adequate according to the site-wide security policy of your web
+ server, and ensure that the .htaccess files are allowed to
+ "override" default permissions set in your Apache configuration
+ files. Covering Apache security is beyond the scope of this Guide;
+ please consult the Apache documentation for details.
http://bugzilla.mozilla.org/localconfig
+
+ ). If you can read the contents of this file, your web server has
+ not secured your bugzilla directory properly and you must fix this
+ problem before deploying Bugzilla. If, however, it gives you a
+ "Forbidden" error, then it probably respects the .htaccess
+ conventions and you are good to go.
When you run checksetup.pl, the script will attempt to modify various
- permissions on files which Bugzilla uses. If you do not have a
- webservergroup set in the localconfig file, then Bugzilla will have to
- make certain files world readable and/or writable. THIS IS
- INSECURE!. This means that anyone who can get access to
- your system can do whatever they want to your Bugzilla installation.
-
When you run checksetup.pl, the script will attempt to modify
+ various permissions on files which Bugzilla uses. If you do not have
+ a webservergroup set in the localconfig file, then Bugzilla will have
+ to make certain files world readable and/or writable.
+ THIS IS INSECURE!
+
+ . This means that anyone who can get access to your system can do
+ whatever they want to your Bugzilla installation.
This also means that if your webserver runs all cgi scripts as the
- same user/group, anyone on the system who can run cgi scripts will
- be able to take control of your Bugzilla installation.
-
This also means that if your webserver runs all cgi scripts
+ as the same user/group, anyone on the system who can run cgi
+ scripts will be able to take control of your Bugzilla
+ installation.
Bug
+ 65572
+
+ for adequate protection in your data/ and shadow/ directories.
Note the instructions which follow are Apache-specific.
- If you use IIS, Netscape, or other non-Apache web servers,
- please consult your system documentation for how to secure
- these files from being transmitted to curious users.
-
Note the instructions which follow are Apache-specific. If you
+ use IIS, Netscape, or other non-Apache web servers, please consult
+ your system documentation for how to secure these files from being
+ transmitted to curious users.
Place the following text into a file named ".htaccess",
- readable by your web server, in your $BUGZILLA_HOME/data
- directory.
Place the following text into a file named ".htaccess",
+ readable by your web server, in your $BUGZILLA_HOME/data directory.
+
<Files comments> allow
- from all </Files> deny from all
<Files comments> allow from all </Files>
+ deny from all
-
Place the following text into a file named ".htaccess",
- readable by your web server, in your $BUGZILLA_HOME/
- directory.
Place the following text into a file named ".htaccess",
+ readable by your web server, in your $BUGZILLA_HOME/ directory.
+
<Files localconfig> deny
- from all </Files> allow from all
<Files localconfig> deny from all </Files>
+ allow from all
-
Place the following text into a file named ".htaccess",
- readable by your web server, in your $BUGZILLA_HOME/shadow
- directory.
Place the following text into a file named ".htaccess",
+ readable by your web server, in your $BUGZILLA_HOME/shadow directory.
+
+
deny from all
deny from all
-
@@ -454,8 +467,7 @@ ACCESSKEY="N"
WIDTH="33%"
ALIGN="left"
VALIGN="top"
->Product, Component, Milestone, and Version
- AdministrationProduct, Component, Milestone, and Version Administration
Installation of bugzilla is pretty straightforward, particularly if your
- machine already has MySQL and the MySQL-related perl packages installed.
- If those aren't installed yet, then that's the first order of business. The
- other necessary ingredient is a web server set up to run cgi scripts.
- While using Apache for your webserver is not required, it is recommended.
-
The Bugzilla Guide is contained in the "docs/" folder in your
- Bugzilla distribution. It is available in plain text
- (docs/txt), HTML (docs/html), or SGML source (docs/sgml).
-
+ for further advice on getting Bugzilla to work on Microsoft
+ Windows.
The software packages necessary for the proper running of bugzilla are:
-
The software packages necessary for the proper running of
+ Bugzilla are:
+
MySQL database server and the mysql client (3.22.5 or greater)
-
MySQL database server and the mysql client (3.22.5 or
+ greater)
Perl (5.005 or greater, 5.6.1 is recommended if you wish to
+ use Bundle::Bugzilla)
Perl Modules (minimum version):
+
Template (v2.07)
AppConfig (v1.52)
Text::Wrap (v2001.0131)
File::Spec (v0.8.2)
Perl (5.004 or greater, 5.6.1 is recommended if you wish
- to use Bundle::Bugzilla)
-
Data::Dumper (any)
DBI Perl module
-
DBD::mysql (v1.2209)
Data::Dumper Perl module
-
DBI (v1.13)
Bundle::Mysql Perl module collection
-
Date::Parse (any)
TimeDate Perl module collection
-
CGI::Carp (any)
+ and, optionally:
+
GD perl module (1.8.3) (optional, for bug charting)
-
GD (v1.19) for bug charting
Chart::Base Perl module (0.99c) (optional, for bug charting)
-
Chart::Base (v0.99c) for bug charting
DB_File Perl module (optional, for bug charting)
-
XML::Parser (any) for the XML interface
The web server of your choice. Apache is recommended.
-
MIME::Parser (any) for the email interface
+
MIME::Parser Perl module (optional, for contrib/bug_email.pl interface)
-
The web server of your choice. Apache is recommended.
-
It is a good idea, while installing Bugzilla, to ensure it
- is not accessible by other machines
- on the Internet. Your machine may be vulnerable to attacks
- while you are installing. In other words, ensure there is
- some kind of firewall between you and the rest of the
- Internet. Many installation steps require an active
- Internet connection to complete, but you must take care to
- ensure that at no point is your machine vulnerable to an
- attack.
-
It is a good idea, while installing Bugzilla, to ensure that there
+ is some kind of firewall between you and the rest of the Internet,
+ because your machine may be insecure for periods during the install.
+ Many
+ installation steps require an active Internet connection to complete,
+ but you must take care to ensure that at no point is your machine
+ vulnerable to an attack.
-
Linux-Mandrake 8.0, the author's test system, includes
- every required and optional library for Bugzilla. The
- easiest way to install them is by using the
- Linux-Mandrake 8.0 includes every
+ required and optional library for Bugzilla. The easiest way to
+ install them is by using the
+ urpmi utility. If you follow these
- commands, you should have everything you need for
- Bugzilla, and
+
+ utility. If you follow these commands, you should have everything you
+ need for Bugzilla, and
+ checksetup.pl should
- not complain about any missing libraries. You may already
- have some of these installed.
+
+ should not complain about any missing libraries. You may already have
+ some of these installed.
Visit MySQL homepage at Visit the MySQL homepage at
+ www.mysql.com and grab the latest stable release of the server. Many of the binary versions of MySQL store their data files in /var which is often part of a smaller root partition. If you decide to build from sources you can easily set the dataDir as an option to configure.
+>
+ to grab and install the latest stable release of the server.
If you install from source or non-package (RPM, deb, etc.)
- binaries you need to add
- mysqld to your
- init scripts so the server daemon will come back up whenever
- your machine reboots. Further discussion of UNIX init
- sequences are beyond the scope of this guide.
-
You should have your init script start
- mysqld with the ability to accept
- large packets. By default, Many of the binary
+ versions of MySQL store their data files in
+ mysqld
- only accepts packets up to 64K long. This limits the size
- of attachments you may put on bugs. If you add -O
- max_allowed_packet=1M to the command that starts
- mysqld (or
- /var.
+ On some Unix systems, this is part of a smaller root partition,
+ and may not have room for your bug database. If you decide to build
+ from sources you can easily set the dataDir as an option to
+ safe_mysqld), then you will be able
- to have attachments up to about 1 megabyte.
configure.
If you install from source or non-package (RPM, deb, etc.)
+ binaries you need to add
+ mysqld
-
+ to your init scripts so the server daemon will come back up whenever
+ your machine reboots. Further discussion of UNIX init sequences are
+ beyond the scope of this guide.
If you plan on running Bugzilla and MySQL on the same
- machine, consider using the Change your init script to start
+ mysqld
+ with the ability to accept large packets. By default,
+ mysqld
+ only accepts packets up to 64K long. This limits the size of
+ attachments you may put on bugs. If you add
+ -O max_allowed_packet=1M
+ to the command that starts
+ mysqld
+ (or safe_mysqld),
+ then you will be able to have attachments up to about 1 megabyte.
+ There is a Bugzilla parameter for maximum attachment size;
+ you should configure it to match the value you choose here.
If you plan on running Bugzilla and MySQL on the same machine,
+ consider using the
+ --skip-networking
- option in the init script. This enhances security by
- preventing network access to MySQL.
-
Any machine that doesn't have perl on it is a sad machine
- indeed. Perl for *nix systems can be gotten in source form
- from http://www.perl.com. Although Bugzilla runs with most
- post-5.004 versions of Perl, it's a good idea to be up to the
- very latest version if you can when running Bugzilla. As of
- this writing, that is perl version 5.6.1.
-
Perl is now a far cry from the the single compiler/interpreter
- binary it once was. It includes a great many required modules
- and quite a few other support files. If you're not up to or
- not inclined to build perl from source, you'll want to install
- it on your machine using some sort of packaging system (be it
- RPM, deb, or what have you) to ensure a sane install. In the
- subsequent sections you'll be installing quite a few perl
- modules; this can be quite ornery if your perl installation
- isn't up to snuff.
-
4.1.4. Perl
Many people complain that Perl modules will not install
- for them. Most times, the error messages complain that they
- are missing a file in "@INC". Virtually every
- time, this is due to permissions being set too restrictively
- for you to compile Perl modules or not having the necessary
- Perl development libraries installed on your system..
- Consult your local UNIX systems administrator for help
- solving these permissions issues; if you
- are the local UNIX sysadmin, please
- consult the newsgroup/mailing list for further assistance or
- hire someone to help you out.
-
Any machine that doesn't have Perl on it is a sad machine indeed.
+ Perl can be got in source form from
+ perl.com for the rare
+ *nix systems which don't have it.
+ Although Bugzilla runs with all post-5.005
+ versions of Perl, it's a good idea to be up to the very latest version
+ if you can when running Bugzilla. As of this writing, that is Perl
+ version 5.6.1.
Bundle::Bugzilla doesn't include GD, Chart::Base, or
- MIME::Parser, which are not essential to a basic Bugzilla
- install. If installing this bundle fails, you should
- install each module individually to isolate the problem.
-
Bundle::Bugzilla doesn't include GD, Chart::Base, or
+ MIME::Parser, which are not essential to a basic Bugzilla install. If
+ installing this bundle fails, you should install each module
+ individually to isolate the problem.
The DBI module is a generic Perl module used by other database related
- Perl modules. For our purposes it's required by the MySQL-related
- modules. As long as your Perl installation was done correctly the
- DBI module should be a breeze. It's a mixed Perl/C module, but Perl's
- MakeMaker system simplifies the C compilation greatly.
-
Quality, general Perl module installation instructions can be found on
- the CPAN website, but the easy thing to do is to just use the CPAN shell
- which does all the hard work for you.
-
Quality, general Perl module installation instructions can be
+ found on the CPAN website, but the easy thing to do is to just use the
+ CPAN shell which does all the hard work for you.
Many people complain that Perl modules will not install for
+ them. Most times, the error messages complain that they are missing a
+ file in
+ "@INC".
+ Virtually every time, this error is due to permissions being set too
+ restrictively for you to compile Perl modules or not having the
+ necessary Perl development libraries installed on your system.
+ Consult your local UNIX systems administrator for help solving these
+ permissions issues; if you
+ are
+ the local UNIX sysadmin, please consult the newsgroup/mailing list
+ for further assistance or hire someone to help you out.
The Data::Dumper module provides data structure persistence for Perl
- (similar to Java's serialization). It comes with later sub-releases of
- Perl 5.004, but a re-installation just to be sure it's available won't
- hurt anything.
-
4.1.5.1. DBI
Data::Dumper is used by the MySQL-related Perl modules. It
- can be found on CPAN (see Appendix B) and
- can be
- installed by following the same four step make sequence used
- for the DBI module.
-
The DBI module is a generic Perl module used the
+ MySQL-related modules. As long as your Perl installation was done
+ correctly the DBI module should be a breeze. It's a mixed Perl/C
+ module, but Perl's MakeMaker system simplifies the C compilation
+ greatly.
The Perl/MySQL interface requires a few mutually-dependent perl
- modules. These modules are grouped together into the the
- Msql-Mysql-modules package. This package can be found at CPAN.
- After the archive file has been downloaded it should
- be untarred.
-
The MySQL modules are all built using one make file which is generated
- by running:
- bash#
- perl Makefile.pl
-
4.1.5.2. Data::Dumper
The MakeMaker process will ask you a few questions about the desired
- compilation target and your MySQL installation. For many of the questions
- the provided default will be adequate.
-
When asked if your desired target is the MySQL or mSQL packages,
- select the MySQL related ones. Later you will be asked if you wish
- to provide backwards compatibility with the older MySQL packages; you
- should answer YES to this question. The default is NO.
-
A host of 'localhost' should be fine and a testing user of 'test' and
- a null password should find itself with sufficient access to run tests
- on the 'test' database which MySQL created upon installation. If 'make
- test' and 'make install' go through without errors you should be ready
- to go as far as database connectivity is concerned.
-
The Data::Dumper module provides data structure persistence for
+ Perl (similar to Java's serialization). It comes with later
+ sub-releases of Perl 5.004, but a re-installation just to be sure it's
+ available won't hurt anything.
Many of the more common date/time/calendar related Perl
- modules have been grouped into a bundle similar to the MySQL
- modules bundle. This bundle is stored on the CPAN under the
- name TimeDate (see link: Appendix B). The
- component module we're most interested in is the Date::Format
- module, but installing all of them is probably a good idea
- anyway. The standard Perl module installation instructions
- should work perfectly for this simple package.
-
4.1.5.3. MySQL-related modules
The Perl/MySQL interface requires a few mutually-dependent Perl
+ modules. These modules are grouped together into the the
+ Msql-Mysql-modules package.
The MakeMaker process will ask you a few questions about the
+ desired compilation target and your MySQL installation. For most of the
+ questions the provided default will be adequate, but when asked if your
+ desired target is the MySQL or mSQL packages, you should
+ select the MySQL related ones. Later you will be asked if you wish to
+ provide backwards compatibility with the older MySQL packages; you
+ should answer YES to this question. The default is NO.
A host of 'localhost' should be fine and a testing user of 'test'
+ with a null password should find itself with sufficient access to run
+ tests on the 'test' database which MySQL created upon installation.
+
The GD library was written by Thomas Boutell a long while
- ago to programatically generate images in C. Since then it's
- become the defacto standard for programatic image
- construction. The Perl bindings to it found in the GD library
- are used on millions of web pages to generate graphs on the
- fly. That's what bugzilla will be using it for so you must
- install it if you want any of the graphing to work.
-
Actually bugzilla uses the Graph module which relies on GD
- itself. Isn't that always the way with object-oriented
- programming? At any rate, you can find the GD library on CPAN
- in Appendix B.
-
4.1.5.4. TimeDate modules
Many of the more common date/time/calendar related Perl modules
+ have been grouped into a bundle similar to the MySQL modules bundle.
+ This bundle is stored on the CPAN under the name TimeDate.
+ The component module we're most interested in is the Date::Format
+ module, but installing all of them is probably a good idea anyway.
+
The GD library was written by Thomas Boutell a long while ago to
+ programatically generate images in C. Since then it's become the
+ defacto standard for programatic image construction. The Perl bindings
+ to it found in the GD library are used on millions of web pages to
+ generate graphs on the fly. That's what Bugzilla will be using it for
+ so you must install it if you want any of the graphing to work.
The Perl GD library requires some other libraries that may
- or may not be installed on your system, including
- The Perl GD library requires some other libraries that may or
+ may not be installed on your system, including
+ libpng and
-
+ and
+ libgd. The full requirements are
- listed in the Perl GD library README. Just realize that if
- compiling GD fails, it's probably because you're missing a
- required library.
-
.
+ The full requirements are listed in the Perl GD library README.
+ If compiling GD fails, it's probably because you're
+ missing a required library.
DB_File is a module which allows Perl programs to make use
- of the facilities provided by Berkeley DB version 1.x. This
- module is required by collectstats.pl which is used for bug
- charting. If you plan to make use of bug charting, you must
- install this module.
-
You have a freedom of choice here - Apache, Netscape or any
- other server on UNIX would do. You can easily run the web
- server on a different machine than MySQL, but need to adjust
- the MySQL You have a freedom of choice here - Apache, Netscape or any other
+ server on UNIX would do. You can run the web server on a
+ different machine than MySQL, but need to adjust the MySQL
+ "bugs" user permissions accordingly.
-
+ user permissions accordingly.
+
I strongly recommend Apache as the web server to use.
- The Bugzilla Guide installation instructions, in general,
- assume you are using Apache. As more users use different
- webservers and send me information on the peculiarities of
- installing using their favorite webserver, I will provide
- notes for them.
We strongly recommend Apache as the web server to use. The
+ Bugzilla Guide installation instructions, in general, assume you are
+ using Apache. If you have got Bugzilla working using another webserver,
+ please share your experiences with us.
-
You'll want to make sure that your web server will run any
- file with the .cgi extension as a cgi and not just display it.
- If you're using apache that means uncommenting the following
- line in the srm.conf file:
-
You'll want to make sure that your web server will run any file
+ with the .cgi extension as a CGI and not just display it. If you're
+ using Apache that means uncommenting the following line in the srm.conf
+ file:
+
AddHandler cgi-script .cgi
-
AddHandler cgi-script .cgi
-
With apache you'll also want to make sure that within the
- access.conf file the line:
-
With Apache you'll also want to make sure that within the
+ access.conf file the line:
+
Options ExecCGI
-AllowOverride Limit
-
Options ExecCGI AllowOverride Limit
- is in the stanza that covers the directories into which
- you intend to put the bugzilla .html and .cgi files.
-
AllowOverride Limit allows the use of a Deny statement in the
- .htaccess file generated by checksetup.pl
-
AllowOverride Limit allows the use of a Deny statement in the
+ .htaccess file generated by checksetup.pl
Users of newer versions of Apache will generally find both
- of the above lines will be in the httpd.conf file, rather
- than srm.conf or access.conf.
-
Users of newer versions of Apache will generally find both of
+ the above lines will be in the httpd.conf file, rather than srm.conf
+ or access.conf.
+
There are important files and directories that should not
- be a served by the HTTP server. These are most files in the
- There are important files and directories that should not be a
+ served by the HTTP server - most files in the
+ "data" and
+ and
+ "shadow" directories
- and the
+ directories and the
+ "localconfig" file. You should
- configure your HTTP server to not serve content from these
- files. Failure to do so will expose critical passwords and
- other data. Please see
+ file. You should configure your HTTP server to not serve
+ these files. Failure to do so will expose critical passwords and
+ other data. Please see
+ .htaccess files and security for details
- on how to do this for Apache. I appreciate notes on how to
- get this same functionality using other webservers.
-
+ for details on how to do this for Apache; the checksetup.pl
+ script should create appropriate .htaccess files for you.
You should untar the Bugzilla files into a directory that
- you're willing to make writable by the default web server user
- (probably You should untar the Bugzilla files into a directory that you're
+ willing to make writable by the default web server user (probably
+ "nobody"). You may decide to put the
- files off of the main web space for your web server or perhaps
- off of ).
+ You may decide to put the files in the main web space for your
+ web server or perhaps in
+ /usr/local with a symbolic link in
- the web space that points to the Bugzilla directory. At any
- rate, just dump all the files in the same place, and make sure
- you can access the files in that directory through your web
- server.
-
+ with a symbolic link in the web space that points to the Bugzilla
+ directory.
If you symlink the bugzilla directory into your Apache's
- HTML heirarchy, you may receive
- If you symlink the bugzilla directory into your Apache's HTML
+ heirarchy, you may receive
+ Forbidden errors unless you add the
-
+ errors unless you add the
+ "FollowSymLinks" directive to the
- <Directory> entry for the HTML root.
-
+ directive to the <Directory> entry for the HTML root
+ in httpd.conf.
Once all the files are in a web accessible directory, make
- that directory writable by your webserver's user. This is a
- temporary step until you run the post-install
- Once all the files are in a web accessible directory, make that
+ directory writable by your webserver's user. This is a temporary step
+ until you run the post-install
+ checksetup.pl script, which locks down your
- installation.
-
After you've gotten all the software installed and working you're ready
- to start preparing the database for its life as a the back end to a high
- quality bug tracker.
-
After you've gotten all the software installed and working you're
+ ready to start preparing the database for its life as the back end to
+ a high quality bug tracker.
First, you'll want to fix MySQL permissions to allow access
- from Bugzilla. For the purpose of this Installation section,
- the Bugzilla username will be First, you'll want to fix MySQL permissions to allow access from
+ Bugzilla. For the purpose of this Installation section, the Bugzilla
+ username will be
+ "bugs", and will
- have minimal permissions.
-
-
Bugzilla has not undergone a thorough security audit. It
- may be possible for a system cracker to somehow trick
- Bugzilla into executing a command such as DROP
- DATABASE mysql.
-
That would be bad.
+>, and will have minimal permissions.
Give the MySQL root user a password. MySQL passwords are
- limited to 16 characters.
-
Begin by giving the MySQL root user a password. MySQL passwords are limited
+ to 16 characters.
+
bash#
+
+ mysql
- -u root mysqlmysql -u root mysql
+
-
mysql>
+
+
UPDATE user SET Password=PASSWORD ('new_password')
- WHERE user='root'; UPDATE user SET Password=PASSWORD('<new_password'>)
+ WHERE user='root';
+
-
mysql>
+
+ FLUSH
- PRIVILEGES;FLUSH PRIVILEGES;
-
+
From this point on, if you need to access
- MySQL as the MySQL root user, you will need to use
-
+
+ From this point on, if you need to access MySQL as the MySQL root user,
+ you will need to use
+ mysql -u root -p and enter your
- new_password. Remember that MySQL user names have nothing to
- do with Unix user names (login names).
-
+
+ and enter <new_password>. Remember that MySQL user names have
+ nothing to do with Unix user names (login names).
Next, we create the Next, we create the
+ "bugs" user, and grant
- sufficient permissions for checksetup.pl, which we'll use
- later, to work its magic. This also restricts the
-
+
+ user, and grant sufficient permissions for checksetup.pl, which we'll
+ use later, to work its magic. This also restricts the
+ "bugs" user to operations within a database
- called
+ user to operations within a database called
+ "bugs", and only allows the account to
- connect from , and only allows the account to connect from
+ "localhost". Modify it to reflect
- your setup if you will be connecting from another machine or
- as a different user.
-
.
+ Modify it to reflect your setup if you will be connecting from
+ another machine or as a different user.
Remember to set bugs_password to some unique password.
-
Remember to set <bugs_password> to some unique password.
+
mysql>
- GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,
- ALTER,CREATE,DROP,REFERENCES
- ON bugs.* TO bugs@localhost
- IDENTIFIED BY 'bugs_password';
-
-
Next, run the magic checksetup.pl script. (Many thanks to
- Holger Schurig <holgerschurig@nikocity.de> for writing
- this script!) It will make sure Bugzilla files and directories
- have reasonable permissions, set up the
- Next, run the magic checksetup.pl script. (Many thanks to
+ Holger Schurig
+ for writing this script!)
+ This script is designed to make sure your MySQL database and other
+ configuration options are consistent with the Bugzilla CGI files.
+ It will make sure Bugzilla files and directories have reasonable
+ permissions, set up the
+ data directory, and create all the MySQL
- tables.
-
+ directory, and create all the MySQL tables.
+
bash#
- ./checksetup.pl
-
+
The first time you run it, it will create a
- file called localconfig.
-
This file contains a variety of settings you may need to tweak including
- how Bugzilla should connect to the MySQL database.
-
This file contains a variety of settings you may need to tweak
+ including how Bugzilla should connect to the MySQL database.
The connection settings include:
-
The connection settings include:
+
server's host: just use server's host: just use
+ "localhost" if the
- MySQL server is local
-
+
+ if the MySQL server is local
database name: database name:
+ "bugs" if you're following
- these directions
-
+
+ if you're following these directions
MySQL username: MySQL username:
+ "bugs" if you're following
- these directions
-
+
+ if you're following these directions
Password for the Password for the
+ "bugs" MySQL account above
-
+
+ MySQL account (<bugs_password>) above
You should also install .htaccess files that the Apache
- webserver will use to restrict access to Bugzilla data files.
- See .htaccess files and security.
-
Once you are happy with the settings, re-run
- Once you are happy with the settings,
+ checksetup.pl. On this second run, it will
- create the database and an administrator account for which
- you will be prompted to provide information.
-
When logged into an administrator account once Bugzilla is
- running, if you go to the query page (off of the Bugzilla main
- menu), you'll find an "edit parameters" option
- that is filled with editable treats.
-
Should everything work, you will have a nearly empty Bugzilla
- database and a newly-created su to the user
+ your web server runs as, and re-run
+ localconfig
- file in your Bugzilla root directory.
-
The second time you run checksetup.pl, you should become
- the user your web server runs as, and that you ensure that
- you set the "webservergroup" parameter in localconfig to
- match the web server's group name, if any. I believe,
- for the next release of Bugzilla, this will be fixed so
- that Bugzilla supports a "webserveruser" parameter in
- localconfig as well.
-
-bash# chown -R apache:apache /usr/local/bugzilla
-bash# su - apache
-bash# cd /usr/local/bugzilla
-bash# ./checksetup.pl
-
-
-
- checksetup.pl.
+ On this second run, it will create the database and an administrator
+ account for which you will be prompted to provide information.
The checksetup.pl script is designed so that you can run
- it at any time without causing harm. You should run it
- after any upgrade to Bugzilla.
-
The checksetup.pl script is designed so that you can run it at
+ any time without causing harm. You should run it after any upgrade to
+ Bugzilla.
If you want to add someone else to every group by hand, you
- can do it by typing the appropriate MySQL commands. Run
- mysql -u root -p bugs You
- may need different parameters, depending on your security
- settings. Then:
-
mysql>update
- profiles set groupset=0x7fffffffffffffff where
- login_name = 'XXX'; (yes, that's fifteen"f"'s.
-
If you followed the installation instructions for setting up your
+ "bugs" and "root" user in MySQL, much of this should not apply to you.
+ If you are upgrading an existing installation of Bugzilla, you should
+ pay close attention to this section. replacing XXX with the Bugzilla email address.
-
By now you have a fully functional bugzilla, but what good
- are bugs if they're not annoying? To help make those bugs
- more annoying you can set up bugzilla's automatic whining
- system. This can be done by adding the following command as a
- daily crontab entry (for help on that see that crontab man
- page):
-
cd
- <your-bugzilla-directory> ;
- ./whineatnews.pl
-
-
Depending on your system, crontab may have several manpages.
- The following command should lead you to the most useful
- page for this purpose:
-
If you followed the installation instructions for setting up
- your "bugs" and "root" user in MySQL, much of this should not
- apply to you. If you are upgrading an existing installation
- of Bugzilla, you should pay close attention to this section.
-
Most MySQL installs have "interesting" default security parameters:
-
Most MySQL installs have "interesting" default security
+ parameters:
+
This means anyone from anywhere on the internet can not only
- drop the database with one SQL command, and they can write as
- root to the system.
-
This means anyone from anywhere on the internet can not only drop
+ the database with one SQL command, and they can write as root to the
+ system.
To see your permissions do:
-
To see your permissions do:
+
bash#
- mysql -u root -p
-
-
mysql>
- use mysql;
-
-
mysql>
- show tables;
-
-
mysql>
- select * from user;
-
-
mysql>
- select * from db;
-
-
To fix the gaping holes:
-
To fix the gaping holes:
+
UPDATE user SET Password=PASSWORD('new_password') WHERE user='root';
UPDATE user SET Password=PASSWORD('new_password') WHERE
+ user='root';
FLUSH PRIVILEGES;
FLUSH PRIVILEGES;
If you're not running "mit-pthreads" you can use:
-
If you're not running "mit-pthreads" you can use:
+
With "mit-pthreads" you'll need to modify the "globals.pl" Mysql->Connect
- line to specify a specific host name instead of "localhost", and accept
- external connections:
-
With "mit-pthreads" you'll need to modify the "globals.pl"
+ Mysql->Connect line to specify a specific host name instead of
+ "localhost", and accept external connections:
+
Use .htaccess files with the Apache webserver to secure your
- bugzilla install. See .htaccess files and security
-
Consider also:
-
Consider also:
+
Turning off external networking with "--skip-networking",
- unless you have "mit-pthreads", in which case you can't.
- Without networking, MySQL connects with a Unix domain socket.
-
Turning off external networking with "--skip-networking",
+ unless you have "mit-pthreads", in which case you can't. Without
+ networking, MySQL connects with a Unix domain socket.
using the --user= option to mysqld to run it as an unprivileged
- user.
-
using the --user= option to mysqld to run it as an
+ unprivileged user.
starting MySQL in a chroot jail
-
running MySQL in a chroot jail
running the httpd in a "chrooted" jail
-
running the httpd in a chroot jail
making sure the MySQL passwords are different from the OS
- passwords (MySQL "root" has nothing to do with system "root").
-
making sure the MySQL passwords are different from the OS
+ passwords (MySQL "root" has nothing to do with system
+ "root").
By now you have a fully functional Bugzilla, but what good are
+ bugs if they're not annoying? To help make those bugs more annoying you
+ can set up Bugzilla's automatic whining system to complain at engineers
+ which leave their bugs in the NEW state without triaging them.
+
This can be done by
+ adding the following command as a daily crontab entry (for help on that
+ see that crontab man page):
+
cd <your-bugzilla-directory> ;
+ ./whineatnews.pl
+
+
+
Depending on your system, crontab may have several manpages.
+ The following command should lead you to the most useful page for
+ this purpose:
+
When you first run checksetup.pl after installing Bugzilla, it
- will prompt you for the administrative username (email
- address) and password for this "super user". If for some
- reason you were to delete the "super user" account, re-running
- checksetup.pl will again prompt you for this username and
- password.
-
5.2.1. Creating the Default User
When you first run checksetup.pl after installing Bugzilla, it
+ will prompt you for the administrative username (email address) and
+ password for this "super user". If for some reason you were to delete
+ the "super user" account, re-running checksetup.pl will again prompt
+ you for this username and password.
If you wish to add more administrative users, you must use the
- MySQL interface. Run "mysql" from the command line, and use
- these commands ("mysql>" denotes the mysql prompt, not
- something you should type in):
- If you wish to add more administrative users, you must use the
+ MySQL interface. Run "mysql" from the command line, and use these
+ commands ("mysql>" denotes the mysql prompt, not something you
+ should type in):
+ mysql> use bugs;
-
+
+ mysql> update profiles set
- groupset=0x7ffffffffffffff where login_name = "(user's
- login name)";
-
+
Yes, that is Yes, that is
+ fourteen
- "f"'s. A whole lot of f-ing going on if you
- want to create a new administator.
+
+ 's. A whole lot of f-ing going on if you want to create a new
+ administator.
Your users can create their own user accounts by clicking
- the "New Account" link at the bottom of each page. However,
- should you desire to create user accounts ahead of time,
- here is how you do it.
-
Your users can create their own user accounts by clicking the
+ "New Account" link at the bottom of each page. However, should you
+ desire to create user accounts ahead of time, here is how you do
+ it.
After logging in, click the "Users" link at the footer
- of the query page.
-
After logging in, click the "Users" link at the footer of
+ the query page.
To see a specific user, type a portion of their login
- name in the box provided and click "submit". To see all
- users, simply click the "submit" button. You must click
- "submit" here to be able to add a new user.
-
To see a specific user, type a portion of their login name
+ in the box provided and click "submit". To see all users, simply
+ click the "submit" button. You must click "submit" here to be
+ able to add a new user.
More functionality is available via the list on the
- right-hand side of the text entry box. You can match
- what you type as a case-insensitive substring (the
- default) of all users on your system, a case-sensitive
- regular expression (please see the More functionality is available via the list on the
+ right-hand side of the text entry box. You can match what you
+ type as a case-insensitive substring (the default) of all users
+ on your system, a case-sensitive regular expression (please see
+ the
+ man
- regexp manual page for details on regular
- expression syntax), or a man regexp
+
+ manual page for details on regular expression syntax), or a
+ reverse
- regular expression match, where every user name which
- does NOT match the regular expression is selected.
-
Click the "Add New User" link at the bottom of the user
- list
-
Click the "Add New User" link at the bottom of the user
+ list
Fill out the form presented. This page is
- self-explanatory. When done, click "submit".
-
Fill out the form presented. This page is self-explanatory.
+ When done, click "submit".
Adding a user this way will 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.
-
+
+ button to create users, as it will pre-populate all the
+ required fields and also notify the user of her account name
+ and password.
I bet you noticed that big "Disabled Text" entry box
- available from the "Add New User" screen, when you edit an
- account? By entering any text in this box and selecting
- "submit", you have prevented the user from using Bugzilla
- via the web interface. Your explanation, written in this
- text box, will be presented to the user the next time she
- attempts to use the system.
-
5.2.2.3. Disabling Users
I bet you noticed that big "Disabled Text" entry box available
+ from the "Add New User" screen, when you edit an account? By entering
+ any text in this box and selecting "submit", you have prevented the
+ user from using Bugzilla via the web interface. Your explanation,
+ written in this text box, will be presented to the user the next time
+ she attempts to use the system.
+
Don't disable your own administrative account, or you
- will hate life!
-
Don't disable your own administrative account, or you will
+ hate life!
At this time, At this time,
+ "Disabled Text" does not
- prevent a user from using the email interface. If you
- have the email interface enabled, they can still
- continue to submit bugs and comments that way. We need
- a patch to fix this.
+
+ does not prevent a user from using the email interface. If you have
+ the email interface enabled, they can still continue to submit bugs
+ and comments that way. We need a patch to fix this.
Here I will attempt to describe the function of each option
- on the Edit User screen.
-
Here I will attempt to describe the function of each option on
+ the Edit User screen.
Login Name: This is generally the
- user's email address. However, if you have edited your
- system parameters, this may just be the user's login
- name or some other identifier.
-
+
+ : This is generally the user's email address. However, if you
+ have edited your system parameters, this may just be the user's
+ login name or some other identifier.
+
For compatability reasons, you should probably stick
- with email addresses as user login names. It will
- make your life easier.
-
For compatability reasons, you should probably stick with
+ email addresses as user login names. It will make your life
+ easier.
-
Real Name: Duh!
-
+
+ : Duh!
Password: You can change the user
- password here. It is normal to only see asterisks.
-
+
+ : You can change the user password here. It is normal to only see
+ asterisks.
Disable Text: If you type anything
- in this box, including just a space, the user account is
- disabled from making any changes to bugs via the web
- interface, and what you type in this box is presented as
- the reason.
-
+
+ : If you type anything in this box, including just a space, the
+ user account is disabled from making any changes to bugs via the
+ web interface, and what you type in this box is presented as the
+ reason.
+
-
As of this writing, the user can still submit bugs
- via the e-mail gateway, if you set it up, despite
- the disabled text field. The e-mail gateway should
- As of this writing, the user can still submit bugs via
+ the e-mail gateway, if you set it up, despite the disabled text
+ field. The e-mail gateway should
+ not be enabled for secure
- installations of Bugzilla.
-
+
+ be enabled for secure installations of Bugzilla.
-
CanConfirm: This field is only used
- if you have enabled "unconfirmed" status in your
- parameters screen. If you enable this for a user, that
- user can then move bugs from "Unconfirmed" to
- "Confirmed" status (e.g.: "New" status). Be judicious
- about allowing users to turn this bit on for other
- users.
-
+
+ : This field is only used if you have enabled "unconfirmed"
+ status in your parameters screen. If you enable this for a user,
+ that user can then move bugs from "Unconfirmed" to "Confirmed"
+ status (e.g.: "New" status). Be judicious about allowing users to
+ turn this bit on for other users.
Creategroups: This option will
- allow a user to create and destroy groups in Bugzilla.
- Unless you are using the Bugzilla GroupSentry security
- option "usebuggroupsentry" in your parameters, this
- setting has no effect.
-
+
+ : This option will allow a user to create and destroy groups in
+ Bugzilla. Unless you are using the Bugzilla GroupSentry security
+ option "usebuggroupsentry" in your parameters, this setting has
+ no effect.
Editbugs: Unless a user has this
- bit set, they can only edit those bugs for which they
- are the assignee or the reporter.
-
+
+ : Unless a user has this bit set, they can only edit those bugs
+ for which they are the assignee or the reporter.
+
Leaving this option unchecked does not prevent users
- from adding comments to a bug! They simply cannot
- change a bug priority, severity, etc. unless they
- are the assignee or reporter.
-
Leaving this option unchecked does not prevent users from
+ adding comments to a bug! They simply cannot change a bug
+ priority, severity, etc. unless they are the assignee or
+ reporter.
-
Editcomponents: This flag allows a
- user to create new products and components, as well as
- modify and destroy those that have no bugs associated
- with them. If a product or component has bugs
- associated with it, those bugs must be moved to a
- different product or component before Bugzilla will
- allow them to be destroyed. The name of a product or
- component can be changed without affecting the
- associated bugs, but it tends to annoy the hell out of
- your users when these change a lot.
-
+
+ : This flag allows a user to create new products and components,
+ as well as modify and destroy those that have no bugs associated
+ with them. If a product or component has bugs associated with it,
+ those bugs must be moved to a different product or component
+ before Bugzilla will allow them to be destroyed. The name of a
+ product or component can be changed without affecting the
+ associated bugs, but it tends to annoy the hell out of your users
+ when these change a lot.
Editkeywords: If you use Bugzilla's
- keyword functionality, enabling this feature allows a
- user can create and destroy keywords. As always, the
- keywords for existing bugs containing the keyword the
- user wishes to destroy must be changed before Bugzilla
- will allow it to die. You must be very careful about
- creating too many new keywords if you run a very large
- Bugzilla installation; keywords are global variables
- across products, and you can often run into a phenomenon
- called "keyword bloat". This confuses users, and then
- the feature goes unused.
-
+
+ : If you use Bugzilla's keyword functionality, enabling this
+ feature allows a user can create and destroy keywords. As always,
+ the keywords for existing bugs containing the keyword the user
+ wishes to destroy must be changed before Bugzilla will allow it
+ to die. You must be very careful about creating too many new
+ keywords if you run a very large Bugzilla installation; keywords
+ are global variables across products, and you can often run into
+ a phenomenon called "keyword bloat". This confuses users, and
+ then the feature goes unused.
Editusers: This flag allows a user
- do what you're doing right now: edit other users. This
- will allow those with the right to do so to remove
- administrator privileges from other users or grant them
- to themselves. Enable with care.
-
+
+ : This flag allows a user do what you're doing right now: edit
+ other users. This will allow those with the right to do so to
+ remove administrator privileges from other users or grant them to
+ themselves. Enable with care.
PRODUCT: PRODUCT bugs access. This
- allows an administrator, with product-level granularity,
- to specify in which products a user can edit bugs. The
- user must still have the "editbugs" privelege to edit
- bugs in this area; this simply restricts them from even
- seeing bugs outside these boundaries if the
- administrator has enabled the group sentry parameter
- "usebuggroupsentry". Unless you are using bug groups,
- this option has no effect.
-
+
+ : PRODUCT bugs access. This allows an administrator, with
+ product-level granularity, to specify in which products a user
+ can edit bugs. The user must still have the "editbugs" privelege
+ to edit bugs in this area; this simply restricts them from even
+ seeing bugs outside these boundaries if the administrator has
+ enabled the group sentry parameter "usebuggroupsentry". Unless
+ you are using bug groups, this option has no effect.
Product, Component, Milestone, and Version
- AdministrationProduct, Component, Milestone, and Version Administration
Fenris was a fork from Bugzilla made by Loki Games; when
+ Loki went into receivership, it died. While Loki's other code lives on,
+ its custodians recommend Bugzilla for future bug-tracker deployments.
+
Although Perforce isn't really a bug tracker, it can be used
- as such through the Although Perforce isn't really a bug tracker, it can be used as
+ such through the "jobs" functionality.
Scarab is a promising new bug-tracking system built using
- Java Serlet technology. As of this writing, no source code has
- been released as a package, but you can obtain the code from
- CVS.
-
Scarab is a new bug-tracking system built using Java
+ Serlet technology. It is currently at version 1.0 beta 7.
SourceForge is more of a way of coordinating geographically
- distributed free software and open source projects over the
- Internet than strictly a bug tracker, but if you're hunting for
- bug-tracking for your open project, it may be just what the
- software engineer ordered!
SourceForge is a way of coordinating geographically
+ distributed free software and open source projects over the Internet.
+ It has a built-in bug tracker, but it's not highly thought of.
For many years, defect-tracking software has remained
- principally the domain of large software development houses.
- Even then, most shops never bothered with bug-tracking software,
- and instead simply relied on shared lists and email to monitor
- the status of defects. This procedure is error-prone and tends
- to cause those bugs judged least significant by developers to be
- dropped or ignored.
-
For many years, defect-tracking software has remained principally
+ the domain of large software development houses. Even then, most shops
+ never bothered with bug-tracking software, and instead simply relied on
+ shared lists and email to monitor the status of defects. This procedure
+ is error-prone and tends to cause those bugs judged least significant by
+ developers to be dropped or ignored.
These days, many companies are finding that integrated
- defect-tracking systems reduce downtime, increase productivity,
- and raise customer satisfaction with their systems. Along with
- full disclosure, an open bug-tracker allows manufacturers to
- keep in touch with their clients and resellers, to communicate
- about problems effectively throughout the data management chain.
- Many corporations have also discovered that defect-tracking
- helps reduce costs by providing IT support accountability,
- telephone support knowledge bases, and a common, well-understood
- system for accounting for unusual system or software issues.
-
These days, many companies are finding that integrated
+ defect-tracking systems reduce downtime, increase productivity, and raise
+ customer satisfaction with their systems. Along with full disclosure, an
+ open bug-tracker allows manufacturers to keep in touch with their clients
+ and resellers, to communicate about problems effectively throughout the
+ data management chain. Many corporations have also discovered that
+ defect-tracking helps reduce costs by providing IT support
+ accountability, telephone support knowledge bases, and a common,
+ well-understood system for accounting for unusual system or software
+ issues.
But why should But why should
+ you use Bugzilla?
-
+
+ use Bugzilla?
Bugzilla is very adaptable to various situations. Known uses
- currently include IT support queues, Systems Administration
- deployment management, chip design and development problem
- tracking (both pre-and-post fabrication), and software and
- hardware bug tracking for luminaries such as Redhat, Loki
- software, Linux-Mandrake, and VA Systems. Combined with systems
- such as CVS, Bonsai, or Perforce SCM, Bugzilla provides a
- powerful, easy-to-use solution to configuration management and
- replication problems
-
Bugzilla is very adaptable to various situations. Known uses
+ currently include IT support queues, Systems Administration deployment
+ management, chip design and development problem tracking (both
+ pre-and-post fabrication), and software and hardware bug tracking for
+ luminaries such as Redhat, NASA, Linux-Mandrake, and VA Systems.
+ Combined with systems such as CVS, Bonsai, or Perforce SCM, Bugzilla
+ provides a powerful, easy-to-use solution to configuration management and
+ replication problems.
Bugzilla can dramatically increase the productivity and
- accountability of individual employees by providing a documented
- workflow and positive feedback for good performance. How many
- times do you wake up in the morning, remembering that you were
- supposed to do Bugzilla can dramatically increase the productivity and
+ accountability of individual employees by providing a documented workflow
+ and positive feedback for good performance. How many times do you wake up
+ in the morning, remembering that you were supposed to do
+ something today, but you
- just can't quite remember? Put it in Bugzilla, and you have a
- record of it from which you can extrapolate milestones, predict
- product versions for integration, and by using Bugzilla's e-mail
- integration features be able to follow the discussion trail that
- led to critical decisions.
-
+ today, but you just can't quite remember? Put it in Bugzilla, and you
+ have a record of it from which you can extrapolate milestones, predict
+ product versions for integration, and follow the discussion trail
+ that led to critical decisions.
Ultimately, Bugzilla puts the power in your hands to improve
- your value to your employer or business while providing a usable
- framework for your natural attention to detail and knowledge
- store to flourish.
-
Ultimately, Bugzilla puts the power in your hands to improve your
+ value to your employer or business while providing a usable framework for
+ your natural attention to detail and knowledge store to flourish.
This section covers installation on Microsoft Windows 95,
- 98, ME, NT, and 2000. Bugzilla works fine on Win32 platforms,
- but please remember that the Bugzilla team and the author of the
- Guide neither endorse nor support installation on Microsoft
- Windows. Bugzilla installs and runs This section covers installation on Microsoft Windows 95, 98, ME,
+ NT, and 2000. Bugzilla works fine on Win32 platforms, but please remember
+ that the Bugzilla team and the author of the Guide neither endorse nor
+ support installation on Microsoft Windows. Bugzilla installs and runs
+ best
- and easiest on UNIX-like operating systems,
- and that is the way it will stay for the foreseeable future. The
- Bugzilla team is considering supporting Win32 for the 2.16
- release and later.
The easiest way to install Bugzilla on Intel-archiecture
- machines is to install some variant of GNU/Linux, then follow
- the UNIX installation instructions in this Guide. If you have
- any influence in the platform choice for running this system,
- please choose GNU/Linux instead of Microsoft Windows.
+
+ on UNIX-like operating systems, and that is the way it will stay for the
+ foreseeable future. The Bugzilla team is considering supporting Win32 for
+ the 2.16 release and later.
The easiest way to install Bugzilla on Intel-archiecture machines
+ is to install some variant of GNU/Linux, then follow the UNIX
+ installation instructions in this Guide. If you have any influence in the
+ platform choice for running this system, please choose GNU/Linux instead
+ of Microsoft Windows.
Making Bugzilla work on Microsoft Windows is no
- picnic. Support for Win32 has improved dramatically in the
- last few releases, but, if you choose to proceed, you should
- be a
+
+ section while performing your Win32 installation.
Install Install
+ Apache Web
- Server for Windows, and copy the Bugzilla files
- somewhere Apache can serve them. Please follow all the
- instructions referenced in Apache Web Server
+
+ for Windows, and copy the Bugzilla files somewhere Apache can serve
+ them. Please follow all the instructions referenced in
+ Bugzilla Installation
- regarding your Apache configuration, particularly
- instructions regarding the "AddHandler"
- parameter and "ExecCGI".
-
If you are going to use IIS, if on Windows NT you must
- be updated to at least Service Pack 4. Windows 2000
- ships with a sufficient version of IIS.
-
If you are going to use IIS, if on Windows NT you must be
+ updated to at least Service Pack 4. Windows 2000 ships with a
+ sufficient version of IIS.
ActiveState's 5.6Plus directory also contains an AppConfig ppm, so
- you might see the following error when trying to install the
- version at OpenInteract:
-
ActiveState's 5.6Plus directory also contains an AppConfig
+ ppm, so you might see the following error when trying to install
+ the version at OpenInteract:
Error installing package 'AppConfig': Read a PPD for
- 'AppConfig', but it is not intended for this build of Perl
- (MSWin32-x86-multi-thread)
- Error installing package 'AppConfig': Read a PPD
+ for 'AppConfig', but it is not intended for this build of Perl
+ (MSWin32-x86-multi-thread)
-
If so, download both If so, download both
+ the
- tarball and
the tarball
+
+ and
+ the
- ppd directly from OpenInteract, then run ppm from within
- the same directory to which you downloaded those files and
- install the package by referencing the ppd file explicitly via in
- the install command, f.e.:
-
the ppd
+
+ directly from OpenInteract, then run ppm from within the same
+ directory to which you downloaded those files and install the
+ package by referencing the ppd file explicitly via in the install
+ command, f.e.:
+
+
+ . Some find it helpful to use the WinMySqlAdmin utility, included
+ with the download, to set up the database.
-
Setup MySQL
-
Setup MySQL
C:> C:>
- C:\mysql\bin\mysql -u root mysql
-
-
mysql>
- DELETE FROM user WHERE Host='localhost' AND User='';DELETE FROM user WHERE Host='localhost' AND
+ User='';
-
-
mysql>
- UPDATE user SET Password=PASSWORD ('new_password')
- WHERE user='root';
-
-
"new_password", above, indicates
- whatever password you wish to use for your
-
+
+ , above, indicates whatever password you wish to use for your
+ "root" user.
+
+ user.
mysql>
- GRANT SELECT, INSERT, UPDATE, DELETE,
- INDEX, ALTER, CREATE, DROP, REFERENCES
- ON bugs.* to bugs@localhost
- IDENTIFIED BY 'bugs_password';GRANT SELECT, INSERT, UPDATE, DELETE, INDEX,
+ ALTER, CREATE, DROP, REFERENCES ON bugs.* to bugs@localhost
+ IDENTIFIED BY 'bugs_password';
-
-
"bugs_password", above, indicates
- whatever password you wish to use for your
-
+
+ , above, indicates whatever password you wish to use for your
+ "bugs" user.
Edit Edit
+ checksetup.pl in your Bugzilla directory. Change
- this line:
-
+
+ in your Bugzilla directory. Change this line:
my $webservergid = getgrnam($my_webservergroup);
-
my $webservergid =
+ getgrnam($my_webservergroup);
-
to
-
to
my $webservergid = $my_webservergroup;
-
my $webservergid =
+ $my_webservergroup;
-or the name of the group you wish to own the files explicitly:
-
my $webservergid = 'Administrators'
-
my $webservergid =
+ 'Administrators'
-
Run Run
+ checksetup.pl from the Bugzilla directory.
-
+
+ from the Bugzilla directory.
Edit Edit
+ localconfig to suit your
- requirements. Set
+
+ to suit your requirements. Set
+ $db_pass to your
-
+
+ to your
+ "bugs_password" from
+
+ from
+ step 5.d, and
+
+ , and
+ $webservergroup to
+
+ to
+ "8".
+
+ .
Not sure on the Not sure on the
+ "8" for
-
+
+ for
+ $webservergroup above. If it's
- wrong, please send corrections.
+
+ above. If it's wrong, please send corrections.
Edit Edit
+ defparams.pl to suit your
- requirements. Particularly, set
-
+
+ to suit your requirements. Particularly, set
+ DefParam("maintainer") and
-
+
+ and
+ DefParam("urlbase") to match your
- install.DefParam("urlbase") to match your install.
-
This is yet another step I'm not sure of, since the
- maintainer of this documentation does not maintain
- Bugzilla on NT. If you can confirm or deny that this
- step is required, please let me know.
There are several alternatives to Sendmail that will work on Win32.
- The one mentioned here is a There are several alternatives to Sendmail that will work
+ on Win32. The one mentioned here is a
+ suggestion, not
- a requirement. Some other mail packages that can work include
-
+
+ , not a requirement. Some other mail packages that can work
+ include
+ BLAT,
-
+
+ ,
+ Windmail,
-
+
+ ,
+ Mercury Sendmail,
- and the CPAN Net::SMTP Perl module (available in .ppm).
- Every option requires some hacking of the Perl scripts for Bugzilla
- to make it work. The option here simply requires the least.
-
Mercury
+ Sendmail
+
+ , and the CPAN Net::SMTP Perl module (available in .ppm). Every
+ option requires some hacking of the Perl scripts for Bugzilla to
+ make it work. The option here simply requires the least.
Download NTsendmail, available fromDownload NTsendmail, available from
+ www.ntsendmail.com. You must have a "real" mail server which allows you to relay off it in your $ENV{"NTsendmail"} (which you should probably place in globals.pl)
-
www.ntsendmail.com
+
+ . You must have a "real" mail server which allows you to relay
+ off it in your $ENV{"NTsendmail"} (which you should probably
+ place in globals.pl)
# these settings configure the NTsendmail process
-use NTsendmail;
-$ENV{"NTsendmail"}="your.smtpserver.box";
-$ENV{"NTsendmail_debug"}=1;
-$ENV{"NTsendmail_max_tries"}=5;
-
# these settings configure the NTsendmail
+ process use NTsendmail;
+ $ENV{"NTsendmail"}="your.smtpserver.box";
+ $ENV{"NTsendmail_debug"}=1;
+ $ENV{"NTsendmail_max_tries"}=5;
Some mention to also edit
- Some mention to also edit
+ $db_pass in
-
+
+ in
+ globals.pl to be your
-
+
+ to be your
+ "bugs_password". Although this may get
- you around some problem authenticating to your
- database, since globals.pl is not normally
- restricted by
+
+ . Although this may get you around some problem
+ authenticating to your database, since globals.pl is not
+ normally restricted by
+ .htaccess, your
- database password is exposed to whoever uses your
- web server.
-
+
+ , your database password is exposed to whoever uses your web
+ server.
Find and comment out all occurences of
- Find and comment out all occurences of
+ ""
+ open(SENDMAIL" in
- your Bugzilla directory. Then replace them with:
-
+ "
+
+ in your Bugzilla directory. Then replace them with:
+
# new sendmail functionality my $mail=new
+ NTsendmail; my $from="bugzilla\@your.machine.name.tld"; my
+ $to=$login; my $subject=$urlbase;
+ $mail->send($from,$to,$subject,$msg);
-
Some have found success using the commercial product,
- Some have found success using the commercial product,
+ Windmail.
- You could try replacing your sendmail calls with:
-
+
+ . You could try replacing your sendmail calls with:
+
open SENDMAIL, "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t > mail.log";
-
open SENDMAIL,
+ "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t >
+ mail.log";
- or something to that effect.
-
Change all references in all files from
- Change all references in all files from
+ processmail to
-
+
+ to
+ processmail.pl, and
- rename
+
+ , and rename
+ processmail to
-
+
+ to
+ processmail.pl.
-
+
+ .
Many think this may be a change we want to make for
- main-tree Bugzilla. It's painless for the UNIX folks,
- and will make the Win32 people happier.
-
Many think this may be a change we want to make for
+ main-tree Bugzilla. It's painless for the UNIX folks, and will
+ make the Win32 people happier.
Some people have suggested using the Net::SMTP Perl module instead of NTsendmail or the other options listed here. You can change processmail.pl to make this work.
-
Some people have suggested using the Net::SMTP Perl module
+ instead of NTsendmail or the other options listed here. You can
+ change processmail.pl to make this work.
+
-here is a test mail program for Net::SMTP:
-
-
This step is optional if you are using IIS or another
- web server which only decides on an interpreter based
- upon the file extension (.pl), rather than the
- This step is optional if you are using IIS or another web
+ server which only decides on an interpreter based upon the file
+ extension (.pl), rather than the
+ "shebang" line (#/usr/bonsaitools/bin/perl)
-
+
+ line (#/usr/bonsaitools/bin/perl)
Modify the path to perl on the first line (#!) of all
- files to point to your Perl installation, and add
- Modify the path to perl on the first line (#!) of all files
+ to point to your Perl installation, and add
+ "perl" to the beginning of all Perl system
- calls that use a perl script as an argument. This may
- take you a while. There is a
+
+ to the beginning of all Perl system calls that use a perl script as
+ an argument. This may take you a while. There is a
+ "setperl.csh"
- utility to speed part of this procedure, available in the
- Useful Patches and Utilities for Bugzilla section of The Bugzilla Guide.
- However, it requires the Cygwin GNU-compatible environment
- for Win32 be set up in order to work. See
+
+ section of The Bugzilla Guide. However, it requires the Cygwin
+ GNU-compatible environment for Win32 be set up in order to work.
+ See
+ http://www.cygwin.com/ for details on obtaining Cygwin.
-
+
+ for details on obtaining Cygwin.
Modify the invocation of all system() calls in all perl
- scripts in your Bugzilla directory. You should specify the
- full path to perl for each system() call. For instance, change
- this line in processmail:
-
Modify the invocation of all system() calls in all perl
+ scripts in your Bugzilla directory. You should specify the full
+ path to perl for each system() call. For instance, change this line
+ in processmail:
+
+>
system ("./processmail",@ARGLIST);
- </programlisting> to
- <programlisting>
+ </programlisting> to
+ <programlisting>
system ("C:\\perl\\bin\\perl", "processmail", @ARGLIST);
-
Because Microsoft Windows based systems handle binary
- files different than Unix based systems, you need to add
- the following lines to
- Because Microsoft Windows based systems handle binary files
+ different than Unix based systems, you need to add the following
+ lines to
+ createattachment.cgi and
-
+
+ and
+ showattachment.cgi before the
-
+
+ before the
+ require 'CGI.pl'; line.
-
+
+ line.
According to According to
+ bug 62000,
- the perl documentation says that you should always use
-
bug 62000
+
+ , the perl documentation says that you should always use
+ binmode() when dealing with binary
- files, but never when dealing with text files. That seems
- to suggest that rather than arbitrarily putting
-
+
+ when dealing with binary files, but never when dealing with text
+ files. That seems to suggest that rather than arbitrarily putting
+
+ binmode() at the beginning of the
- attachment files, there should be logic to determine if
-
+
+ at the beginning of the attachment files, there should be logic
+ to determine if
+ binmode() is needed or not.
-
+
+ is needed or not.
If you are using IIS or Personal Web Server, you must add cgi
- relationships to Properties -> Home directory (tab) ->
- Application Settings (section) -> Configuration (button),
- such as:
-
If you are using IIS or Personal Web Server, you must add cgi
+ relationships to Properties -> Home directory (tab) ->
+ Application Settings (section) -> Configuration (button), such
+ as:
-.cgi to: <perl install directory>\perl.exe %s %s
-.pl to: <perl install directory>\perl.exe %s %s
-GET,HEAD,POST
-
.cgi to: <perl install directory>\perl.exe %s
+ %s .pl to: <perl install directory>\perl.exe %s %s
+ GET,HEAD,POST
- Change the path to Perl to match your
- install, of course.
-
+
+ Change the path to Perl to match your install, of course.
The keys should be called ".pl" and ".cgi", and both
- should have a value something like:
- The keys should be called ".pl" and ".cgi", and both should
+ have a value something like:
+ c:/perl/bin/perl.exe "%s" "%s"
-
The KB article only talks about .pl, but it goes into
- more detail and provides a perl test script.
-
The KB article only talks about .pl, but it goes into more
+ detail and provides a perl test script.
-
If attempting to run Bugzilla 2.12 or older, you will need
- to remove encrypt() calls from the Perl source. This is
- If attempting to run Bugzilla 2.12 or older, you will need to
+ remove encrypt() calls from the Perl source. This is
+ not necessary for Bugzilla 2.13 and
- later, which includes the current release, Bugzilla
- 2.16.
-
+
+ for Bugzilla 2.13 and later, which includes the current release,
+ Bugzilla &bz-ver;.
+
What follows is some late-breaking information on using the
- LDAP authentication options with Bugzilla. The author has not
- tested these (nor even formatted this section!) so please
- contribute feedback to the newsgroup.
-
What follows is some late-breaking information on using the LDAP
+ authentication options with Bugzilla. The author has not tested these
+ (nor even formatted this section!) so please contribute feedback to the
+ newsgroup.
-Mozilla::LDAP module
-
-The Mozilla::LDAP module allows you to use LDAP for authentication to
-the Bugzilla system. This module is not required if you are not using
-LDAP.
-
-Mozilla::LDAP (aka PerLDAP) is available for download from
-http://www.mozilla.org/directory.
-
-NOTE: The Mozilla::LDAP module requires Netscape's Directory SDK.
-Follow the link for "Directory SDK for C" on that same page to
-download the SDK first. After you have installed this SDK, then
-install the PerLDAP module.
-----------------------------------------------------------------------
-
-Post-Installation Checklist
-----------------------------------------------------------------------
-Set useLDAP to "On" **only** if you will be using an LDAP directory
-for authentication. Be very careful when setting up this parameter;
-if you set LDAP authentication, but do not have a valid LDAP directory
-set up, you will not be able to log back in to Bugzilla once you log
-out. (If this happens, you can get back in by manually editing the
-data/params file, and setting useLDAP back to 0.)
-
-If using LDAP, you must set the three additional parameters:
-
-Set LDAPserver to the name (and optionally port) of your LDAP server.
-If no port is specified, it defaults to the default port of 389. (e.g
-"ldap.mycompany.com" or "ldap.mycompany.com:1234")
-
-Set LDAPBaseDN to the base DN for searching for users in your LDAP
-directory. (e.g. "ou=People,o=MyCompany") uids must be unique under
-the DN specified here.
-
-Set LDAPmailattribute to the name of the attribute in your LDAP
-directory which contains the primary email address. On most directory
-servers available, this is "mail", but you may need to change this.
-----------------------------------------------------------------------
-
-(Not sure where this bit should go, but it's important that it be in
-there somewhere...)
-----------------------------------------------------------------------
-Using LDAP authentication for Bugzilla:
-
-The existing authentication scheme for Bugzilla uses email addresses
-as the primary user ID, and a password to authenticate that user. All
-places within Bugzilla where you need to deal with user ID (e.g
-assigning a bug) use the email address.
-
-The LDAP authentication builds on top of this scheme, rather than
-replacing it. The initial log in is done with a username and password
-for the LDAP directory. This then fetches the email address from LDAP
-and authenticates seamlessly in the standard Bugzilla authentication
-scheme using this email address. If an account for this address
-already exists in your Bugzilla system, it will log in to that
-account. If no account for that email address exists, one is created
-at the time of login. (In this case, Bugzilla will attempt to use the
-"displayName" or "cn" attribute to determine the user's full name.)
-
-After authentication, all other user-related tasks are still handled
-by email address, not LDAP username. You still assign bugs by email
-address, query on users by email address, etc.
-----------------------------------------------------------------------
-
Mozilla::LDAP module The Mozilla::LDAP module allows you
+ to use LDAP for authentication to the Bugzilla system. This module is
+ not required if you are not using LDAP. Mozilla::LDAP (aka PerLDAP) is
+ available for download from http://www.mozilla.org/directory. NOTE: The
+ Mozilla::LDAP module requires Netscape's Directory SDK. Follow the link
+ for "Directory SDK for C" on that same page to download the SDK first.
+ After you have installed this SDK, then install the PerLDAP module.
+ ----------------------------------------------------------------------
+ Post-Installation Checklist
+ ----------------------------------------------------------------------
+ Set useLDAP to "On" **only** if you will be using an LDAP directory for
+ authentication. Be very careful when setting up this parameter; if you
+ set LDAP authentication, but do not have a valid LDAP directory set up,
+ you will not be able to log back in to Bugzilla once you log out. (If
+ this happens, you can get back in by manually editing the data/params
+ file, and setting useLDAP back to 0.) If using LDAP, you must set the
+ three additional parameters: Set LDAPserver to the name (and optionally
+ port) of your LDAP server. If no port is specified, it defaults to the
+ default port of 389. (e.g "ldap.mycompany.com" or
+ "ldap.mycompany.com:1234") Set LDAPBaseDN to the base DN for searching
+ for users in your LDAP directory. (e.g. "ou=People,o=MyCompany") uids
+ must be unique under the DN specified here. Set LDAPmailattribute to
+ the name of the attribute in your LDAP directory which contains the
+ primary email address. On most directory servers available, this is
+ "mail", but you may need to change this.
+ ----------------------------------------------------------------------
+ (Not sure where this bit should go, but it's important that it be in
+ there somewhere...)
+ ----------------------------------------------------------------------
+ Using LDAP authentication for Bugzilla: The existing authentication
+ scheme for Bugzilla uses email addresses as the primary user ID, and a
+ password to authenticate that user. All places within Bugzilla where
+ you need to deal with user ID (e.g assigning a bug) use the email
+ address. The LDAP authentication builds on top of this scheme, rather
+ than replacing it. The initial log in is done with a username and
+ password for the LDAP directory. This then fetches the email address
+ from LDAP and authenticates seamlessly in the standard Bugzilla
+ authentication scheme using this email address. If an account for this
+ address already exists in your Bugzilla system, it will log in to that
+ account. If no account for that email address exists, one is created at
+ the time of login. (In this case, Bugzilla will attempt to use the
+ "displayName" or "cn" attribute to determine the user's full name.)
+ After authentication, all other user-related tasks are still handled by
+ email address, not LDAP username. You still assign bugs by email
+ address, query on users by email address, etc.
+ ----------------------------------------------------------------------
PrevNextInstallation General NotesStep-by-step Install
Administering Bugzilla
Mac OS X Installation Notes
+
@@ -61,14 +62,15 @@ try to avoid clutter and feel free to waste space in the code to make it more re
The Bugzilla Guide
-
- Matthew
- P.
- Barnson
-
- mbarnson@sisna.com
-
+ Matthew
+ P.
+ Barnson
+
+
+ The
+ Bugzilla
+ Team
@@ -104,6 +106,9 @@ try to avoid clutter and feel free to waste space in the code to make it more re
&about;
+
+&introduction;
+
&using;
diff --git a/docs/sgml/about.sgml b/docs/sgml/about.sgml
index 62e4865731..df21d1f2db 100644
--- a/docs/sgml/about.sgml
+++ b/docs/sgml/about.sgml
@@ -4,40 +4,6 @@
About This Guide
-
- Purpose and Scope of this Guide
-
- Bugzilla is simply the best piece of bug-tracking software the
- world has ever seen. This document is intended to be the
- comprehensive guide to the installation, administration,
- maintenance, and use of the Bugzilla bug-tracking system.
-
-
- This release of the Bugzilla Guide is the
- &bzg-ver; release. It is so named that it
- may match the current version of Bugzilla. The numbering
- tradition stems from that used for many free software projects,
- in which even-numbered point releases (1.2,
- 1.14, etc.) are considered "stable releases", intended for
- public consumption; on the other hand,
- odd-numbered point releases (1.3, 2.09,
- etc.) are considered unstable development
- releases intended for advanced users, systems administrators,
- developers, and those who enjoy a lot of pain.
-
-
- Newer revisions of the Bugzilla Guide follow the numbering
- conventions of the main-tree Bugzilla releases, available at
- &bz;. Intermediate releases will have
- a minor revision number following a period. The current version
- of Bugzilla, as of this writing (&bzg-date;) is &bz-ver;; if
- something were seriously wrong with that edition of the Guide,
- subsequent releases would receive an additional dotted-decimal
- digit to indicate the update (&bzg-ver;.1, &bzg-ver;.2, etc.).
- Got it? Good.
-
-
-
Copyright Information
@@ -64,12 +30,11 @@
No liability for the contents of this document can be accepted.
Use the concepts, examples, and other content at your own risk.
- As this is a new edition of this document, there may be errors
- and inaccuracies that may damage your system. Use of this
- document may cause your girlfriend to leave you, your cats to
- pee on your furniture and clothing, your computer to cease
- functioning, your boss to fire you, and global thermonuclear
- war. Proceed with caution.
+ This document may contain errors
+ and inaccuracies that may damage your system, cause your partner
+ to leave you, your boss to fire you, your cats to
+ pee on your furniture and clothing, and global thermonuclear
+ war. Proceed with caution.
All copyrights are held by their respective owners, unless
@@ -100,7 +65,7 @@
team members, Netscape Communications, America Online Inc., and
any affiliated developers or sponsors assume no liability for
your use of this product. You have the source code to this
- product, and are responsible for auditing it yourself to insure
+ product, and are responsible for auditing it yourself to ensure
your security needs are met.
@@ -110,7 +75,8 @@
New Versions
- This is the &bzg-ver; version of The Bugzilla Guide. If you are
+ This is the &bzg-ver; version of The Bugzilla Guide. It is so named
+ to match the current version of Bugzilla. If you are
reading this from any source other than those below, please
check one of these mirrors to make sure you are reading an
up-to-date version of the Guide.
@@ -134,9 +100,16 @@
- The latest version of this document can be checked out via CVS.
- Please follow the instructions available at the Mozilla CVS page, and check out the mozilla/webtools/bugzilla/docs/ branch.
+ The latest version of this document can always be checked out via CVS.
+ Please follow the instructions available at
+ the Mozilla CVS page,
+ and check out the mozilla/webtools/bugzilla/docs/
+ subtree.
+
+
+ The Bugzilla Guide is currently only available in English.
+ If you would like to volunteer to translate it, please contact
+ Dave Miller.
@@ -144,13 +117,14 @@
Credits
The people listed below have made enormous contributions to the
- creation of this Guide, through their dedicated hacking efforts,
+ creation of this Guide, through their writing, dedicated hacking efforts,
numerous e-mail and IRC support sessions, and overall excellent
contribution to the Bugzilla community:
Matthew P. Barnson
- for pulling together the Bugzilla Guide and shepherding it to 2.14.
+ for the Herculaean task of pulling together the Bugzilla Guide and
+ shepherding it to 2.14.
Terry Weissman
@@ -158,13 +132,13 @@
README upon which the UNIX installation documentation is largely based.
- Tara
- Hernandez for keeping Bugzilla development going
- strong after Terry left Mozilla.org
+ Tara Hernandez
+ for keeping Bugzilla development going
+ strong after Terry left mozilla.org
- Dave Lawrence for
- providing insight into the key differences between Red Hat's
+ Dave Lawrence
+ for providing insight into the key differences between Red Hat's
customized Bugzilla, and being largely responsible for the "Red
Hat Bugzilla" appendix
@@ -174,8 +148,8 @@
questions and arguments on irc.mozilla.org in #mozwebtools
- Last but not least, all the members of the netscape.public.mozilla.webtools newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened.
+ Last but not least, all the members of the
+ netscape.public.mozilla.webtools newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened.
Thanks also go to the following people for significant contributions
@@ -183,19 +157,7 @@
Zach Liption, Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen,
- Ron Teitelbaum, Jacob Steenhagen, Joe Robins.
-
-
-
-
- Translations
-
- The Bugzilla Guide needs translators! Please volunteer your
- translation into the language of your choice. If you will
- translate this Guide, please notify the members of the
- mozilla-webtools mailing list at
- mozilla-webtools@mozilla.org, and arrange with
- &bzg-auth; to check it into CVS.
+ Ron Teitelbaum, Jacob Steenhagen, Joe Robins, Gervase Markham.
diff --git a/docs/sgml/administration.sgml b/docs/sgml/administration.sgml
index cf52999e4c..ec422e2114 100644
--- a/docs/sgml/administration.sgml
+++ b/docs/sgml/administration.sgml
@@ -2,26 +2,11 @@
Administering Bugzilla
- Or, I just got this cool thing installed. Now what the heck do I
- do with it?
-
- So you followed
-
-
-
-
- to the letter, and logged into Bugzilla for the very first time with your
- super-duper god account. You sit, contentedly staring at the Bugzilla Query
- Screen, the worst of the whole mad business of installing this terrific
- program behind you. It seems, though, you have nothing yet to query! Your
- first act of business should be to setup the operating parameters for
- Bugzilla so you can get busy getting data into your bug tracker.
-
Post-Installation Checklist
- After installation, follow the checklist below to help ensure that
- you have a successful installation. If you do not see a recommended
+ After installation, follow the checklist below.
+ If you do not see a recommended
setting for a parameter, consider leaving it at the default while you
perform your initial tests on your Bugzilla setup.
@@ -31,185 +16,124 @@
- Bring up
- editparams.cgi
-
- in your web browser. This should be available as the
- edit parameters
-
- link from any Bugzilla screen once you have logged in.
+ Log in to Bugzilla using the username and password
+ you defined for the administrator during installation.
- The
- maintainer
-
- is the email address of the person responsible for maintaining this
- Bugzilla installation. The maintainer need not be a valid Bugzilla
- user. Error pages, error emails, and administrative mail will be sent
- with the maintainer as the return email address.
-
- Set
- maintainer
-
- to
- your
-
- email address. This allows Bugzilla's error messages to display your
- email address and allow people to contact you for help.
+ Bring up
+ editparams.cgi
+ in your web browser (link in footer.) This screen allows you
+ to change most of Bugzilla's operating parameters. Each comes
+ with an explanation, and you should go down the list, deciding
+ on what you want to do about each.
+
- The
- urlbase
-
- parameter defines the fully qualified domain name and web server path
- to your Bugzilla installation.
-
- For example, if your bugzilla query page is
- http://www.foo.com/bugzilla/query.cgi, set your
- urlbase
-
- is http://www.foo.com/bugzilla/.
+
+ maintainer:
+ The maintainer parameter is the email address of the person
+ responsible for maintaining this
+ Bugzilla installation. The address need not be that of a valid Bugzilla
+ account.
- usebuggroups
+ urlbase:
+ This parameter defines the fully qualified domain name and web
+ server path to your Bugzilla installation.
+
+ For example, if your Bugzilla query page is
+ http://www.foo.com/bugzilla/query.cgi,
+ set your urlbase
+ to http://www.foo.com/bugzilla/.
+
- dictates whether or not to implement group-based security for
- Bugzilla. If set, Bugzilla bugs can have an associated groupmask
- defining which groups of users are allowed to see and edit the
+
+
+ usebuggroups:
+ Thisdictates whether or not to implement group-based security for
+ Bugzilla. If set, Bugzilla bugs can have an associated 'group',
+ defining which users are allowed to see and edit the
bug.Set "usebuggroups" to "on"
only
-
- if you may wish to restrict access to products. I suggest leaving
- this parameter
- off
-
+ if you may wish to restrict access to particular bugs to certain
+ groups of users. I suggest leaving
+ this parameter off
while initially testing your Bugzilla.
- usebuggroupsentry
-
- , when set to
- on
-
- , requires that all bugs have an associated groupmask when submitted.
- This parameter is made for those installations where product
- isolation is a necessity.
-
- Set "usebuggroupsentry" to "on" if you absolutely need to
- restrict access to bugs from the moment they are submitted through
- resolution. Once again, if you are simply testing your installation,
- I suggest against turning this parameter on; the strict security
- checking may stop you from being able to modify your new
- entries.
+ usebuggroupsentry:
+ When set to on, this
+ puts all bugs be placed in the group for their product immediately
+ after creation.
- You run into an interesting problem when Bugzilla reaches a
+
+ shadowdb:
+ You run into an interesting problem when Bugzilla reaches a
high level of continuous activity. MySQL supports only table-level
write locking. What this means is that if someone needs to make a
change to a bug, they will lock the entire table until the operation
is complete. Locking for write also blocks reads until the write is
complete. The
shadowdb
-
parameter was designed to get around this limitation. While only a
single user is allowed to write to a table at a time, reads can
continue unimpeded on a read-only shadow copy of the database.
Although your database size will double, a shadow database can cause
an enormous performance improvement when implemented on extremely
high-traffic Bugzilla databases.
+
+
+ As a guide, mozilla.org began needing
+ shadowdb
+ when they reached around 40,000 Bugzilla users with several hundred
+ Bugzilla bug changes and comments per day.
- Set "shadowdb" to "bug_shadowdb" if you will be running a
- *very* large installation of Bugzilla. The shadow database enables
- many simultaneous users to read and write to the database without
- interfering with one another.
+ The value of the parameter defines the name of the
+ shadow bug database.
+ Set "shadowdb" to e.g. "bug_shadowdb" if you will be running a
+ *very* large installation of Bugzilla.
Enabling "shadowdb" can adversely affect the stability of
your installation of Bugzilla. You should regularly check that your
database is in sync. It is often advisable to force a shadow
database sync nightly via
- cron
-
- .
+ cron.
+
-
- Once again, in testing you should avoid this option -- use it if or
- when you
- need
-
- to use it, and have repeatedly run into the problem it was designed
- to solve -- very long wait times while attempting to commit a change
- to the database. Mozilla.org began needing
- shadowdb
-
- when they reached around 40,000 Bugzilla users with several hundred
- Bugzilla bug changes and comments per day.
-
+
+
If you use the "shadowdb" option, it is only natural that you
- should turn the "queryagainstshadowdb" option "On" as well. Otherwise
+ should turn the "queryagainstshadowdb" option on as well. Otherwise
you are replicating data into a shadow database for no reason!
+
- headerhtml
-
- ,
- footerhtml
-
- ,
- errorhtml
-
- ,
- bannerhtml
-
- , and
- blurbhtml
-
- are all templates which control display of headers, footers, errors,
- banners, and additional data. We could go into some detail regarding
- the usage of these, but it is really best just to monkey around with
- them a bit to see what they do. I strongly recommend you copy your
- data/params
-
- file somewhere safe before playing with these values, though. If they
- are changed dramatically, it may make it impossible for you to
- display Bugzilla pages to fix the problem until you have restored
- your
- data/params
-
- file.
-
- If you have custom logos or HTML you must put in place to fit
- within your site design guidelines, place the code in the
- "headerhtml", "footerhtml", "errorhtml", "bannerhtml", or "blurbhtml"
- text boxes.
-
- The "headerhtml" text box is the HTML printed out
- before
+ shutdownhtml:
- any other code on the page, except the CONTENT-TYPE header sent by
- the Bugzilla engine. If you have a special banner, put the code for
- it in "bannerhtml". You may want to leave these settings at the
- defaults initially.
-
+ If you need to shut down Bugzilla to perform administration, enter
+ some descriptive HTML here and anyone who tries to use Bugzilla will
+ receive a page to that effect.
- passwordmail
+ passwordmail:
- is rather simple. Every time a user creates an account, the text of
- this parameter is read as the text to send to the new user along with
+ Every time a user creates an account, the text of
+ this parameter (with substitutions) is sent to the new user along with
their password message.Add any text you wish to the "passwordmail" parameter box. For
@@ -219,45 +143,29 @@
- useqacontact
+ useqacontact:
- allows you to define an email address for each component, in addition
+ This allows you to define an email address for each component, in
+ addition
to that of the default owner, who will be sent carbon copies of
- incoming bugs. The critical difference between a QA Contact and an
- Owner is that the QA Contact follows the component. If you reassign a
- bug from component A to component B, the QA Contact for that bug will
- change with the reassignment, regardless of owner.
-
+ incoming bugs.
+
+
- usestatuswhiteboard
-
- defines whether you wish to have a free-form, overwritable field
+ usestatuswhiteboard:
+ This defines whether you wish to have a free-form, overwritable field
associated with each bug. The advantage of the Status Whiteboard is
that it can be deleted or modified with ease, and provides an
easily-searchable field for indexing some bugs that have some trait
- in common. Many people will put
- help wanted
-
- ,
- stalled
-
- , or
- waiting on reply from somebody
-
- messages into the Status Whiteboard field so those who peruse the
- bugs are aware of their status even more than that which can be
- indicated by the Resolution fields.
-
- Do you want to use the QA Contact ("useqacontact") and status
- whiteboard ("usestatuswhiteboard") fields? These fields are useful
- because they allow for more flexibility, particularly when you have
- an existing Quality Assurance and/or Release Engineering team, but
- they may not be needed for many smaller installations.
+ in common.
+
- Set "whinedays" to the amount of days you want to let bugs go
- in the "New" or "Reopened" state before notifying people they have
+
+ whinedays:
+ Set this to the number of days you want to let bugs go
+ in the NEW or REOPENED state before notifying people they have
untouched new bugs. If you do not plan to use this feature, simply do
not set up the whining cron job described in the installation
instructions, or set this value to "0" (never whine).
@@ -265,8 +173,8 @@
- commenton
-
+ commenton*:
+ All these
fields allow you to dictate what changes can pass without comment,
and which must have a comment from the person who changed them.
Often, administrators will allow users to add themselves to the CC
@@ -288,30 +196,17 @@
- The
- supportwatchers
+
+ supportwatchers:
- option can be an exceptionally powerful tool in the hands of a power
- Bugzilla user. By enabling this option, you allow users to receive
- email updates whenever other users receive email updates. This is, of
+ Turning on this option allows users to ask to receive copies of
+ all a particular other user's bug email. This is, of
course, subject to the groupset restrictions on the bug; if the
watcher
-
would not normally be allowed to view a bug, the watcher cannot get
around the system by setting herself up to watch the bugs of someone
- with bugs outside her privileges. She would still only receive email
- updates for those bugs she could normally view.
-
- For Bugzilla sites which require strong inter-Product security
- to prevent snooping, watchers are not a good idea.
-
- However, for most sites you should set
- supportwatchers
-
- to "On". This feature is helpful for team leads to monitor progress
- in their respective areas, and can offer many other benefits, such as
- allowing a developer to pick up a former engineer's bugs without
- requiring her to change all the information in the bug.
+ with bugs outside her privileges. They would still only receive email
+ updates for those bugs she could normally view.
diff --git a/docs/sgml/conventions.sgml b/docs/sgml/conventions.sgml
index f6aa003387..4b03286427 100644
--- a/docs/sgml/conventions.sgml
+++ b/docs/sgml/conventions.sgml
@@ -6,7 +6,7 @@
conventions
- This document uses the following conventions
+ This document uses the following conventions:
@@ -34,7 +34,7 @@
- Warm jar lids under the hot tap to loosen them.
+ Would you like a breath mint?
@@ -140,7 +140,6 @@
para
-
Beginning and end of paragraph
para
diff --git a/docs/sgml/installation.sgml b/docs/sgml/installation.sgml
index 8cadbdd587..27291dad78 100644
--- a/docs/sgml/installation.sgml
+++ b/docs/sgml/installation.sgml
@@ -1,1729 +1,1434 @@
+
+ Installation
-
- Installation
-
- These installation instructions are presented assuming you are
- installing on a UNIX or completely POSIX-compliant system. If
- you are installing on Microsoft Windows or another oddball
- operating system, please consult the appropriate sections in
- this installation guide for notes on how to be successful.
-
-
- ERRATA
- Here are some miscellaneous notes about possible issues you
- main run into when you begin your Bugzilla installation.
- Reference platforms for Bugzilla installation are Redhat Linux
- 7.2, Linux-Mandrake 8.0, and Solaris 8.
-
-
-
- If you are installing Bugzilla on S.u.S.e. Linux, or some
- other distributions with paranoid security
- options, it is possible that the checksetup.pl script may fail
- with the error: cannot chdir(/var/spool/mqueue):
- Permission denied This is because your
- /var/spool/mqueue directory has a mode of
- drwx------. Type chmod 755
- /var/spool/mqueue as root to
- fix this problem.
-
-
-
- Bugzilla may be installed on Macintosh OS X (10), which is a
- unix-based (BSD) operating system. Everything required for
- Bugzilla on OS X will install cleanly, but the optional GD
- perl module which is used for bug charting requires some
- additional setup for installation. Please see the Mac OS X
- installation section below for details
-
-
-
- Release Notes for Bugzilla &bz-ver; are available at
- docs/rel_notes.txt in your Bugzilla
- source distribution.
-
-
-
- The preferred documentation for Bugzilla is available in
- docs/, with a variety of document types available. Please
- refer to these documents when installing, configuring, and
- maintaining your Bugzilla installation.
-
-
-
-
-
-
- Bugzilla is not a package where you can just plop it in a directory,
- twiddle a few things, and you're off. Installing Bugzilla assumes you
- know your variant of UNIX or Microsoft Windows well, are familiar with the
- command line, and are comfortable compiling and installing a plethora
- of third-party utilities. To install Bugzilla on Win32 requires
- fair Perl proficiency, and if you use a webserver other than Apache you
- should be intimately familiar with the security mechanisms and CGI
- environment thereof.
-
-
-
-
-
- Bugzilla has not undergone a complete security review. Security holes
- may exist in the code. Great care should be taken both in the installation
- and usage of this software. Carefully consider the implications of
- installing other network services with Bugzilla.
-
-
-
-
Step-by-step Install
+
Introduction
-
- Installation of bugzilla is pretty straightforward, particularly if your
- machine already has MySQL and the MySQL-related perl packages installed.
- If those aren't installed yet, then that's the first order of business. The
- other necessary ingredient is a web server set up to run cgi scripts.
- While using Apache for your webserver is not required, it is recommended.
-
-
-
- Bugzilla has been successfully installed under Solaris, Linux,
- and Win32. The peculiarities of installing on Win32 (Microsoft
- Windows) are not included in this section of the Guide; please
- check out the for further advice
- on getting Bugzilla to work on Microsoft Windows.
-
-
-
- The Bugzilla Guide is contained in the "docs/" folder in your
- Bugzilla distribution. It is available in plain text
- (docs/txt), HTML (docs/html), or SGML source (docs/sgml).
-
+
+ Bugzilla has been successfully installed under Solaris, Linux,
+ and Win32. Win32 is not yet officially supported, but many people
+ have got it working fine.
+ Please see the
+
+ for further advice on getting Bugzilla to work on Microsoft
+ Windows.
+
+
- Installing the Prerequisites
+ Package List
+
- If you want to skip these manual installation steps for
- the CPAN dependencies listed below, and are running the very
- most recent version of Perl and MySQL (both the executables
- and development libraries) on your system, check out
- Bundle::Bugzilla in
+ If you are running the very most recent
+ version of Perl and MySQL (both the executables and development
+ libraries) on your system, you can skip these manual installation
+ steps for the Perl modules by using Bundle::Bugzilla in
+ .
+
+
+
+ The software packages necessary for the proper running of
+ Bugzilla are:
+
+
+ MySQL database server and the mysql client (3.22.5 or
+ greater)
+
+
+
+ Perl (5.005 or greater, 5.6.1 is recommended if you wish to
+ use Bundle::Bugzilla)
+
+
+
+ Perl Modules (minimum version):
+
+
+ Template (v2.07)
+
+
+
+ AppConfig (v1.52)
+
+
+
+ Text::Wrap (v2001.0131)
+
+
+
+ File::Spec (v0.8.2)
+
+
+
+ Data::Dumper (any)
+
+
+
+ DBD::mysql (v1.2209)
+
+
+
+ DBI (v1.13)
+
+
+
+ Date::Parse (any)
+
+
+
+ CGI::Carp (any)
+
+
+
+ and, optionally:
+
+
+ GD (v1.19) for bug charting
+
+
+
+ Chart::Base (v0.99c) for bug charting
+
+
+
+ XML::Parser (any) for the XML interface
+
+
+
+ MIME::Parser (any) for the email interface
+
+
+
+
+
+
+
+ The web server of your choice. Apache is recommended.
+
+
+
+
+
+ It is a good idea, while installing Bugzilla, to ensure that there
+ is some kind of firewall between you and the rest of the Internet,
+ because your machine may be insecure for periods during the install.
+ Many
+ installation steps require an active Internet connection to complete,
+ but you must take care to ensure that at no point is your machine
+ vulnerable to an attack.
+
+
+
+ Linux-Mandrake 8.0 includes every
+ required and optional library for Bugzilla. The easiest way to
+ install them is by using the
+ urpmi
+
+ utility. If you follow these commands, you should have everything you
+ need for Bugzilla, and
+ checksetup.pl
+
+ should not complain about any missing libraries. You may already have
+ some of these installed.
+
+
+
+ bash#
+
+ urpmi perl-mysql
+
+
+
+ bash#
+
+ urpmi perl-chart
+
+
+
+ bash#
+
+ urpmi perl-gd
+
+
+
+ bash#
+
+ urpmi perl-MailTools
+
+ (for Bugzilla email integration)
+
+
+ bash#
+
+ urpmi apache-modules
+
+
-
- The software packages necessary for the proper running of bugzilla are:
-
-
-
- MySQL database server and the mysql client (3.22.5 or greater)
-
-
-
-
- Perl (5.004 or greater, 5.6.1 is recommended if you wish
- to use Bundle::Bugzilla)
-
-
-
-
- DBI Perl module
-
-
-
-
- Data::Dumper Perl module
-
-
-
-
- Bundle::Mysql Perl module collection
-
-
-
-
- TimeDate Perl module collection
-
-
-
-
- GD perl module (1.8.3) (optional, for bug charting)
-
-
-
-
- Chart::Base Perl module (0.99c) (optional, for bug charting)
-
-
-
-
- DB_File Perl module (optional, for bug charting)
-
-
-
-
- The web server of your choice. Apache is recommended.
-
-
-
-
- MIME::Parser Perl module (optional, for contrib/bug_email.pl interface)
-
-
-
-
-
-
- It is a good idea, while installing Bugzilla, to ensure it
- is not accessible by other machines
- on the Internet. Your machine may be vulnerable to attacks
- while you are installing. In other words, ensure there is
- some kind of firewall between you and the rest of the
- Internet. Many installation steps require an active
- Internet connection to complete, but you must take care to
- ensure that at no point is your machine vulnerable to an
- attack.
-
-
-
- Linux-Mandrake 8.0, the author's test system, includes
- every required and optional library for Bugzilla. The
- easiest way to install them is by using the
- urpmi utility. If you follow these
- commands, you should have everything you need for
- Bugzilla, and checksetup.pl should
- not complain about any missing libraries. You may already
- have some of these installed.
-
- bash# urpmi
- perl-mysql
- bash# urpmi
- perl-chart
- bash# urpmi
- perl-gd
- bash# urpmi
- perl-MailTools (for Bugzilla email
- integration)
- bash# urpmi
- apache-modules
-
-
-
+
- Installing MySQL Database
-
- Visit MySQL homepage at www.mysql.com and grab the latest stable release of the server. Many of the binary versions of MySQL store their data files in /var which is often part of a smaller root partition. If you decide to build from sources you can easily set the dataDir as an option to configure.
-
-
- If you install from source or non-package (RPM, deb, etc.)
- binaries you need to add
- mysqld to your
- init scripts so the server daemon will come back up whenever
- your machine reboots. Further discussion of UNIX init
- sequences are beyond the scope of this guide.
-
- You should have your init script start
- mysqld with the ability to accept
- large packets. By default, mysqld
- only accepts packets up to 64K long. This limits the size
- of attachments you may put on bugs. If you add to the command that starts
- mysqld (or
- safe_mysqld), then you will be able
- to have attachments up to about 1 megabyte.
-
+ MySQL
+ Visit the MySQL homepage at
+ www.mysql.com
+ to grab and install the latest stable release of the server.
+
-
- If you plan on running Bugzilla and MySQL on the same
- machine, consider using the
- option in the init script. This enhances security by
- preventing network access to MySQL.
-
+ Many of the binary
+ versions of MySQL store their data files in
+ /var.
+ On some Unix systems, this is part of a smaller root partition,
+ and may not have room for your bug database. If you decide to build
+ from sources you can easily set the dataDir as an option to
+ configure.
+
+ If you install from source or non-package (RPM, deb, etc.)
+ binaries you need to add
+ mysqld
+ to your init scripts so the server daemon will come back up whenever
+ your machine reboots. Further discussion of UNIX init sequences are
+ beyond the scope of this guide.
+
+
+ Change your init script to start
+ mysqld
+ with the ability to accept large packets. By default,
+ mysqld
+ only accepts packets up to 64K long. This limits the size of
+ attachments you may put on bugs. If you add
+
+ to the command that starts
+ mysqld
+ (or safe_mysqld),
+ then you will be able to have attachments up to about 1 megabyte.
+ There is a Bugzilla parameter for maximum attachment size;
+ you should configure it to match the value you choose here.
+
+ If you plan on running Bugzilla and MySQL on the same machine,
+ consider using the
+
+ option in the init script. This enhances security by preventing
+ network access to MySQL.
+
-
+
- Perl (5.004 or greater)
-
- Any machine that doesn't have perl on it is a sad machine
- indeed. Perl for *nix systems can be gotten in source form
- from http://www.perl.com. Although Bugzilla runs with most
- post-5.004 versions of Perl, it's a good idea to be up to the
- very latest version if you can when running Bugzilla. As of
- this writing, that is perl version &perl-ver;.
-
-
- Perl is now a far cry from the the single compiler/interpreter
- binary it once was. It includes a great many required modules
- and quite a few other support files. If you're not up to or
- not inclined to build perl from source, you'll want to install
- it on your machine using some sort of packaging system (be it
- RPM, deb, or what have you) to ensure a sane install. In the
- subsequent sections you'll be installing quite a few perl
- modules; this can be quite ornery if your perl installation
- isn't up to snuff.
+ Perl
+
+ Any machine that doesn't have Perl on it is a sad machine indeed.
+ Perl can be got in source form from
+ perl.com for the rare
+ *nix systems which don't have it.
+ Although Bugzilla runs with all post-5.005
+ versions of Perl, it's a good idea to be up to the very latest version
+ if you can when running Bugzilla. As of this writing, that is Perl
+ version &perl-ver;.
+
+
+
+ You can skip the following Perl module installation steps by
+ installing
+ Bundle::Bugzilla
+
+ from
+ CPAN,
+ which installs all required modules for you.
+ If you wish to use
+ Bundle::Bugzilla, you must be using the latest version of
+ Perl.
+
+
+
+ bash#
+
+ perl -MCPAN -e 'install "Bundle::Bugzilla"'
+
+
+
+ Bundle::Bugzilla doesn't include GD, Chart::Base, or
+ MIME::Parser, which are not essential to a basic Bugzilla install. If
+ installing this bundle fails, you should install each module
+ individually to isolate the problem.
+
+
+
+
+ Perl Modules
+
+
+ All Perl modules can be found on the
+ Comprehensive Perl Archive Network (CPAN) at http://www.cpan.org. The
+ CPAN servers have a real tendency to bog down, so please use mirrors.
+ The current location at the time of this writing can be found in
+ .
+
+
+ Quality, general Perl module installation instructions can be
+ found on the CPAN website, but the easy thing to do is to just use the
+ CPAN shell which does all the hard work for you.
+
+ To use the CPAN shell to install a module:
+
+
+
+ bash#
+ perl -MCPAN -e 'install "<modulename>"'
+
+
+
+
+ To do it the hard way:
+
+ Untar the module tarball -- it should create its own
+ directory
+
+ CD to the directory just created, and enter the following
+ commands:
+
+
+
+
+ bash#
+
+ perl Makefile.PL
+
+
+
+
+
+
+
+ bash#
+
+ make
+
+
+
+
+
+
+
+ bash#
+
+ make test
+
+
+
+
+
+
+
+ bash#
+
+ make install
+
+
+
+
+
+
+
- Many people complain that Perl modules will not install
- for them. Most times, the error messages complain that they
- are missing a file in @INC. Virtually every
- time, this is due to permissions being set too restrictively
- for you to compile Perl modules or not having the necessary
- Perl development libraries installed on your system..
- Consult your local UNIX systems administrator for help
- solving these permissions issues; if you
- are the local UNIX sysadmin, please
- consult the newsgroup/mailing list for further assistance or
- hire someone to help you out.
-
+ Many people complain that Perl modules will not install for
+ them. Most times, the error messages complain that they are missing a
+ file in
+ @INC.
+ Virtually every time, this error is due to permissions being set too
+ restrictively for you to compile Perl modules or not having the
+ necessary Perl development libraries installed on your system.
+ Consult your local UNIX systems administrator for help solving these
+ permissions issues; if you
+ are
+ the local UNIX sysadmin, please consult the newsgroup/mailing list
+ for further assistance or hire someone to help you out.
-
-
- You can skip the following Perl module installation steps by
- installing Bundle::Bugzilla from
- CPAN, which
- includes them. All Perl module installation steps require
- you have an active Internet connection. If you wish to use
- Bundle::Bugzilla, however, you must be using the latest
- version of Perl (at this writing, version &perl-ver;)
-
-
- bash#perl -MCPAN
- -e 'install "Bundle::Bugzilla"'
-
-
-
- Bundle::Bugzilla doesn't include GD, Chart::Base, or
- MIME::Parser, which are not essential to a basic Bugzilla
- install. If installing this bundle fails, you should
- install each module individually to isolate the problem.
-
-
+
+
+
+ DBI
+
+ The DBI module is a generic Perl module used the
+ MySQL-related modules. As long as your Perl installation was done
+ correctly the DBI module should be a breeze. It's a mixed Perl/C
+ module, but Perl's MakeMaker system simplifies the C compilation
+ greatly.
-
+
- DBI Perl Module
-
- The DBI module is a generic Perl module used by other database related
- Perl modules. For our purposes it's required by the MySQL-related
- modules. As long as your Perl installation was done correctly the
- DBI module should be a breeze. It's a mixed Perl/C module, but Perl's
- MakeMaker system simplifies the C compilation greatly.
-
-
- Like almost all Perl modules DBI can be found on the Comprehensive Perl
- Archive Network (CPAN) at http://www.cpan.org. The CPAN servers have a
- real tendency to bog down, so please use mirrors. The current location
- at the time of this writing can be found in .
-
-
- Quality, general Perl module installation instructions can be found on
- the CPAN website, but the easy thing to do is to just use the CPAN shell
- which does all the hard work for you.
-
-
- To use the CPAN shell to install DBI:
-
-
-
- bash#
- perl -MCPAN -e 'install "DBI"'
-
-
- Replace "DBI" with the name of whichever module you wish
- to install, such as Data::Dumper, TimeDate, GD, etc.
-
-
-
- To do it the hard way:
-
-
- Untar the module tarball -- it should create its own directory
-
-
- CD to the directory just created, and enter the following commands:
-
-
-
-
- bash#
- perl Makefile.PL
-
-
-
-
-
-
- bash#
- make
-
-
-
-
-
-
- bash#
- make test
-
-
-
-
-
-
- bash#
- make install
-
-
-
-
- If everything went ok that should be all it takes. For the vast
- majority of perl modules this is all that's required.
-
-
-
+ Data::Dumper
+
+ The Data::Dumper module provides data structure persistence for
+ Perl (similar to Java's serialization). It comes with later
+ sub-releases of Perl 5.004, but a re-installation just to be sure it's
+ available won't hurt anything.
+
- Data::Dumper Perl Module
-
- The Data::Dumper module provides data structure persistence for Perl
- (similar to Java's serialization). It comes with later sub-releases of
- Perl 5.004, but a re-installation just to be sure it's available won't
- hurt anything.
-
-
- Data::Dumper is used by the MySQL-related Perl modules. It
- can be found on CPAN (see ) and
- can be
- installed by following the same four step make sequence used
- for the DBI module.
+ MySQL-related modules
+
+ The Perl/MySQL interface requires a few mutually-dependent Perl
+ modules. These modules are grouped together into the the
+ Msql-Mysql-modules package.
+
+ The MakeMaker process will ask you a few questions about the
+ desired compilation target and your MySQL installation. For most of the
+ questions the provided default will be adequate, but when asked if your
+ desired target is the MySQL or mSQL packages, you should
+ select the MySQL related ones. Later you will be asked if you wish to
+ provide backwards compatibility with the older MySQL packages; you
+ should answer YES to this question. The default is NO.
+
+ A host of 'localhost' should be fine and a testing user of 'test'
+ with a null password should find itself with sufficient access to run
+ tests on the 'test' database which MySQL created upon installation.
-
+
- MySQL related Perl Module Collection
-
- The Perl/MySQL interface requires a few mutually-dependent perl
- modules. These modules are grouped together into the the
- Msql-Mysql-modules package. This package can be found at CPAN.
- After the archive file has been downloaded it should
- be untarred.
-
-
- The MySQL modules are all built using one make file which is generated
- by running:
- bash#
- perl Makefile.pl
-
-
- The MakeMaker process will ask you a few questions about the desired
- compilation target and your MySQL installation. For many of the questions
- the provided default will be adequate.
-
-
- When asked if your desired target is the MySQL or mSQL packages,
- select the MySQL related ones. Later you will be asked if you wish
- to provide backwards compatibility with the older MySQL packages; you
- should answer YES to this question. The default is NO.
-
-
- A host of 'localhost' should be fine and a testing user of 'test' and
- a null password should find itself with sufficient access to run tests
- on the 'test' database which MySQL created upon installation. If 'make
- test' and 'make install' go through without errors you should be ready
- to go as far as database connectivity is concerned.
-
-
+ TimeDate modules
-
- TimeDate Perl Module Collection
-
- Many of the more common date/time/calendar related Perl
- modules have been grouped into a bundle similar to the MySQL
- modules bundle. This bundle is stored on the CPAN under the
- name TimeDate (see link: ). The
- component module we're most interested in is the Date::Format
- module, but installing all of them is probably a good idea
- anyway. The standard Perl module installation instructions
- should work perfectly for this simple package.
-
-
-
- GD Perl Module (1.8.3)
-
- The GD library was written by Thomas Boutell a long while
- ago to programatically generate images in C. Since then it's
- become the defacto standard for programatic image
- construction. The Perl bindings to it found in the GD library
- are used on millions of web pages to generate graphs on the
- fly. That's what bugzilla will be using it for so you must
- install it if you want any of the graphing to work.
-
-
- Actually bugzilla uses the Graph module which relies on GD
- itself. Isn't that always the way with object-oriented
- programming? At any rate, you can find the GD library on CPAN
- in .
-
-
-
- The Perl GD library requires some other libraries that may
- or may not be installed on your system, including
- libpng and
- libgd. The full requirements are
- listed in the Perl GD library README. Just realize that if
- compiling GD fails, it's probably because you're missing a
- required library.
-
-
-
+ Many of the more common date/time/calendar related Perl modules
+ have been grouped into a bundle similar to the MySQL modules bundle.
+ This bundle is stored on the CPAN under the name TimeDate.
+ The component module we're most interested in is the Date::Format
+ module, but installing all of them is probably a good idea anyway.
+
+
-
- Chart::Base Perl Module (0.99c)
-
- The Chart module provides bugzilla with on-the-fly charting
- abilities. It can be installed in the usual fashion after it
- has been fetched from CPAN where it is found as the
- Chart-x.x... tarball, linked in . Note that
- as with the GD perl module, only the version listed above, or
- newer, will work. Earlier versions used GIF's, which are no
- longer supported by the latest versions of GD.
-
-
+
+ GD (optional)
-
- DB_File Perl Module
-
- DB_File is a module which allows Perl programs to make use
- of the facilities provided by Berkeley DB version 1.x. This
- module is required by collectstats.pl which is used for bug
- charting. If you plan to make use of bug charting, you must
- install this module.
-
-
+ The GD library was written by Thomas Boutell a long while ago to
+ programatically generate images in C. Since then it's become the
+ defacto standard for programatic image construction. The Perl bindings
+ to it found in the GD library are used on millions of web pages to
+ generate graphs on the fly. That's what Bugzilla will be using it for
+ so you must install it if you want any of the graphing to work.
-
- HTTP Server
-
- You have a freedom of choice here - Apache, Netscape or any
- other server on UNIX would do. You can easily run the web
- server on a different machine than MySQL, but need to adjust
- the MySQL bugs user permissions accordingly.
-
- I strongly recommend Apache as the web server to use.
- The Bugzilla Guide installation instructions, in general,
- assume you are using Apache. As more users use different
- webservers and send me information on the peculiarities of
- installing using their favorite webserver, I will provide
- notes for them.
-
-
-
- You'll want to make sure that your web server will run any
- file with the .cgi extension as a cgi and not just display it.
- If you're using apache that means uncommenting the following
- line in the srm.conf file:
-
-AddHandler cgi-script .cgi
-
-
-
- With apache you'll also want to make sure that within the
- access.conf file the line:
-
-Options ExecCGI
-AllowOverride Limit
-
- is in the stanza that covers the directories into which
- you intend to put the bugzilla .html and .cgi files.
-
-
- AllowOverride Limit allows the use of a Deny statement in the
- .htaccess file generated by checksetup.pl
-
-
- Users of newer versions of Apache will generally find both
- of the above lines will be in the httpd.conf file, rather
- than srm.conf or access.conf.
-
+ The Perl GD library requires some other libraries that may or
+ may not be installed on your system, including
+ libpng
+ and
+ libgd.
+ The full requirements are listed in the Perl GD library README.
+ If compiling GD fails, it's probably because you're
+ missing a required library.
-
-
- There are important files and directories that should not
- be a served by the HTTP server. These are most files in the
- data and shadow directories
- and the localconfig file. You should
- configure your HTTP server to not serve content from these
- files. Failure to do so will expose critical passwords and
- other data. Please see for details
- on how to do this for Apache. I appreciate notes on how to
- get this same functionality using other webservers.
-
-
-
+
-
- Installing the Bugzilla Files
-
- You should untar the Bugzilla files into a directory that
- you're willing to make writable by the default web server user
- (probably nobody). You may decide to put the
- files off of the main web space for your web server or perhaps
- off of /usr/local with a symbolic link in
- the web space that points to the Bugzilla directory. At any
- rate, just dump all the files in the same place, and make sure
- you can access the files in that directory through your web
- server.
-
-
-
- If you symlink the bugzilla directory into your Apache's
- HTML heirarchy, you may receive
- Forbidden errors unless you add the
- FollowSymLinks directive to the
- <Directory> entry for the HTML root.
-
-
-
- Once all the files are in a web accessible directory, make
- that directory writable by your webserver's user. This is a
- temporary step until you run the post-install
- checksetup.pl script, which locks down your
- installation.
-
-
- Lastly, you'll need to set up a symbolic link to
- /usr/bonsaitools/bin/perl for the correct
- location of your perl executable (probably
- /usr/bin/perl). Otherwise you must hack
- all the .cgi files to change where they look for perl, or use
- , found in
- . I suggest using the symlink
- approach for future release compatability.
-
- Setting up bonsaitools symlink
-
- Here's how you set up the Perl symlink on Linux to make
- Bugzilla work. Your mileage may vary. For some UNIX
- operating systems, you probably need to subsitute
- /usr/local/bin/perl for
- /usr/bin/perl below; if on certain other
- UNIX systems, Perl may live in weird places like
- /opt/perl. As root, run these commands:
-
-bash# mkdir /usr/bonsaitools
-bash# mkdir /usr/bonsaitools/bin
-bash# ln -s /usr/bin/perl /usr/bonsaitools/bin/perl
-
-
-
- Alternately, you can simply run this perl one-liner to
- change your path to perl in all the files in your Bugzilla
- installation:
-
-perl -pi -e 's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm
-processmail syncshadowdb
-
- Change the second path to perl to match your installation.
-
-
-
-
- If you don't have root access to set this symlink up,
- check out the
- , listed in . It will change the path to perl in all your Bugzilla files for you.
-
-
-
-
+
+ Chart::Base (optional)
-
- Setting Up the MySQL Database
-
- After you've gotten all the software installed and working you're ready
- to start preparing the database for its life as a the back end to a high
- quality bug tracker.
-
-
- First, you'll want to fix MySQL permissions to allow access
- from Bugzilla. For the purpose of this Installation section,
- the Bugzilla username will be bugs, and will
- have minimal permissions.
-
-
-
- Bugzilla has not undergone a thorough security audit. It
- may be possible for a system cracker to somehow trick
- Bugzilla into executing a command such as DROP
- DATABASE mysql.
-
- That would be bad.
-
-
-
-
- Give the MySQL root user a password. MySQL passwords are
- limited to 16 characters.
-
-
- bash#mysql
- -u root mysql
-
-
- mysql>
- UPDATE user SET Password=PASSWORD ('new_password')
- WHERE user='root';
-
-
- mysql>FLUSH
- PRIVILEGES;
-
- From this point on, if you need to access
- MySQL as the MySQL root user, you will need to use
- mysql -u root -p and enter your
- new_password. Remember that MySQL user names have nothing to
- do with Unix user names (login names).
-
-
- Next, we create the bugs user, and grant
- sufficient permissions for checksetup.pl, which we'll use
- later, to work its magic. This also restricts the
- bugs user to operations within a database
- called bugs, and only allows the account to
- connect from localhost. Modify it to reflect
- your setup if you will be connecting from another machine or
- as a different user.
-
-
- Remember to set bugs_password to some unique password.
-
-
-
- mysql>
- GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,
- ALTER,CREATE,DROP,REFERENCES
- ON bugs.* TO bugs@localhost
- IDENTIFIED BY 'bugs_password';
-
-
-
-
-
- mysql>
-
-
- FLUSH PRIVILEGES;
-
-
-
-
-
-
- Next, run the magic checksetup.pl script. (Many thanks to
- Holger Schurig <holgerschurig@nikocity.de> for writing
- this script!) It will make sure Bugzilla files and directories
- have reasonable permissions, set up the
- data directory, and create all the MySQL
- tables.
-
-
- bash#
- ./checksetup.pl
-
- The first time you run it, it will create a
- file called localconfig.
-
+ The Chart module provides Bugzilla with on-the-fly charting
+ abilities. It can be installed in the usual fashion after it has been
+ fetched from CPAN where it is found as the Chart-x.x... tarball, linked
+ in
+ .
+ Note that earlier versions that 0.99c used GIFs, which are no longer
+ supported by the latest versions of GD.
-
+
+
- Tweaking <filename>localconfig</filename>
-
- This file contains a variety of settings you may need to tweak including
- how Bugzilla should connect to the MySQL database.
-
-
- The connection settings include:
-
-
-
- server's host: just use localhost if the
- MySQL server is local
-
-
-
-
- database name: bugs if you're following
- these directions
-
-
-
-
- MySQL username: bugs if you're following
- these directions
-
-
-
-
- Password for the bugs MySQL account above
-
-
-
-
-
- You should also install .htaccess files that the Apache
- webserver will use to restrict access to Bugzilla data files.
- See .
-
-
- Once you are happy with the settings, re-run
- checksetup.pl. On this second run, it will
- create the database and an administrator account for which
- you will be prompted to provide information.
-
-
- When logged into an administrator account once Bugzilla is
- running, if you go to the query page (off of the Bugzilla main
- menu), you'll find an edit parameters option
- that is filled with editable treats.
+ HTTP Server
+
+ You have a freedom of choice here - Apache, Netscape or any other
+ server on UNIX would do. You can run the web server on a
+ different machine than MySQL, but need to adjust the MySQL
+ bugs
+ user permissions accordingly.
+
+ We strongly recommend Apache as the web server to use. The
+ Bugzilla Guide installation instructions, in general, assume you are
+ using Apache. If you have got Bugzilla working using another webserver,
+ please share your experiences with us.
+
-
- Should everything work, you will have a nearly empty Bugzilla
- database and a newly-created localconfig
- file in your Bugzilla root directory.
+
+ You'll want to make sure that your web server will run any file
+ with the .cgi extension as a CGI and not just display it. If you're
+ using Apache that means uncommenting the following line in the srm.conf
+ file:
+ AddHandler cgi-script .cgi
-
-
-
- The second time you run checksetup.pl, you should become
- the user your web server runs as, and that you ensure that
- you set the webservergroup parameter in localconfig to
- match the web server's group name, if any. I believe,
- for the next release of Bugzilla, this will be fixed so
- that Bugzilla supports a webserveruser parameter in
- localconfig as well.
-
- Running checksetup.pl as the web user
-
- Assuming your web server runs as user "apache", and
- Bugzilla is installed in "/usr/local/bugzilla", here's
- one way to run checksetup.pl as the web server user.
- As root, for the second run of
- checksetup.pl, do this:
-
-bash# chown -R apache:apache /usr/local/bugzilla
-bash# su - apache
-bash# cd /usr/local/bugzilla
-bash# ./checksetup.pl
-
-
-
-
-
+
+ With Apache you'll also want to make sure that within the
+ access.conf file the line:
+ Options ExecCGI AllowOverride Limit
+
+ is in the stanza that covers the directories into which you intend to
+ put the bugzilla .html and .cgi files.
+
+
+ AllowOverride Limit allows the use of a Deny statement in the
+ .htaccess file generated by checksetup.pl
+
+ Users of newer versions of Apache will generally find both of
+ the above lines will be in the httpd.conf file, rather than srm.conf
+ or access.conf.
+
-
-
- The checksetup.pl script is designed so that you can run
- it at any time without causing harm. You should run it
- after any upgrade to Bugzilla.
-
-
+
+
+ There are important files and directories that should not be a
+ served by the HTTP server - most files in the
+ data
+ and
+ shadow
+ directories and the
+ localconfig
+ file. You should configure your HTTP server to not serve
+ these files. Failure to do so will expose critical passwords and
+ other data. Please see
+
+ for details on how to do this for Apache; the checksetup.pl
+ script should create appropriate .htaccess files for you.
+
-
+
- Setting Up Maintainers Manually (Optional)
-
- If you want to add someone else to every group by hand, you
- can do it by typing the appropriate MySQL commands. Run
- mysql -u root -p bugs You
- may need different parameters, depending on your security
- settings. Then:
-
-
- mysql>update
- profiles set groupset=0x7fffffffffffffff where
- login_name = 'XXX'; (yes, that's fifteenf's.
-
- replacing XXX with the Bugzilla email address.
-
-
+ Bugzilla
+
+ You should untar the Bugzilla files into a directory that you're
+ willing to make writable by the default web server user (probably
+ nobody).
+ You may decide to put the files in the main web space for your
+ web server or perhaps in
+ /usr/local
+ with a symbolic link in the web space that points to the Bugzilla
+ directory.
-
- The Whining Cron (Optional)
-
- By now you have a fully functional bugzilla, but what good
- are bugs if they're not annoying? To help make those bugs
- more annoying you can set up bugzilla's automatic whining
- system. This can be done by adding the following command as a
- daily crontab entry (for help on that see that crontab man
- page):
-
-
- cd
- <your-bugzilla-directory> ;
- ./whineatnews.pl
-
-
-
-
- Depending on your system, crontab may have several manpages.
- The following command should lead you to the most useful
- page for this purpose:
-
- man 5 crontab
-
-
+ If you symlink the bugzilla directory into your Apache's HTML
+ heirarchy, you may receive
+ Forbidden
+ errors unless you add the
+ FollowSymLinks
+ directive to the <Directory> entry for the HTML root
+ in httpd.conf.
-
-
-
- Bug Graphs (Optional)
-
- As long as you installed the GD and Graph::Base Perl modules
- you might as well turn on the nifty bugzilla bug reporting
- graphs.
-
-
- Add a cron entry like this to run collectstats daily at 5
- after midnight:
-
-
- bash#crontab
- -e
-
-
- 5 0 * * * cd
- <your-bugzilla-directory> ; ./collectstats.pl
-
-
-
-
-
- After two days have passed you'll be able to view bug graphs
- from the Bug Reports page.
+
+ Once all the files are in a web accessible directory, make that
+ directory writable by your webserver's user. This is a temporary step
+ until you run the post-install
+ checksetup.pl
+ script, which locks down your installation.
+
+ Lastly, you'll need to set up a symbolic link to
+ /usr/bonsaitools/bin/perl
+ for the correct location of your Perl executable (probably
+ /usr/bin/perl).
+ Otherwise you must hack all the .cgi files to change where they look
+ for Perl. This can be done using
+ ,
+ found in
+ , or the below one-liner.
+ I suggest using the symlink approach for future release
+ compatibility.
+
+
+ Changing the path to Perl
+ You can simply run this Perl one-liner to change
+ your path to perl in all the files in your Bugzilla installation:
+ perl -pi -e
+ 's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm
+ processmail syncshadowdb
+
+ Change /usr/bin/perl to match the location
+ of Perl on your machine.
+
-
+
- Securing MySQL
-
- If you followed the installation instructions for setting up
- your "bugs" and "root" user in MySQL, much of this should not
- apply to you. If you are upgrading an existing installation
- of Bugzilla, you should pay close attention to this section.
-
-
- Most MySQL installs have "interesting" default security parameters:
-
- mysqld defaults to running as root
- it defaults to allowing external network connections
- it has a known port number, and is easy to detect
- it defaults to no passwords whatsoever
- it defaults to allowing "File_Priv"
-
-
-
- This means anyone from anywhere on the internet can not only
- drop the database with one SQL command, and they can write as
- root to the system.
-
-
- To see your permissions do:
-
-
-
- bash#
- mysql -u root -p
-
-
-
-
- mysql>
- use mysql;
-
-
-
-
- mysql>
- show tables;
-
-
-
-
- mysql>
- select * from user;
-
-
-
-
- mysql>
- select * from db;
-
-
-
-
-
- To fix the gaping holes:
-
- DELETE FROM user WHERE User='';
- UPDATE user SET Password=PASSWORD('new_password') WHERE user='root';
- FLUSH PRIVILEGES;
-
-
-
- If you're not running "mit-pthreads" you can use:
-
- GRANT USAGE ON *.* TO bugs@localhost;
- GRANT ALL ON bugs.* TO bugs@localhost;
- REVOKE DROP ON bugs.* FROM bugs@localhost;
- FLUSH PRIVILEGES;
-
-
-
- With "mit-pthreads" you'll need to modify the "globals.pl" Mysql->Connect
- line to specify a specific host name instead of "localhost", and accept
- external connections:
-
- GRANT USAGE ON *.* TO bugs@bounce.hop.com;
- GRANT ALL ON bugs.* TO bugs@bounce.hop.com;
- REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com;
- FLUSH PRIVILEGES;
-
+ Setting Up the MySQL Database
+
+ After you've gotten all the software installed and working you're
+ ready to start preparing the database for its life as the back end to
+ a high quality bug tracker.
+
+ First, you'll want to fix MySQL permissions to allow access from
+ Bugzilla. For the purpose of this Installation section, the Bugzilla
+ username will be
+ bugs, and will have minimal permissions.
-
- Use .htaccess files with the Apache webserver to secure your
- bugzilla install. See
-
-
- Consider also:
-
-
-
- Turning off external networking with "--skip-networking",
- unless you have "mit-pthreads", in which case you can't.
- Without networking, MySQL connects with a Unix domain socket.
-
-
-
-
- using the --user= option to mysqld to run it as an unprivileged
- user.
-
-
-
-
- starting MySQL in a chroot jail
-
-
-
-
- running the httpd in a "chrooted" jail
-
-
-
-
- making sure the MySQL passwords are different from the OS
- passwords (MySQL "root" has nothing to do with system "root").
-
-
-
-
- running MySQL on a separate untrusted machine
-
-
-
-
- making backups ;-)
-
-
-
+
+ Begin by giving the MySQL root user a password. MySQL passwords are limited
+ to 16 characters.
+
+
+
+ bash#
+
+ mysql -u root mysql
+
+
+
+
+
+ mysql>
+
+ UPDATE user SET Password=PASSWORD('<new_password'>)
+ WHERE user='root';
+
+
+
+
+
+ mysql>
+
+ FLUSH PRIVILEGES;
+
+
+
+
+ From this point on, if you need to access MySQL as the MySQL root user,
+ you will need to use
+ mysql -u root -p
+
+ and enter <new_password>. Remember that MySQL user names have
+ nothing to do with Unix user names (login names).
+
+ Next, we create the
+ bugs
+
+ user, and grant sufficient permissions for checksetup.pl, which we'll
+ use later, to work its magic. This also restricts the
+ bugs
+ user to operations within a database called
+ bugs, and only allows the account to connect from
+ localhost.
+ Modify it to reflect your setup if you will be connecting from
+ another machine or as a different user.
+
+ Remember to set <bugs_password> to some unique password.
+
+
+
+ mysql>
+
+ GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,
+ ALTER,CREATE,DROP,REFERENCES ON bugs.* TO bugs@localhost
+ IDENTIFIED BY '<bugs_password>';
+
+
+
+
+
+ mysql>
+
+ FLUSH PRIVILEGES;
+
+
+
-
-
- Mac OS X Installation Notes
-
- There are a lot of common libraries and utilities out there
- that Apple did not include with Mac OS X, but which run
- perfectly well on it. The GD library, which Bugzilla needs to
- do bug graphs, is one of these.
-
-
- The easiest way to get a lot of these is with a program called
- Fink, which is similar in nature to the CPAN installer, but
- installs common GNU utilities. Fink is available from
- <http://sourceforge.net/projects/fink/>.
-
-
- Follow the instructions for setting up Fink. Once it's
- installed, you'll want to run the following as root:
- fink install gd
-
-
- It will prompt you for a number of dependencies, type 'y' and
- hit enter to install all of the dependencies. Then watch it
- work.
-
-
- To prevent creating conflicts with the software that Apple
- installs by default, Fink creates its own directory tree at
- /sw where it installs most of the software that it installs.
- This means your libraries and headers for libgd will be at
- /sw/lib and /sw/include instead of /usr/lib and
- /usr/local/include. Because of these changed locations for
- the libraries, the Perl GD module will not install directly
- via CPAN (it looks for the specific paths instead of getting
- them from your environment). But there's a way around that
- :-)
-
-
- Instead of typing install GD at the
- cpan> prompt, type look
- GD. This should go through the motions of
- downloading the latest version of the GD module, then it will
- open a shell and drop you into the build directory. Apply the
- following patch to the Makefile.PL file (save the patch into a
- file and use the command patch <
- patchfile:
-
-
-
- PATHS: CHECK AND ADJUST <=====
--my @INC = qw(-I/usr/local/include -I/usr/local/include/gd);
--my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/usr/local/lib );
-+my @INC = qw(-I/sw/include -I/sw/include/gd -I/usr/local/include -I/usr/local/include/gd);
-+my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/sw/lib -L/usr/local/lib);
- my @LIBS = qw(-lgd -lpng -lz);
-
- # FEATURE FLAGS
-@@ -23,7 +23,7 @@
-
- push @LIBS,'-lttf' if $TTF;
- push @LIBS,'-ljpeg' if $JPEG;
--push @LIBS, '-lm' unless $^O eq 'MSWin32';
-+push @LIBS, '-lm' unless ($^O =~ /^MSWin32|darwin$/);
-
- # FreeBSD 3.3 with libgd built from ports croaks if -lXpm is specified
- if ($^O ne 'freebsd' && $^O ne 'MSWin32') {
-
-]]>
-
-
-
- Then, run these commands to finish the installation of the perl module:
+
+
+
+ <filename>checksetup.pl</filename>
+
+
+ Next, run the magic checksetup.pl script. (Many thanks to
+ Holger Schurig
+ for writing this script!)
+ This script is designed to make sure your MySQL database and other
+ configuration options are consistent with the Bugzilla CGI files.
+ It will make sure Bugzilla files and directories have reasonable
+ permissions, set up the
+ data
+ directory, and create all the MySQL tables.
- perl Makefile.PL
- make
- make test
- make install
- And don't forget to run exit to get back to cpan.
+
+
+ bash#
+
+ ./checksetup.pl
+
+
-
-
- Happy Hacking!
-
-
-
-
- BSD Installation Notes
-
- For instructions on how to set up Bugzilla on FreeBSD, NetBSD, OpenBSD, BSDi, etc. please
- consult .
-
-
-
-
-
- Installation General Notes
+
+ The first time you run it, it will create a file called
+ localconfig.
+
+ This file contains a variety of settings you may need to tweak
+ including how Bugzilla should connect to the MySQL database.
+
+ The connection settings include:
+
+
+ server's host: just use
+ localhost
+
+ if the MySQL server is local
+
+
+
+ database name:
+ bugs
+
+ if you're following these directions
+
+
+
+ MySQL username:
+ bugs
+
+ if you're following these directions
+
+
+
+ Password for the
+ bugs
+
+ MySQL account (<bugs_password>) above
+
+
+
+
+ Once you are happy with the settings,
+ su to the user
+ your web server runs as, and re-run
+ checksetup.pl.
+ On this second run, it will create the database and an administrator
+ account for which you will be prompted to provide information.
+
+
+ The checksetup.pl script is designed so that you can run it at
+ any time without causing harm. You should run it after any upgrade to
+ Bugzilla.
+
+
+
- Modifying Your Running System
-
- Bugzilla optimizes database lookups by storing all relatively static
- information in the versioncache file, located in the data/ subdirectory
- under your installation directory.
+ Securing MySQL
+
+ If you followed the installation instructions for setting up your
+ "bugs" and "root" user in MySQL, much of this should not apply to you.
+ If you are upgrading an existing installation of Bugzilla, you should
+ pay close attention to this section.
+
+ Most MySQL installs have "interesting" default security
+ parameters:
+
+ mysqld defaults to running as root
+
+ it defaults to allowing external network connections
+
+ it has a known port number, and is easy to detect
+
+ it defaults to no passwords whatsoever
+
+ it defaults to allowing "File_Priv"
+
-
- If you make a change to the structural data in your database
- (the versions table for example), or to the
- constants encoded in defparams.pl, you will
- need to remove the cached content from the data directory
- (by doing a rm data/versioncache), or your
- changes won't show up.
+
+ This means anyone from anywhere on the internet can not only drop
+ the database with one SQL command, and they can write as root to the
+ system.
+
+ To see your permissions do:
+
+
+
+ bash#
+
+ mysql -u root -p
+
+
+
+
+
+ mysql>
+
+ use mysql;
+
+
+
+
+
+ mysql>
+
+ show tables;
+
+
+
+
+
+ mysql>
+
+ select * from user;
+
+
+
+
+
+ mysql>
+
+ select * from db;
+
+
+
-
- That file gets automatically regenerated whenever it's more than an
- hour old, so Bugzilla will eventually notice your changes by itself, but
- generally you want it to notice right away, so that you can test things.
+
+ To fix the gaping holes:
+
+ DELETE FROM user WHERE User='';
+
+ UPDATE user SET Password=PASSWORD('new_password') WHERE
+ user='root';
+
+ FLUSH PRIVILEGES;
+
-
-
- Upgrading From Previous Versions
-
- A plain Bugzilla is fairly easy to upgrade from one version to a newer one.
- However, things get a bit more complicated if you've made changes to
- Bugzilla's code. In this case, you may have to re-make or reapply those
- changes.
- It is recommended that you take a backup of your database and your entire
- Bugzilla installation before attempting an upgrade. You can upgrade a 'clean'
- installation by untarring a new tarball over the old installation. If you
- are upgrading from 2.12 or later, you can type cvs -z3
- update, and resolve conflicts if there are any.
+
+ If you're not running "mit-pthreads" you can use:
+
+ GRANT USAGE ON *.* TO bugs@localhost;
+
+ GRANT ALL ON bugs.* TO bugs@localhost;
+
+ REVOKE DROP ON bugs.* FROM bugs@localhost;
+
+ FLUSH PRIVILEGES;
+
-
- Because the developers of Bugzilla are constantly adding new tables, columns
- and fields, you'll probably get SQL errors if you just update the code and
- attempt to use Bugzilla. Always run the checksetup.pl script whenever
- you upgrade your installation.
+
+ With "mit-pthreads" you'll need to modify the "globals.pl"
+ Mysql->Connect line to specify a specific host name instead of
+ "localhost", and accept external connections:
+
+ GRANT USAGE ON *.* TO bugs@bounce.hop.com;
+
+ GRANT ALL ON bugs.* TO bugs@bounce.hop.com;
+
+ REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com;
+
+ FLUSH PRIVILEGES;
+
-
- If you are running Bugzilla version 2.8 or lower, and wish to upgrade to
- the latest version, please consult the file, "UPGRADING-pre-2.8" in the
- Bugzilla root directory after untarring the archive.
+
+ Consider also:
+
+
+ Turning off external networking with "--skip-networking",
+ unless you have "mit-pthreads", in which case you can't. Without
+ networking, MySQL connects with a Unix domain socket.
+
+
+
+ using the --user= option to mysqld to run it as an
+ unprivileged user.
+
+
+
+ running MySQL in a chroot jail
+
+
+
+ running the httpd in a chroot jail
+
+
+
+ making sure the MySQL passwords are different from the OS
+ passwords (MySQL "root" has nothing to do with system
+ "root").
+
+
+
+ running MySQL on a separate untrusted machine
+
+
+
+ making backups ;-)
+
+
-
- <filename>.htaccess</filename> files and security
-
- To enhance the security of your Bugzilla installation,
- Bugzilla will generate
- .htaccess files
- which the Apache webserver can use to restrict access to
- the bugzilla data files. The checksetup script will
- generate the .htaccess files. These .htaccess files
- will not work with Apache 1.2.x - but this has security holes, so you
- shouldn't be using it anyway.
-
-
-
- If you are using an alternate provider of
- webdot services for graphing
- (as described when viewing
- editparams.cgi in your web
- browser), you will need to change the ip address in
- data/webdot/.htaccess to the ip
- address of the webdot server that you are using.
-
-
-
-
+
+ Optional Additional Configuration
+
+
+ The Whining Cron
+
+ By now you have a fully functional Bugzilla, but what good are
+ bugs if they're not annoying? To help make those bugs more annoying you
+ can set up Bugzilla's automatic whining system to complain at engineers
+ which leave their bugs in the NEW state without triaging them.
+
+
+ This can be done by
+ adding the following command as a daily crontab entry (for help on that
+ see that crontab man page):
+
+
+
+ cd <your-bugzilla-directory> ;
+ ./whineatnews.pl
+
+
+
+
+
+
+ Depending on your system, crontab may have several manpages.
+ The following command should lead you to the most useful page for
+ this purpose:
+ man 5 crontab
+
+
+
+
+
+ Bug Graphs
+
+ As long as you installed the GD and Graph::Base Perl modules you
+ might as well turn on the nifty Bugzilla bug reporting graphs.
+
+ Add a cron entry like this to run
+ collectstats.pl
+ daily at 5 after midnight:
+
+
+
+ bash#
+
+ crontab -e
+
+
+
+
+ 5 0 * * * cd <your-bugzilla-directory> ;
+ ./collectstats.pl
+
+
+
+
+ After two days have passed you'll be able to view bug graphs from
+ the Bug Reports page.
+
+
+
+
+
+ Win32 Installation Notes
+
+ This section covers installation on Microsoft Windows 95, 98, ME,
+ NT, and 2000. Bugzilla works fine on Win32 platforms, but please remember
+ that the Bugzilla team and the author of the Guide neither endorse nor
+ support installation on Microsoft Windows. Bugzilla installs and runs
+ best
+
+ and
+ easiest
+
+ on UNIX-like operating systems, and that is the way it will stay for the
+ foreseeable future. The Bugzilla team is considering supporting Win32 for
+ the 2.16 release and later.
+
+ The easiest way to install Bugzilla on Intel-archiecture machines
+ is to install some variant of GNU/Linux, then follow the UNIX
+ installation instructions in this Guide. If you have any influence in the
+ platform choice for running this system, please choose GNU/Linux instead
+ of Microsoft Windows.
+
+
+ Win32 Installation: Step-by-step
+
+
+ You should be familiar with, and cross-reference, the rest of
+ the
+
+
+ section while performing your Win32 installation.
+
+ Making Bugzilla work on Microsoft Windows is no picnic. Support
+ for Win32 has improved dramatically in the last few releases, but, if
+ you choose to proceed, you should be a
+ very
+
+ skilled Windows Systems Administrator with strong troubleshooting
+ abilities, a high tolerance for pain, and moderate perl skills.
+ Bugzilla on NT requires hacking source code and implementing some
+ advanced utilities. What follows is the recommended installation
+ procedure for Win32; additional suggestions are provided in
+
+
+ .
+
+
+
+
+ Install
+ Apache Web Server
+
+ for Windows, and copy the Bugzilla files somewhere Apache can serve
+ them. Please follow all the instructions referenced in
+
+
+ regarding your Apache configuration, particularly instructions
+ regarding the
+ AddHandler
+
+ parameter and
+ ExecCGI
+
+ .
+
+
+ You may also use Internet Information Server or Personal
+ Web Server for this purpose. However, setup is quite different.
+ If ActivePerl doesn't seem to handle your file associations
+ correctly (for .cgi and .pl files), please consult
+
+
+ .
+
+ If you are going to use IIS, if on Windows NT you must be
+ updated to at least Service Pack 4. Windows 2000 ships with a
+ sufficient version of IIS.
+
+
+
+
+ Install
+ ActivePerl
+
+ for Windows. Check
+
+ http://aspn.activestate.com/ASPN/Downloads/ActivePerl
+
+ for a current compiled binary.
+
+ Please also check the following links to fully understand the
+ status of ActivePerl on Win32:
+
+ Perl Porting
+
+ , and
+
+ Perl on Win32 FAQ
+
+
+
+
+ Use ppm from your perl\bin directory to install the following
+ packs: DBI, DBD-Mysql, TimeDate, Chart, Date-Calc, Date-Manip, GD,
+ AppConfig, and Template. You may need to extract them from .zip
+ format using Winzip or other unzip program first. Most of these
+ additional ppm modules can be downloaded from ActiveState, but
+ AppConfig and Template should be obtained from OpenInteract using
+ the
+ instructions on the Template Toolkit web site
+
+ .
+
+
+ You can find a list of modules at
+
+ http://www.activestate.com/PPMPackages/zips/5xx-builds-only/
+
+ or
+
+ http://www.activestate.com/PPMPackages/5.6plus
+
+
+
+ The syntax for ppm is:
+
+ C:>
+
+ ppm <modulename>
+
+
+
+
+ Installing ActivePerl ppd Modules on Microsoft
+ Windows
+
+
+ C:>
+
+ ppm
+
+
+
+
+ Watch your capitalization!
+
+
+ ActiveState's 5.6Plus directory also contains an AppConfig
+ ppm, so you might see the following error when trying to install
+ the version at OpenInteract:
+
+
+ Error installing package 'AppConfig': Read a PPD
+ for 'AppConfig', but it is not intended for this build of Perl
+ (MSWin32-x86-multi-thread)
+
+
+ If so, download both
+
+ the tarball
+
+ and
+
+ the ppd
+
+ directly from OpenInteract, then run ppm from within the same
+ directory to which you downloaded those files and install the
+ package by referencing the ppd file explicitly via in the install
+ command, f.e.:
+
+ Installing OpenInteract ppd Modules manually on Microsoft
+ Windows
+
+
+
+ install
+ C:\AppConfig.ppd
+
+
+
+
+
+
+
+
+ Install MySQL for NT.
+
+ You can download MySQL for Windows NT from
+ MySQL.com
+
+ . Some find it helpful to use the WinMySqlAdmin utility, included
+ with the download, to set up the database.
+
+
+
+
+
+ Setup MySQL
+
+
+
+
+
+ C:>
+
+ C:\mysql\bin\mysql -u root mysql
+
+
+
+
+
+
+
+ mysql>
+
+ DELETE FROM user WHERE Host='localhost' AND
+ User='';
+
+
+
+
+
+
+
+ mysql>
+
+ UPDATE user SET Password=PASSWORD ('new_password')
+ WHERE user='root';
+
+
+
+
+ new_password
+
+ , above, indicates whatever password you wish to use for your
+ root
+
+ user.
+
+
+
+
+
+ mysql>
+
+ GRANT SELECT, INSERT, UPDATE, DELETE, INDEX,
+ ALTER, CREATE, DROP, REFERENCES ON bugs.* to bugs@localhost
+ IDENTIFIED BY 'bugs_password';
+
+
+
+
+ bugs_password
+
+ , above, indicates whatever password you wish to use for your
+ bugs
+
+ user.
+
+
+
+
+
+ mysql>
+
+ FLUSH PRIVILEGES;
+
+
+
+
+
+
+
+ mysql>
+
+ create database bugs;
+
+
+
+
+
+
+
+ mysql>
+
+ exit;
+
+
+
+
+
+
+
+ C:>
+
+ C:\mysql\bin\mysqladmin -u root -p
+ reload
+
+
+
+
+
+
+
+ Edit
+ checksetup.pl
+
+ in your Bugzilla directory. Change this line:
+
+
+ my $webservergid =
+ getgrnam($my_webservergroup);
+
+
+ to
+
+
+ my $webservergid =
+ $my_webservergroup;
+
+ or the name of the group you wish to own the files explicitly:
+ my $webservergid =
+ 'Administrators'
+
+
+
+
+ Run
+ checksetup.pl
+
+ from the Bugzilla directory.
+
+
+
+ Edit
+ localconfig
+
+ to suit your requirements. Set
+ $db_pass
+
+ to your
+ bugs_password
+
+ from
+
+
+ , and
+ $webservergroup
+
+ to
+ 8
+
+ .
+
+
+ Not sure on the
+ 8
+
+ for
+ $webservergroup
+
+ above. If it's wrong, please send corrections.
+
+
+
+
+ Edit
+ defparams.pl
+
+ to suit your requirements. Particularly, set
+ DefParam("maintainer")
+
+ and
+ DefParam("urlbase") to match your install.
+
+
+
+ This is yet another step I'm not sure of, since the
+ maintainer of this documentation does not maintain Bugzilla on
+ NT. If you can confirm or deny that this step is required, please
+ let me know.
+
+
+
+
+
+ There are several alternatives to Sendmail that will work
+ on Win32. The one mentioned here is a
+ suggestion
-
- The default .htaccess file may not provide adequate access
- restrictions, depending on your web server configuration.
- Be sure to check the <Directory> entries for your
- Bugzilla directory so that the .htaccess
- file is allowed to override web server defaults. For instance,
- let's assume your installation of Bugzilla is installed to
- /usr/local/bugzilla. You should have
- this <Directory> entry in your httpd.conf
- file:
-
+ , not a requirement. Some other mail packages that can work
+ include
+ BLAT
-
-
-
- Options +FollowSymLinks +Indexes +Includes +ExecCGI
- AllowOverride All
-
-]]>
-
-
+ ,
+ Windmail
-
- The important part above is AllowOverride All.
- Without that, the .htaccess file created by
- checksetup.pl will not have sufficient
- permissions to protect your Bugzilla installation.
-
+ ,
+ Mercury
+ Sendmail
-
- If you are using Internet Information Server or other web
- server which does not observe .htaccess
- conventions, you can disable their creation by editing
- localconfig and setting the
- $create_htaccess variable to
- 0.
-
-
+ , and the CPAN Net::SMTP Perl module (available in .ppm). Every
+ option requires some hacking of the Perl scripts for Bugzilla to
+ make it work. The option here simply requires the least.
+
-
- <filename>mod_throttle</filename> and Security
-
- It is possible for a user, by mistake or on purpose, to access
- the database many times in a row which can result in very slow
- access speeds for other users. If your Bugzilla installation
- is experiencing this problem , you may install the Apache
- module mod_throttle which can limit
- connections by ip-address. You may download this module at
- http://www.snert.com/Software/Throttle/. Follow the instructions to install into your Apache install. This module only functions with the Apache web server!. You may use the ThrottleClientIP command provided by this module to accomplish this goal. See the Module Instructions for more information.
-
-
-
- Preventing untrusted Bugzilla content from executing malicious Javascript code
- It is possible for a Bugzilla to execute malicious
- Javascript code. Due to internationalization concerns, we are
- unable to incorporate the code changes necessary to fulfill
- the CERT advisory requirements mentioned in http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3. Executing the following code snippet from a UNIX command shell will rectify the problem if your Bugzilla installation is intended for an English-speaking audience. As always, be sure your Bugzilla installation has a good backup before making changes, and I recommend you understand what the script is doing before executing it.
-
-bash# cd $BUGZILLA_HOME; for i in `ls *.cgi`; \
- do cat $i | sed 's/Content-type\: text\/html/Content-Type: text\/html\; charset=ISO-8859-1/' >$i.tmp; \
- mv $i.tmp $i; done
-
-
- All this one-liner command does is search for all instances of
- Content-type: text/html and replaces it with
- Content-Type: text/html; charset=ISO-8859-1.
- This specification prevents possible Javascript attacks on the
- browser, and is suggested for all English-speaking sites. For
- non-english-speaking Bugzilla sites, I suggest changing
- ISO-8859-1, above, to UTF-8.
-
-
+
+
+ Download NTsendmail, available from
+
+ www.ntsendmail.com
-
-
- UNIX Installation Instructions History
-
- This document was originally adapted from the Bonsai
- installation instructions by Terry Weissman
- <terry@mozilla.org>.
-
-
- The February 25, 1999 re-write of this page was done by Ry4an
- Brase <ry4an@ry4an.org>, with some edits by Terry
- Weissman, Bryce Nesbitt, Martin Pool, & Dan Mosedale (But
- don't send bug reports to them; report them using bugzilla, at http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla ).
-
-
- This document was heavily modified again Wednesday, March 07
- 2001 to reflect changes for Bugzilla 2.12 release by Matthew
- P. Barnson. The securing MySQL section should be changed to
- become standard procedure for Bugzilla installations.
-
-
- Finally, the README in its entirety was marked up in SGML and
- included into the Guide on April 24, 2001 by Matt Barnson.
- Since that time, it's undergone extensive modification as
- Bugzilla grew.
-
-
- Comments from people using this Guide for the first time are
- particularly welcome.
-
-
-
-
-
- Win32 Installation Notes
- This section covers installation on Microsoft Windows 95,
- 98, ME, NT, and 2000. Bugzilla works fine on Win32 platforms,
- but please remember that the Bugzilla team and the author of the
- Guide neither endorse nor support installation on Microsoft
- Windows. Bugzilla installs and runs best
- and easiest on UNIX-like operating systems,
- and that is the way it will stay for the foreseeable future. The
- Bugzilla team is considering supporting Win32 for the 2.16
- release and later.
- The easiest way to install Bugzilla on Intel-archiecture
- machines is to install some variant of GNU/Linux, then follow
- the UNIX installation instructions in this Guide. If you have
- any influence in the platform choice for running this system,
- please choose GNU/Linux instead of Microsoft Windows.
+ . You must have a "real" mail server which allows you to relay
+ off it in your $ENV{"NTsendmail"} (which you should probably
+ place in globals.pl)
+
-
- Win32 Installation: Step-by-step
-
-
- You should be familiar with, and cross-reference, the rest
- of the
- section while performing your
- Win32 installation.
-
- Making Bugzilla work on Microsoft Windows is no
- picnic. Support for Win32 has improved dramatically in the
- last few releases, but, if you choose to proceed, you should
- be a very skilled Windows Systems
- Administrator with strong troubleshooting abilities, a high
- tolerance for pain, and moderate perl skills. Bugzilla on NT
- requires hacking source code and implementing some advanced
- utilities. What follows is the recommended installation
- procedure for Win32; additional suggestions are provided in
- .
-
-
-
-
-
-
- Install Apache Web
- Server for Windows, and copy the Bugzilla files
- somewhere Apache can serve them. Please follow all the
- instructions referenced in
- regarding your Apache configuration, particularly
- instructions regarding the AddHandler
- parameter and ExecCGI.
-
-
-
- You may also use Internet Information Server or Personal
- Web Server for this purpose. However, setup is quite
- different. If ActivePerl doesn't seem to handle your
- file associations correctly (for .cgi and .pl files),
- please consult .
-
-
- If you are going to use IIS, if on Windows NT you must
- be updated to at least Service Pack 4. Windows 2000
- ships with a sufficient version of IIS.
-
-
-
-
-
- Install ActivePerl for Windows. Check http://aspn.activestate.com/ASPN/Downloads/ActivePerl for a current compiled binary.
-
-
- Please also check the following links to fully understand the status
- of ActivePerl on Win32:
-
- Perl Porting, and
-
- Perl on Win32 FAQ
-
-
-
-
- Use ppm from your perl\bin directory to install the following
- packs: DBI, DBD-Mysql, TimeDate, Chart, Date-Calc, Date-Manip,
- GD, AppConfig, and Template. You may need to extract them from
- .zip format using Winzip or other unzip program first. Most of
- these additional ppm modules can be downloaded from ActiveState,
- but AppConfig and Template should be obtained from OpenInteract
- using the instructions on
- the Template Toolkit web site.
-
-
-
- You can find a list of modules at
-
- http://www.activestate.com/PPMPackages/zips/5xx-builds-only/
- or http://www.activestate.com/PPMPackages/5.6plus
-
-
-
- The syntax for ppm is:
-
- C:> ppm <modulename>
-
-
-
-
- Installing ActivePerl ppd Modules on Microsoft Windows
- C:>ppm
-
- Watch your capitalization!
-
-
-
- ActiveState's 5.6Plus directory also contains an AppConfig ppm, so
- you might see the following error when trying to install the
- version at OpenInteract:
-
-
-
- Error installing package 'AppConfig': Read a PPD for
- 'AppConfig', but it is not intended for this build of Perl
- (MSWin32-x86-multi-thread)
-
-
-
- If so, download both the
- tarball and the
- ppd directly from OpenInteract, then run ppm from within
- the same directory to which you downloaded those files and
- install the package by referencing the ppd file explicitly via in
- the install command, f.e.:
-
- Installing OpenInteract ppd Modules manually on Microsoft
- Windows
-
- install
- C:\AppConfig.ppd
+
+ Put ntsendmail.pm into your .\perl\lib directory.
+
+
+
+ Add to globals.pl:
+
+ # these settings configure the NTsendmail
+ process use NTsendmail;
+ $ENV{"NTsendmail"}="your.smtpserver.box";
+ $ENV{"NTsendmail_debug"}=1;
+ $ENV{"NTsendmail_max_tries"}=5;
+
+
+ Some mention to also edit
+ $db_pass
+
+ in
+ globals.pl
+
+ to be your
+ bugs_password
+
+ . Although this may get you around some problem
+ authenticating to your database, since globals.pl is not
+ normally restricted by
+ .htaccess
+
+ , your database password is exposed to whoever uses your web
+ server.
+
+
+
+
+ Find and comment out all occurences of
+
+ open(SENDMAIL
+
+
+ in your Bugzilla directory. Then replace them with:
+ # new sendmail functionality my $mail=new
+ NTsendmail; my $from="bugzilla\@your.machine.name.tld"; my
+ $to=$login; my $subject=$urlbase;
+ $mail->send($from,$to,$subject,$msg);
-
-
-
-
-
-
- Install MySQL for NT.
-
-
- You can download MySQL for Windows NT from MySQL.com. Some find it helpful to use the WinMySqlAdmin utility, included with the download, to set up the database.
-
-
-
-
-
-
- Setup MySQL
-
-
-
-
-
- C:>
- C:\mysql\bin\mysql -u root mysql
-
-
-
-
-
-
- mysql>
- DELETE FROM user WHERE Host='localhost' AND User='';
-
-
-
-
-
-
- mysql>
- UPDATE user SET Password=PASSWORD ('new_password')
- WHERE user='root';
-
-
- new_password, above, indicates
- whatever password you wish to use for your
- root user.
-
-
-
-
- mysql>
- GRANT SELECT, INSERT, UPDATE, DELETE,
- INDEX, ALTER, CREATE, DROP, REFERENCES
- ON bugs.* to bugs@localhost
- IDENTIFIED BY 'bugs_password';
-
-
- bugs_password, above, indicates
- whatever password you wish to use for your
- bugs user.
-
-
-
-
- mysql>
- FLUSH PRIVILEGES;
-
-
-
-
-
-
- mysql>
- create database bugs;
-
-
-
-
-
-
- mysql>
- exit;
-
-
-
-
-
-
- C:>
- C:\mysql\bin\mysqladmin -u root -p reload
-
-
-
-
-
-
-
-
- Edit checksetup.pl in your Bugzilla directory. Change
- this line:
-
-
-
-my $webservergid = getgrnam($my_webservergroup);
-
-
-
- to
-
-
-
-my $webservergid = $my_webservergroup;
-
-or the name of the group you wish to own the files explicitly:
-
-my $webservergid = 'Administrators'
-
-
-
-
-
-
- Run checksetup.pl from the Bugzilla directory.
-
-
-
-
- Edit localconfig to suit your
- requirements. Set $db_pass to your
- bugs_password from , and $webservergroup to 8.
-
- Not sure on the 8 for
- $webservergroup above. If it's
- wrong, please send corrections.
-
-
-
-
-
- Edit defparams.pl to suit your
- requirements. Particularly, set
- DefParam("maintainer") and
- DefParam("urlbase") to match your
- install.
-
-
- This is yet another step I'm not sure of, since the
- maintainer of this documentation does not maintain
- Bugzilla on NT. If you can confirm or deny that this
- step is required, please let me know.
-
-
-
-
-
-
- There are several alternatives to Sendmail that will work on Win32.
- The one mentioned here is a suggestion, not
- a requirement. Some other mail packages that can work include
- BLAT,
- Windmail,
- Mercury Sendmail,
- and the CPAN Net::SMTP Perl module (available in .ppm).
- Every option requires some hacking of the Perl scripts for Bugzilla
- to make it work. The option here simply requires the least.
-
-
-
-
-
-
- Download NTsendmail, available from www.ntsendmail.com. You must have a "real" mail server which allows you to relay off it in your $ENV{"NTsendmail"} (which you should probably place in globals.pl)
-
-
-
-
- Put ntsendmail.pm into your .\perl\lib directory.
-
-
-
- Add to globals.pl:
-
-# these settings configure the NTsendmail process
-use NTsendmail;
-$ENV{"NTsendmail"}="your.smtpserver.box";
-$ENV{"NTsendmail_debug"}=1;
-$ENV{"NTsendmail_max_tries"}=5;
-
-
-
- Some mention to also edit
- $db_pass in
- globals.pl to be your
- bugs_password. Although this may get
- you around some problem authenticating to your
- database, since globals.pl is not normally
- restricted by .htaccess, your
- database password is exposed to whoever uses your
- web server.
-
-
-
-
-
-
- Find and comment out all occurences of
- open(SENDMAIL in
- your Bugzilla directory. Then replace them with:
-
-# new sendmail functionality
-my $mail=new NTsendmail;
-my $from="bugzilla\@your.machine.name.tld";
-my $to=$login;
-my $subject=$urlbase;
-$mail->send($from,$to,$subject,$msg);
-
-
-
-
- Some have found success using the commercial product,
- Windmail.
- You could try replacing your sendmail calls with:
-
-open SENDMAIL, "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t > mail.log";
-
- or something to that effect.
-
-
-
-
-
-
-
-
- Change all references in all files from
- processmail to
- processmail.pl, and
- rename processmail to
- processmail.pl.
-
-
-
- Many think this may be a change we want to make for
- main-tree Bugzilla. It's painless for the UNIX folks,
- and will make the Win32 people happier.
-
-
-
-
- Some people have suggested using the Net::SMTP Perl module instead of NTsendmail or the other options listed here. You can change processmail.pl to make this work.
-
+
+
+ Some have found success using the commercial product,
+ Windmail
+
+ . You could try replacing your sendmail calls with:
+ open SENDMAIL,
+ "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t >
+ mail.log";
+
+ or something to that effect.
+
+
+
+
+
+
+ Change all references in all files from
+ processmail
+
+ to
+ processmail.pl
+
+ , and rename
+ processmail
+
+ to
+ processmail.pl
+
+ .
+
+
+ Many think this may be a change we want to make for
+ main-tree Bugzilla. It's painless for the UNIX folks, and will
+ make the Win32 people happier.
+
+
+
+ Some people have suggested using the Net::SMTP Perl module
+ instead of NTsendmail or the other options listed here. You can
+ change processmail.pl to make this work.
+
new(''); #connect to SMTP server
@@ -1737,9 +1442,10 @@ $logstr = "$logstr; mail sent to $tolist $cclist";
}
]]>
-
-here is a test mail program for Net::SMTP:
-
+
+
+ here is a test mail program for Net::SMTP:
+
-
-
-
-
-
-
-
- This step is optional if you are using IIS or another
- web server which only decides on an interpreter based
- upon the file extension (.pl), rather than the
- shebang line (#/usr/bonsaitools/bin/perl)
-
-
-
- Modify the path to perl on the first line (#!) of all
- files to point to your Perl installation, and add
- perl to the beginning of all Perl system
- calls that use a perl script as an argument. This may
- take you a while. There is a setperl.csh
- utility to speed part of this procedure, available in the
- section of The Bugzilla Guide.
- However, it requires the Cygwin GNU-compatible environment
- for Win32 be set up in order to work. See http://www.cygwin.com/ for details on obtaining Cygwin.
-
-
-
-
-
- Modify the invocation of all system() calls in all perl
- scripts in your Bugzilla directory. You should specify the
- full path to perl for each system() call. For instance, change
- this line in processmail:
-
+
+
+
+
+
+
+ This step is optional if you are using IIS or another web
+ server which only decides on an interpreter based upon the file
+ extension (.pl), rather than the
+ shebang
+
+ line (#/usr/bonsaitools/bin/perl)
+
+
+ Modify the path to perl on the first line (#!) of all files
+ to point to your Perl installation, and add
+ perl
+
+ to the beginning of all Perl system calls that use a perl script as
+ an argument. This may take you a while. There is a
+ setperl.csh
+
+ utility to speed part of this procedure, available in the
+
+
+ section of The Bugzilla Guide. However, it requires the Cygwin
+ GNU-compatible environment for Win32 be set up in order to work.
+ See
+ http://www.cygwin.com/
+
+ for details on obtaining Cygwin.
+
+
+
+ Modify the invocation of all system() calls in all perl
+ scripts in your Bugzilla directory. You should specify the full
+ path to perl for each system() call. For instance, change this line
+ in processmail:
+
+ to
-
+ to
+
system ("C:\\perl\\bin\\perl", "processmail", @ARGLIST);
-]]>
-
-
-
-
- Add binmode() calls so attachments
- will work (bug 62000).
+]]>
+
+
+
+
+ Add
+ binmode()
+
+ calls so attachments will work (
+ bug
+ 62000
+
+ ).
+
+ Because Microsoft Windows based systems handle binary files
+ different than Unix based systems, you need to add the following
+ lines to
+ createattachment.cgi
+
+ and
+ showattachment.cgi
+
+ before the
+ require 'CGI.pl';
+
+ line.
+
- Because Microsoft Windows based systems handle binary
- files different than Unix based systems, you need to add
- the following lines to
- createattachment.cgi and
- showattachment.cgi before the
- require 'CGI.pl'; line.
-
-
-
+
-
+
+
-
- According to bug 62000,
- the perl documentation says that you should always use
- binmode() when dealing with binary
- files, but never when dealing with text files. That seems
- to suggest that rather than arbitrarily putting
- binmode() at the beginning of the
- attachment files, there should be logic to determine if
- binmode() is needed or not.
-
+ According to
+
+ bug 62000
+
+ , the perl documentation says that you should always use
+ binmode()
+
+ when dealing with binary files, but never when dealing with text
+ files. That seems to suggest that rather than arbitrarily putting
+
+ binmode()
+
+ at the beginning of the attachment files, there should be logic
+ to determine if
+ binmode()
+
+ is needed or not.
-
- If you are using IIS or Personal Web Server, you must add cgi
- relationships to Properties -> Home directory (tab) ->
- Application Settings (section) -> Configuration (button),
- such as:
-
-
-
-.cgi to: <perl install directory>\perl.exe %s %s
-.pl to: <perl install directory>\perl.exe %s %s
-GET,HEAD,POST
-
- Change the path to Perl to match your
- install, of course.
-
+ If you are using IIS or Personal Web Server, you must add cgi
+ relationships to Properties -> Home directory (tab) ->
+ Application Settings (section) -> Configuration (button), such
+ as:
+
+
+ .cgi to: <perl install directory>\perl.exe %s
+ %s .pl to: <perl install directory>\perl.exe %s %s
+ GET,HEAD,POST
+
+ Change the path to Perl to match your install, of course.Additional Windows Tips
+
-
- From Andrew Pearson:
-
-
- You can make Bugzilla work with Personal Web Server for
- Windows 98 and higher, as well as for IIS 4.0.
- Microsoft has information available at http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP
-
-
- Basically you need to add two String Keys in the
- registry at the following location:
-
-
-
-HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap
-
-
-
- The keys should be called ".pl" and ".cgi", and both
- should have a value something like:
- c:/perl/bin/perl.exe "%s" "%s"
-
-
- The KB article only talks about .pl, but it goes into
- more detail and provides a perl test script.
-
-
-
+ From Andrew Pearson:
+
+ You can make Bugzilla work with Personal Web Server for
+ Windows 98 and higher, as well as for IIS 4.0. Microsoft has
+ information available at
+
+ http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP
+
+
+ Basically you need to add two String Keys in the registry at
+ the following location:
+
+
+
+ HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap
+
+
+ The keys should be called ".pl" and ".cgi", and both should
+ have a value something like:
+ c:/perl/bin/perl.exe "%s" "%s"
+
+
+ The KB article only talks about .pl, but it goes into more
+ detail and provides a perl test script.
+
+
+
-
- If attempting to run Bugzilla 2.12 or older, you will need
- to remove encrypt() calls from the Perl source. This is
- not necessary for Bugzilla 2.13 and
- later, which includes the current release, Bugzilla
- &bz-ver;.
-
- Removing encrypt() for Windows NT Bugzilla version
- 2.12 or earlier
-
- Replace this:
-
-SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")");
-my $enteredcryptpwd = FetchOneColumn();
-
-with this:
-
-my $enteredcryptpwd = $enteredpwd
-
- in cgi.pl.
-
-
-
+ If attempting to run Bugzilla 2.12 or older, you will need to
+ remove encrypt() calls from the Perl source. This is
+ not necessary
+
+ for Bugzilla 2.13 and later, which includes the current release,
+ Bugzilla &bz-ver;.
+
+ Removing encrypt() for Windows NT Bugzilla version 2.12 or
+ earlier
+
+ Replace this:
+ SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) .
+ ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")"); my
+ $enteredcryptpwd = FetchOneColumn();
+
+ with this:
+ my $enteredcryptpwd = $enteredpwd
+
+ in cgi.pl.
+
+
-
+
Bugzilla LDAP Integration
+
+ What follows is some late-breaking information on using the LDAP
+ authentication options with Bugzilla. The author has not tested these
+ (nor even formatted this section!) so please contribute feedback to the
+ newsgroup.
+
+ Mozilla::LDAP module The Mozilla::LDAP module allows you
+ to use LDAP for authentication to the Bugzilla system. This module is
+ not required if you are not using LDAP. Mozilla::LDAP (aka PerLDAP) is
+ available for download from http://www.mozilla.org/directory. NOTE: The
+ Mozilla::LDAP module requires Netscape's Directory SDK. Follow the link
+ for "Directory SDK for C" on that same page to download the SDK first.
+ After you have installed this SDK, then install the PerLDAP module.
+ ----------------------------------------------------------------------
+ Post-Installation Checklist
+ ----------------------------------------------------------------------
+ Set useLDAP to "On" **only** if you will be using an LDAP directory for
+ authentication. Be very careful when setting up this parameter; if you
+ set LDAP authentication, but do not have a valid LDAP directory set up,
+ you will not be able to log back in to Bugzilla once you log out. (If
+ this happens, you can get back in by manually editing the data/params
+ file, and setting useLDAP back to 0.) If using LDAP, you must set the
+ three additional parameters: Set LDAPserver to the name (and optionally
+ port) of your LDAP server. If no port is specified, it defaults to the
+ default port of 389. (e.g "ldap.mycompany.com" or
+ "ldap.mycompany.com:1234") Set LDAPBaseDN to the base DN for searching
+ for users in your LDAP directory. (e.g. "ou=People,o=MyCompany") uids
+ must be unique under the DN specified here. Set LDAPmailattribute to
+ the name of the attribute in your LDAP directory which contains the
+ primary email address. On most directory servers available, this is
+ "mail", but you may need to change this.
+ ----------------------------------------------------------------------
+ (Not sure where this bit should go, but it's important that it be in
+ there somewhere...)
+ ----------------------------------------------------------------------
+ Using LDAP authentication for Bugzilla: The existing authentication
+ scheme for Bugzilla uses email addresses as the primary user ID, and a
+ password to authenticate that user. All places within Bugzilla where
+ you need to deal with user ID (e.g assigning a bug) use the email
+ address. The LDAP authentication builds on top of this scheme, rather
+ than replacing it. The initial log in is done with a username and
+ password for the LDAP directory. This then fetches the email address
+ from LDAP and authenticates seamlessly in the standard Bugzilla
+ authentication scheme using this email address. If an account for this
+ address already exists in your Bugzilla system, it will log in to that
+ account. If no account for that email address exists, one is created at
+ the time of login. (In this case, Bugzilla will attempt to use the
+ "displayName" or "cn" attribute to determine the user's full name.)
+ After authentication, all other user-related tasks are still handled by
+ email address, not LDAP username. You still assign bugs by email
+ address, query on users by email address, etc.
+ ----------------------------------------------------------------------
+
+
+
+
+ Mac OS X Installation Notes
+
+ There are a lot of common libraries and utilities out there that
+ Apple did not include with Mac OS X, but which run perfectly well on it.
+ The GD library, which Bugzilla needs to do bug graphs, is one of
+ these.
+
+ The easiest way to get a lot of these is with a program called
+ Fink, which is similar in nature to the CPAN installer, but installs
+ common GNU utilities. Fink is available from
+ <http://sourceforge.net/projects/fink/>.
+
+ Follow the instructions for setting up Fink. Once it's installed,
+ you'll want to run the following as root:
+ fink install gd
+
+
+ It will prompt you for a number of dependencies, type 'y' and hit
+ enter to install all of the dependencies. Then watch it work.
+
+ To prevent creating conflicts with the software that Apple installs
+ by default, Fink creates its own directory tree at /sw where it installs
+ most of the software that it installs. This means your libraries and
+ headers for libgd will be at /sw/lib and /sw/include instead of /usr/lib
+ and /usr/local/include. Because of these changed locations for the
+ libraries, the Perl GD module will not install directly via CPAN (it
+ looks for the specific paths instead of getting them from your
+ environment). But there's a way around that :-)
+
+ Instead of typing
+ install GD
+ at the
+ cpan>
+ prompt, type
+ look GD.
+ This should go through the motions of downloading the latest version of
+ the GD module, then it will open a shell and drop you into the build
+ directory. Apply this patch
+ to the Makefile.PL file (save the
+ patch into a file and use the command
+ patch < patchfile.
+
+
+ Then, run these commands to finish the installation of the GD
+ module:
+
+
+ perl Makefile.PL
+
+
+
+ make
+
+
+
+ make test
+
+
+
+ make install
+
+
+ And don't forget to run
+ exit
+
+ to get back to cpan.
+
+
+
+
+
+
+ General Installation Notes
+
+
+ Modifying Your Running System
+
+ Bugzilla optimizes database lookups by storing all relatively
+ static information in the versioncache file, located in the data/
+ subdirectory under your installation directory.
+
+ If you make a change to the structural data in your database (the
+ versions table for example), or to the
+ constants
+
+ encoded in defparams.pl, you will need to remove the cached content
+ from the data directory (by doing a
+ rm data/versioncache
+
+ ), or your changes won't show up.
+
+ That file gets automatically regenerated whenever it's more than
+ an hour old, so Bugzilla will eventually notice your changes by itself,
+ but generally you want it to notice right away, so that you can test
+ things.
+
+
+
+ Upgrading From Previous Versions
+
+ A plain Bugzilla is fairly easy to upgrade from one version to a
+ newer one. However, things get a bit more complicated if you've made
+ changes to Bugzilla's code. In this case, you may have to re-make or
+ reapply those changes. It is recommended that you take a backup of your
+ database and your entire Bugzilla installation before attempting an
+ upgrade. You can upgrade a 'clean' installation by untarring a new
+ tarball over the old installation. If you are upgrading from 2.12 or
+ later, you can type
+ cvs -z3 update
+
+ , and resolve conflicts if there are any.
+
+ Because the developers of Bugzilla are constantly adding new
+ tables, columns and fields, you'll probably get SQL errors if you just
+ update the code and attempt to use Bugzilla. Always run the
+ checksetup.pl script whenever you upgrade your installation.
+
+ If you are running Bugzilla version 2.8 or lower, and wish to
+ upgrade to the latest version, please consult the file,
+ "UPGRADING-pre-2.8" in the Bugzilla root directory after untarring the
+ archive.
+
+
+
+
+ <filename>.htaccess</filename>
+
+ files and security
+
+ To enhance the security of your Bugzilla installation, Bugzilla
+ will generate
+
+ .htaccess
+
+
+ files which the Apache webserver can use to restrict access to the
+ bugzilla data files. The checksetup script will generate the
+ .htaccess
+
+ files. These .htaccess files will not work with Apache 1.2.x - but this
+ has security holes, so you shouldn't be using it anyway.
+
+ If you are using an alternate provider of
+ webdot
+
+ services for graphing (as described when viewing
+ editparams.cgi
+
+ in your web browser), you will need to change the ip address in
+ data/webdot/.htaccess
+
+ to the ip address of the webdot server that you are using.
+
+
+
+ The default .htaccess file may not provide adequate access
+ restrictions, depending on your web server configuration. Be sure to
+ check the <Directory> entries for your Bugzilla directory so that
+ the
+ .htaccess
+
+ file is allowed to override web server defaults. For instance, let's
+ assume your installation of Bugzilla is installed to
+ /usr/local/bugzilla
+
+ . You should have this <Directory> entry in your
+ httpd.conf
+
+ file:
+
+
+
+
+ Options +FollowSymLinks +Indexes +Includes +ExecCGI
+ AllowOverride All
+
+]]>
+
+
+
+ The important part above is
+ AllowOverride All
+
+ . Without that, the
+ .htaccess
+
+ file created by
+ checksetup.pl
+
+ will not have sufficient permissions to protect your Bugzilla
+ installation.
+
+ If you are using Internet Information Server or other web server
+ which does not observe
+ .htaccess
+
+ conventions, you can disable their creation by editing
+ localconfig
+
+ and setting the
+ $create_htaccess
+
+ variable to
+ 0
+
+ .
+
+
+
+
+ <filename>mod_throttle</filename>
+
+ and Security
+
+ It is possible for a user, by mistake or on purpose, to access
+ the database many times in a row which can result in very slow access
+ speeds for other users. If your Bugzilla installation is experiencing
+ this problem , you may install the Apache module
+ mod_throttle
+
+ which can limit connections by ip-address. You may download this module
+ at
+
+ http://www.snert.com/Software/Throttle/
+
+ . Follow the instructions to install into your Apache install.
+ This module only functions with the Apache web
+ server!
+
+ . You may use the
+ ThrottleClientIP
+
+ command provided by this module to accomplish this goal. See the
+ Module
+ Instructions
+
+ for more information.
+
+
+
+
+ Preventing untrusted Bugzilla content from executing malicious
+ Javascript code
+
+ It is possible for a Bugzilla to execute malicious Javascript
+ code. Due to internationalization concerns, we are unable to
+ incorporate the code changes necessary to fulfill the CERT advisory
+ requirements mentioned in
+
+ http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3.
+ Executing the following code snippet from a UNIX command shell will
+ rectify the problem if your Bugzilla installation is intended for an
+ English-speaking audience. As always, be sure your Bugzilla
+ installation has a good backup before making changes, and I recommend
+ you understand what the script is doing before executing it.
+
+
+ bash# cd <your_bugzilla_dir>;
+ for i in `ls *.cgi`; \ do
+ cat $i | sed 's/Content-type\: text\/html/Content-Type: text\/html\;
+ charset=ISO-8859-1/' >$i.tmp; \ mv $i.tmp $i;
+ done
+
+
+ All this one-liner command does is search for all instances of
+ Content-type: text/html
+
+ and replaces it with
+ Content-Type: text/html; charset=ISO-8859-1
+
+ . This specification prevents possible Javascript attacks on the
+ browser, and is suggested for all English-speaking sites. For
+ non-English-speaking Bugzilla sites, I suggest changing
+ ISO-8859-1, above, to
+ UTF-8.
+
+
+
+ cannot chdir(/var/spool/mqueue)
+
+ If you are installing Bugzilla on SuSE Linux, or some other
+ distributions with
+ paranoid
+ security options, it is possible that the checksetup.pl script may fail
+ with the error:
+ cannot chdir(/var/spool/mqueue): Permission
+ denied.
+
+
- What follows is some late-breaking information on using the
- LDAP authentication options with Bugzilla. The author has not
- tested these (nor even formatted this section!) so please
- contribute feedback to the newsgroup.
+ This is because your
+ /var/spool/mqueue
+ directory has a mode of
+ drwx------. Type
+ chmod 755
+ /var/spool/mqueue
+
+ as root to fix this problem.
-
-Mozilla::LDAP module
-
-The Mozilla::LDAP module allows you to use LDAP for authentication to
-the Bugzilla system. This module is not required if you are not using
-LDAP.
-
-Mozilla::LDAP (aka PerLDAP) is available for download from
-http://www.mozilla.org/directory.
-
-NOTE: The Mozilla::LDAP module requires Netscape's Directory SDK.
-Follow the link for "Directory SDK for C" on that same page to
-download the SDK first. After you have installed this SDK, then
-install the PerLDAP module.
-----------------------------------------------------------------------
-
-Post-Installation Checklist
-----------------------------------------------------------------------
-Set useLDAP to "On" **only** if you will be using an LDAP directory
-for authentication. Be very careful when setting up this parameter;
-if you set LDAP authentication, but do not have a valid LDAP directory
-set up, you will not be able to log back in to Bugzilla once you log
-out. (If this happens, you can get back in by manually editing the
-data/params file, and setting useLDAP back to 0.)
-
-If using LDAP, you must set the three additional parameters:
-
-Set LDAPserver to the name (and optionally port) of your LDAP server.
-If no port is specified, it defaults to the default port of 389. (e.g
-"ldap.mycompany.com" or "ldap.mycompany.com:1234")
-
-Set LDAPBaseDN to the base DN for searching for users in your LDAP
-directory. (e.g. "ou=People,o=MyCompany") uids must be unique under
-the DN specified here.
-
-Set LDAPmailattribute to the name of the attribute in your LDAP
-directory which contains the primary email address. On most directory
-servers available, this is "mail", but you may need to change this.
-----------------------------------------------------------------------
-
-(Not sure where this bit should go, but it's important that it be in
-there somewhere...)
-----------------------------------------------------------------------
-Using LDAP authentication for Bugzilla:
-
-The existing authentication scheme for Bugzilla uses email addresses
-as the primary user ID, and a password to authenticate that user. All
-places within Bugzilla where you need to deal with user ID (e.g
-assigning a bug) use the email address.
-
-The LDAP authentication builds on top of this scheme, rather than
-replacing it. The initial log in is done with a username and password
-for the LDAP directory. This then fetches the email address from LDAP
-and authenticates seamlessly in the standard Bugzilla authentication
-scheme using this email address. If an account for this address
-already exists in your Bugzilla system, it will log in to that
-account. If no account for that email address exists, one is created
-at the time of login. (In this case, Bugzilla will attempt to use the
-"displayName" or "cn" attribute to determine the user's full name.)
-
-After authentication, all other user-related tasks are still handled
-by email address, not LDAP username. You still assign bugs by email
-address, query on users by email address, etc.
-----------------------------------------------------------------------
-
-
+
diff --git a/docs/sgml/using.sgml b/docs/sgml/using.sgml
index b447ef9c00..dade59a08c 100644
--- a/docs/sgml/using.sgml
+++ b/docs/sgml/using.sgml
@@ -1,167 +1,15 @@
-
Using Bugzilla
-
- What is Bugzilla?
-
- Bugzilla is one example of a class of programs called "Defect
- Tracking Systems", or, more commonly, "Bug-Tracking Systems". Defect
- Tracking Systems allow individual or groups of developers to keep track
- of outstanding bugs in their product effectively. Bugzilla was originally
- written by Terry Weissman in a programming language called "TCL", to
- replace a crappy bug-tracking database used internally by Netscape
- Communications. Terry later ported Bugzilla to Perl from TCL, and in Perl
- it remains to this day. Most commercial defect-tracking software vendors
- at the time charged enormous licensing fees, and Bugzilla quickly became
- a favorite of the open-source crowd (with its genesis in the open-source
- browser project, Mozilla). It is now the de-facto standard
- defect-tracking system against which all others are measured.
-
- Bugzilla has matured immensely, and now boasts many advanced
- features. These include:
-
-
- Powerful searching
-
-
-
- User-configurable email notifications of bug changes
-
-
-
- Full change history
-
-
-
- Inter-bug dependency tracking and graphing
-
-
-
- Excellent attachment management
-
-
-
- Integrated, product-based, granular security schema
-
-
-
- Fully security-audited, and runs under Perl's taint mode
-
-
-
- A robust, stable RDBMS back-end
-
-
-
- Web, XML, email and console interfaces
-
-
-
- Completely customisable and/or localisable web user
- interface
-
-
-
- Extensive configurability
-
-
-
- Smooth upgrade pathway between versions
-
-
-
-
-
-
- Why Should We Use Bugzilla?
-
- For many years, defect-tracking software has remained principally
- the domain of large software development houses. Even then, most shops
- never bothered with bug-tracking software, and instead simply relied on
- shared lists and email to monitor the status of defects. This procedure
- is error-prone and tends to cause those bugs judged least significant by
- developers to be dropped or ignored.
-
- These days, many companies are finding that integrated
- defect-tracking systems reduce downtime, increase productivity, and raise
- customer satisfaction with their systems. Along with full disclosure, an
- open bug-tracker allows manufacturers to keep in touch with their clients
- and resellers, to communicate about problems effectively throughout the
- data management chain. Many corporations have also discovered that
- defect-tracking helps reduce costs by providing IT support
- accountability, telephone support knowledge bases, and a common,
- well-understood system for accounting for unusual system or software
- issues.
-
- But why should
- you
-
- use Bugzilla?
-
- Bugzilla is very adaptable to various situations. Known uses
- currently include IT support queues, Systems Administration deployment
- management, chip design and development problem tracking (both
- pre-and-post fabrication), and software and hardware bug tracking for
- luminaries such as Redhat, Loki software, Linux-Mandrake, and VA Systems.
- Combined with systems such as CVS, Bonsai, or Perforce SCM, Bugzilla
- provides a powerful, easy-to-use solution to configuration management and
- replication problems
-
- Bugzilla can dramatically increase the productivity and
- accountability of individual employees by providing a documented workflow
- and positive feedback for good performance. How many times do you wake up
- in the morning, remembering that you were supposed to do
- something
-
- today, but you just can't quite remember? Put it in Bugzilla, and you
- have a record of it from which you can extrapolate milestones, predict
- product versions for integration, and by using Bugzilla's e-mail
- integration features be able to follow the discussion trail that led to
- critical decisions.
-
- Ultimately, Bugzilla puts the power in your hands to improve your
- value to your employer or business while providing a usable framework for
- your natural attention to detail and knowledge store to flourish.
-
-
How do I use Bugzilla?
- This section contains information for end-users of Bugzilla. If you
- are administering a Bugzilla installation, please consult the Installing
- and Administering Bugzilla portions of this Guide.
-
- There is a Bugzilla test installation, called
- Landfill
-
- , which you are welcome to play with. However, it does not necessarily
+ This section contains information for end-users of Bugzilla.
+ There is a Bugzilla test installation, called
+ Landfill,
+ which you are welcome to play with. However, it does not necessarily
have all Bugzilla features enabled, and often runs cutting-edge versions
of Bugzilla for testing, so some things may work slightly differently
than mentioned here.
@@ -200,13 +48,12 @@ Chapter: Using Bugzilla
Click the
Log In
-
link in the yellow area at the bottom of the page in your browser,
enter your email address and password into the spaces provided, and
click
- Login
-
- .
+ Login.
+
+
@@ -224,7 +71,7 @@ Chapter: Using Bugzilla
url="http://landfill.tequilarista.org/bugzilla-tip/show_bug.cgi?id=1">
Bug 1 on Landfill
- is a good example. Note that the names of most fields are hyperlinks;
+ is a good example. Note that the labels for most fields are hyperlinks;
clicking them will take you to context-sensitive help on that
particular field.
@@ -240,56 +87,46 @@ Chapter: Using Bugzilla
Administration:
-
Administration of a Bugzilla installation.Bugzilla-General:
-
Anything that doesn't fit in the other components, or spans
multiple components.Creating/Changing Bugs:
-
Creating, changing, and viewing bugs.Documentation:
-
The Bugzilla documentation, including The Bugzilla Guide.Email:
-
Anything to do with email sent by Bugzilla.Installation:
-
The installation process of Bugzilla.Query/Buglist:
-
Anything to do with searching for bugs and viewing the
buglists.Reporting/Charting:
-
Getting reports from Bugzilla.User Accounts:
-
Anything about managing a user account from the user's perspective.
Saved queries, creating accounts, changing passwords, logging in,
etc.User Interface:
-
General issues having to do with the user interface cosmetics (not
functionality) including cosmetic issues, HTML templates,
etc.
@@ -301,38 +138,34 @@ Chapter: Using Bugzilla
Status and Resolution:
- A bug passes through several Statuses in its lifetime, and ends up
- in the RESOLVED status, with one of a set of Resolutions (e.g.
- FIXED, INVALID.) The different possible values for Status and
- Resolution on your installation will be documented in the
+ These define exactly what state the bug is in - from not even
+ being confirmed as a bug, through to being fixed and the fix
+ confirmed by Quality Assurance. The different possible values for
+ Status and Resolution on your installation should be documented in the
context-sensitive help for those items.Assigned To:
-
The person responsible for fixing the bug.URL:
-
A URL associated with the bug, if any.Summary:
-
A one-sentence summary of the problem.Status Whiteboard:
-
(a.k.a. Whiteboard) A free-form text area for adding short notes
and tags to a bug.
@@ -340,7 +173,6 @@ Chapter: Using Bugzilla
Keywords:
-
The administrator can define keywords which you can use to tag and
categorise bugs - e.g. The Mozilla Project has keywords like crash
and regression.
@@ -349,7 +181,6 @@ Chapter: Using Bugzilla
Platform and OS:
-
These indicate the computing environment where the bug was
found.
@@ -357,7 +188,6 @@ Chapter: Using Bugzilla
Version:
-
The "Version" field is usually used for versions of a product which
have been released, and is set to indicate which versions of a
Component have the particular problem the bug report is
@@ -367,7 +197,6 @@ Chapter: Using Bugzilla
Priority:
-
The bug assignee uses this field to prioritise his or her bugs.
It's a good idea not to change this on other people's bugs.
@@ -375,7 +204,6 @@ Chapter: Using Bugzilla
Severity:
-
This indicates how severe the problem is - from blocker
("application unusable") to trivial ("minor cosmetic issue"). You
can also use this field to indicate whether a bug is an enhancement
@@ -385,7 +213,6 @@ Chapter: Using Bugzilla
Target:
-
(a.k.a. Target Milestone) A future version by which the bug is to
be fixed. e.g. The Bugzilla Project's milestones for future
Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not
@@ -396,21 +223,18 @@ Chapter: Using Bugzilla
Reporter:
-
The person who filed the bug.CC list:
-
A list of people who get mail when the bug changes.Attachments:
-
You can attach files (e.g. testcases or patches) to bugs. If there
are any attachments, they are listed in this section.
@@ -418,7 +242,6 @@ Chapter: Using Bugzilla
Dependencies:
-
If this bug cannot be fixed unless other bugs are fixed (depends
on), or this bug stops other bugs being fixed (blocks), their
numbers are recorded here.
@@ -427,14 +250,12 @@ Chapter: Using Bugzilla
Votes:
-
Whether this bug has any votes.Additional Comments:
-
You can add your two cents to the bug discussion here, if you have
something worthwhile to say.
@@ -534,13 +355,11 @@ Chapter: Using Bugzilla
Go to
Landfill
-
in your browser and click
- Enter a new bug report
-
- .
+ Enter a new bug report.
+
@@ -563,26 +382,21 @@ Chapter: Using Bugzilla
User Preferences
- You can customise various aspects of Bugzilla, via the "Edit prefs"
- link in the page footer, once you have logged in, e.g. to
-
- Landfill
-
- . The preferences are split into four tabs.
+ Once you have logged in, you can customise various aspects of
+ Bugzilla via the "Edit prefs" link in the page footer.
+ The preferences are split into four tabs:Account Settings
- On this tab, you can change your basic Account Settings,
+ On this tab, you can change your basic account information,
including your password, email address and real name. For security
reasons, in order to change anything on this page you must type your
current
-
password into the
Password
-
- field. If you attempt to change your email address, a confirmation
+ field at the top of the page.
+ If you attempt to change your email address, a confirmation
email is sent to both the old and new addresses, with a link to use to
confirm the change. This helps to prevent account hijacking.
@@ -604,24 +418,24 @@ Chapter: Using Bugzilla
direct reports, or users go on vacation.
- This option may not be available in all Bugzilla installations.
- Ask your administrator.
+ The ability to watch other users may not be available in all
+ Bugzilla installations. If you can't see it, ask your
+ administrator.Page Footer
-
- By default, this page is quite barren. However, if you explore
- the Search page some more, you will find that you can store numerous
- queries on the server, so if you regularly run a particular query it is
- just a drop-down menu away. Once you have a stored query, you can come
+
+ On the Search page, you can store queries in Bugzilla, so if you
+ regularly run a particular query it is just a drop-down menu away.
+ Once you have a stored query, you can come
here to request that it also be displayed in your page footer.Permissions
-
+
This is a purely informative page which outlines your current
permissions on this installation of Bugzilla - what product groups you
are in, and whether you can edit bugs or perform various administration
diff --git a/docs/sgml/variants.sgml b/docs/sgml/variants.sgml
index 5fbea801fb..0626902720 100644
--- a/docs/sgml/variants.sgml
+++ b/docs/sgml/variants.sgml
@@ -30,38 +30,26 @@
Loki Bugzilla (Fenris)
- Fenris can be found at
-
- http://fenris.lokigames.com
-
- . It is a fork from Bugzilla.
+ Fenris was a fork from Bugzilla made by Loki Games; when
+ Loki went into receivership, it died. While Loki's other code lives on,
+ its custodians recommend Bugzilla for future bug-tracker deployments.
+ Issuezilla
- Issuezilla is another fork from Bugzilla, and seems nearly as
- popular as the Red Hat Bugzilla fork. Some Issuezilla team members are
- regular contributors to the Bugzilla mailing list/newsgroup. Issuezilla
- is not the primary focus of bug-tracking at tigris.org, however. Their
- Java-based bug-tracker,
-
-
- , is under heavy development and looks promising!
-
- URL:
-
- http://issuezilla.tigris.org/servlets/ProjectHome
-
+ Issuezilla was another fork from Bugzilla, made by collab.net and
+ hosted at tigris.org. It is also dead; the primary focus of bug-tracking
+ at tigris.org is their Java-based bug-tracker,
+ .
-
+ Scarab
- Scarab is a promising new bug-tracking system built using Java
- Serlet technology. As of this writing, no source code has been released
- as a package, but you can obtain the code from CVS.
+ Scarab is a new bug-tracking system built using Java
+ Serlet technology. It is currently at version 1.0 beta 7.URL:
http://scarab.tigris.org
@@ -72,9 +60,7 @@
Perforce SCMAlthough Perforce isn't really a bug tracker, it can be used as
- such through the
- jobs
-
+ such through the jobs
functionality.
@@ -87,10 +73,9 @@
SourceForge
- SourceForge is more of a way of coordinating geographically
- distributed free software and open source projects over the Internet than
- strictly a bug tracker, but if you're hunting for bug-tracking for your
- open project, it may be just what the software engineer ordered!
+ SourceForge is a way of coordinating geographically
+ distributed free software and open source projects over the Internet.
+ It has a built-in bug tracker, but it's not highly thought of.URL:
diff --git a/docs/xml/Bugzilla-Guide.xml b/docs/xml/Bugzilla-Guide.xml
index bd0b3a4a15..2c516c7ade 100644
--- a/docs/xml/Bugzilla-Guide.xml
+++ b/docs/xml/Bugzilla-Guide.xml
@@ -17,6 +17,7 @@
+
@@ -61,14 +62,15 @@ try to avoid clutter and feel free to waste space in the code to make it more re
The Bugzilla Guide
-
- Matthew
- P.
- Barnson
-
- mbarnson@sisna.com
-
+ Matthew
+ P.
+ Barnson
+
+
+ The
+ Bugzilla
+ Team
@@ -104,6 +106,9 @@ try to avoid clutter and feel free to waste space in the code to make it more re
&about;
+
+&introduction;
+
&using;
diff --git a/docs/xml/about.xml b/docs/xml/about.xml
index 62e4865731..df21d1f2db 100644
--- a/docs/xml/about.xml
+++ b/docs/xml/about.xml
@@ -4,40 +4,6 @@
About This Guide
-
- Purpose and Scope of this Guide
-
- Bugzilla is simply the best piece of bug-tracking software the
- world has ever seen. This document is intended to be the
- comprehensive guide to the installation, administration,
- maintenance, and use of the Bugzilla bug-tracking system.
-
-
- This release of the Bugzilla Guide is the
- &bzg-ver; release. It is so named that it
- may match the current version of Bugzilla. The numbering
- tradition stems from that used for many free software projects,
- in which even-numbered point releases (1.2,
- 1.14, etc.) are considered "stable releases", intended for
- public consumption; on the other hand,
- odd-numbered point releases (1.3, 2.09,
- etc.) are considered unstable development
- releases intended for advanced users, systems administrators,
- developers, and those who enjoy a lot of pain.
-
-
- Newer revisions of the Bugzilla Guide follow the numbering
- conventions of the main-tree Bugzilla releases, available at
- &bz;. Intermediate releases will have
- a minor revision number following a period. The current version
- of Bugzilla, as of this writing (&bzg-date;) is &bz-ver;; if
- something were seriously wrong with that edition of the Guide,
- subsequent releases would receive an additional dotted-decimal
- digit to indicate the update (&bzg-ver;.1, &bzg-ver;.2, etc.).
- Got it? Good.
-
-
-
Copyright Information
@@ -64,12 +30,11 @@
No liability for the contents of this document can be accepted.
Use the concepts, examples, and other content at your own risk.
- As this is a new edition of this document, there may be errors
- and inaccuracies that may damage your system. Use of this
- document may cause your girlfriend to leave you, your cats to
- pee on your furniture and clothing, your computer to cease
- functioning, your boss to fire you, and global thermonuclear
- war. Proceed with caution.
+ This document may contain errors
+ and inaccuracies that may damage your system, cause your partner
+ to leave you, your boss to fire you, your cats to
+ pee on your furniture and clothing, and global thermonuclear
+ war. Proceed with caution.
All copyrights are held by their respective owners, unless
@@ -100,7 +65,7 @@
team members, Netscape Communications, America Online Inc., and
any affiliated developers or sponsors assume no liability for
your use of this product. You have the source code to this
- product, and are responsible for auditing it yourself to insure
+ product, and are responsible for auditing it yourself to ensure
your security needs are met.
@@ -110,7 +75,8 @@
New Versions
- This is the &bzg-ver; version of The Bugzilla Guide. If you are
+ This is the &bzg-ver; version of The Bugzilla Guide. It is so named
+ to match the current version of Bugzilla. If you are
reading this from any source other than those below, please
check one of these mirrors to make sure you are reading an
up-to-date version of the Guide.
@@ -134,9 +100,16 @@
- The latest version of this document can be checked out via CVS.
- Please follow the instructions available at the Mozilla CVS page, and check out the mozilla/webtools/bugzilla/docs/ branch.
+ The latest version of this document can always be checked out via CVS.
+ Please follow the instructions available at
+ the Mozilla CVS page,
+ and check out the mozilla/webtools/bugzilla/docs/
+ subtree.
+
+
+ The Bugzilla Guide is currently only available in English.
+ If you would like to volunteer to translate it, please contact
+ Dave Miller.
@@ -144,13 +117,14 @@
Credits
The people listed below have made enormous contributions to the
- creation of this Guide, through their dedicated hacking efforts,
+ creation of this Guide, through their writing, dedicated hacking efforts,
numerous e-mail and IRC support sessions, and overall excellent
contribution to the Bugzilla community:
Matthew P. Barnson
- for pulling together the Bugzilla Guide and shepherding it to 2.14.
+ for the Herculaean task of pulling together the Bugzilla Guide and
+ shepherding it to 2.14.
Terry Weissman
@@ -158,13 +132,13 @@
README upon which the UNIX installation documentation is largely based.
- Tara
- Hernandez for keeping Bugzilla development going
- strong after Terry left Mozilla.org
+ Tara Hernandez
+ for keeping Bugzilla development going
+ strong after Terry left mozilla.org
- Dave Lawrence for
- providing insight into the key differences between Red Hat's
+ Dave Lawrence
+ for providing insight into the key differences between Red Hat's
customized Bugzilla, and being largely responsible for the "Red
Hat Bugzilla" appendix
@@ -174,8 +148,8 @@
questions and arguments on irc.mozilla.org in #mozwebtools
- Last but not least, all the members of the netscape.public.mozilla.webtools newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened.
+ Last but not least, all the members of the
+ netscape.public.mozilla.webtools newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened.
Thanks also go to the following people for significant contributions
@@ -183,19 +157,7 @@
Zach Liption, Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen,
- Ron Teitelbaum, Jacob Steenhagen, Joe Robins.
-
-
-
-
- Translations
-
- The Bugzilla Guide needs translators! Please volunteer your
- translation into the language of your choice. If you will
- translate this Guide, please notify the members of the
- mozilla-webtools mailing list at
- mozilla-webtools@mozilla.org, and arrange with
- &bzg-auth; to check it into CVS.
+ Ron Teitelbaum, Jacob Steenhagen, Joe Robins, Gervase Markham.
diff --git a/docs/xml/administration.xml b/docs/xml/administration.xml
index cf52999e4c..ec422e2114 100644
--- a/docs/xml/administration.xml
+++ b/docs/xml/administration.xml
@@ -2,26 +2,11 @@
Administering Bugzilla
- Or, I just got this cool thing installed. Now what the heck do I
- do with it?
-
- So you followed
-
-
-
-
- to the letter, and logged into Bugzilla for the very first time with your
- super-duper god account. You sit, contentedly staring at the Bugzilla Query
- Screen, the worst of the whole mad business of installing this terrific
- program behind you. It seems, though, you have nothing yet to query! Your
- first act of business should be to setup the operating parameters for
- Bugzilla so you can get busy getting data into your bug tracker.
-
Post-Installation Checklist
- After installation, follow the checklist below to help ensure that
- you have a successful installation. If you do not see a recommended
+ After installation, follow the checklist below.
+ If you do not see a recommended
setting for a parameter, consider leaving it at the default while you
perform your initial tests on your Bugzilla setup.
@@ -31,185 +16,124 @@
- Bring up
- editparams.cgi
-
- in your web browser. This should be available as the
- edit parameters
-
- link from any Bugzilla screen once you have logged in.
+ Log in to Bugzilla using the username and password
+ you defined for the administrator during installation.
- The
- maintainer
-
- is the email address of the person responsible for maintaining this
- Bugzilla installation. The maintainer need not be a valid Bugzilla
- user. Error pages, error emails, and administrative mail will be sent
- with the maintainer as the return email address.
-
- Set
- maintainer
-
- to
- your
-
- email address. This allows Bugzilla's error messages to display your
- email address and allow people to contact you for help.
+ Bring up
+ editparams.cgi
+ in your web browser (link in footer.) This screen allows you
+ to change most of Bugzilla's operating parameters. Each comes
+ with an explanation, and you should go down the list, deciding
+ on what you want to do about each.
+
- The
- urlbase
-
- parameter defines the fully qualified domain name and web server path
- to your Bugzilla installation.
-
- For example, if your bugzilla query page is
- http://www.foo.com/bugzilla/query.cgi, set your
- urlbase
-
- is http://www.foo.com/bugzilla/.
+
+ maintainer:
+ The maintainer parameter is the email address of the person
+ responsible for maintaining this
+ Bugzilla installation. The address need not be that of a valid Bugzilla
+ account.
- usebuggroups
+ urlbase:
+ This parameter defines the fully qualified domain name and web
+ server path to your Bugzilla installation.
+
+ For example, if your Bugzilla query page is
+ http://www.foo.com/bugzilla/query.cgi,
+ set your urlbase
+ to http://www.foo.com/bugzilla/.
+
- dictates whether or not to implement group-based security for
- Bugzilla. If set, Bugzilla bugs can have an associated groupmask
- defining which groups of users are allowed to see and edit the
+
+
+ usebuggroups:
+ Thisdictates whether or not to implement group-based security for
+ Bugzilla. If set, Bugzilla bugs can have an associated 'group',
+ defining which users are allowed to see and edit the
bug.Set "usebuggroups" to "on"
only
-
- if you may wish to restrict access to products. I suggest leaving
- this parameter
- off
-
+ if you may wish to restrict access to particular bugs to certain
+ groups of users. I suggest leaving
+ this parameter off
while initially testing your Bugzilla.
- usebuggroupsentry
-
- , when set to
- on
-
- , requires that all bugs have an associated groupmask when submitted.
- This parameter is made for those installations where product
- isolation is a necessity.
-
- Set "usebuggroupsentry" to "on" if you absolutely need to
- restrict access to bugs from the moment they are submitted through
- resolution. Once again, if you are simply testing your installation,
- I suggest against turning this parameter on; the strict security
- checking may stop you from being able to modify your new
- entries.
+ usebuggroupsentry:
+ When set to on, this
+ puts all bugs be placed in the group for their product immediately
+ after creation.
- You run into an interesting problem when Bugzilla reaches a
+
+ shadowdb:
+ You run into an interesting problem when Bugzilla reaches a
high level of continuous activity. MySQL supports only table-level
write locking. What this means is that if someone needs to make a
change to a bug, they will lock the entire table until the operation
is complete. Locking for write also blocks reads until the write is
complete. The
shadowdb
-
parameter was designed to get around this limitation. While only a
single user is allowed to write to a table at a time, reads can
continue unimpeded on a read-only shadow copy of the database.
Although your database size will double, a shadow database can cause
an enormous performance improvement when implemented on extremely
high-traffic Bugzilla databases.
+
+
+ As a guide, mozilla.org began needing
+ shadowdb
+ when they reached around 40,000 Bugzilla users with several hundred
+ Bugzilla bug changes and comments per day.
- Set "shadowdb" to "bug_shadowdb" if you will be running a
- *very* large installation of Bugzilla. The shadow database enables
- many simultaneous users to read and write to the database without
- interfering with one another.
+ The value of the parameter defines the name of the
+ shadow bug database.
+ Set "shadowdb" to e.g. "bug_shadowdb" if you will be running a
+ *very* large installation of Bugzilla.
Enabling "shadowdb" can adversely affect the stability of
your installation of Bugzilla. You should regularly check that your
database is in sync. It is often advisable to force a shadow
database sync nightly via
- cron
-
- .
+ cron.
+
-
- Once again, in testing you should avoid this option -- use it if or
- when you
- need
-
- to use it, and have repeatedly run into the problem it was designed
- to solve -- very long wait times while attempting to commit a change
- to the database. Mozilla.org began needing
- shadowdb
-
- when they reached around 40,000 Bugzilla users with several hundred
- Bugzilla bug changes and comments per day.
-
+
+
If you use the "shadowdb" option, it is only natural that you
- should turn the "queryagainstshadowdb" option "On" as well. Otherwise
+ should turn the "queryagainstshadowdb" option on as well. Otherwise
you are replicating data into a shadow database for no reason!
+
- headerhtml
-
- ,
- footerhtml
-
- ,
- errorhtml
-
- ,
- bannerhtml
-
- , and
- blurbhtml
-
- are all templates which control display of headers, footers, errors,
- banners, and additional data. We could go into some detail regarding
- the usage of these, but it is really best just to monkey around with
- them a bit to see what they do. I strongly recommend you copy your
- data/params
-
- file somewhere safe before playing with these values, though. If they
- are changed dramatically, it may make it impossible for you to
- display Bugzilla pages to fix the problem until you have restored
- your
- data/params
-
- file.
-
- If you have custom logos or HTML you must put in place to fit
- within your site design guidelines, place the code in the
- "headerhtml", "footerhtml", "errorhtml", "bannerhtml", or "blurbhtml"
- text boxes.
-
- The "headerhtml" text box is the HTML printed out
- before
+ shutdownhtml:
- any other code on the page, except the CONTENT-TYPE header sent by
- the Bugzilla engine. If you have a special banner, put the code for
- it in "bannerhtml". You may want to leave these settings at the
- defaults initially.
-
+ If you need to shut down Bugzilla to perform administration, enter
+ some descriptive HTML here and anyone who tries to use Bugzilla will
+ receive a page to that effect.
- passwordmail
+ passwordmail:
- is rather simple. Every time a user creates an account, the text of
- this parameter is read as the text to send to the new user along with
+ Every time a user creates an account, the text of
+ this parameter (with substitutions) is sent to the new user along with
their password message.Add any text you wish to the "passwordmail" parameter box. For
@@ -219,45 +143,29 @@
- useqacontact
+ useqacontact:
- allows you to define an email address for each component, in addition
+ This allows you to define an email address for each component, in
+ addition
to that of the default owner, who will be sent carbon copies of
- incoming bugs. The critical difference between a QA Contact and an
- Owner is that the QA Contact follows the component. If you reassign a
- bug from component A to component B, the QA Contact for that bug will
- change with the reassignment, regardless of owner.
-
+ incoming bugs.
+
+
- usestatuswhiteboard
-
- defines whether you wish to have a free-form, overwritable field
+ usestatuswhiteboard:
+ This defines whether you wish to have a free-form, overwritable field
associated with each bug. The advantage of the Status Whiteboard is
that it can be deleted or modified with ease, and provides an
easily-searchable field for indexing some bugs that have some trait
- in common. Many people will put
- help wanted
-
- ,
- stalled
-
- , or
- waiting on reply from somebody
-
- messages into the Status Whiteboard field so those who peruse the
- bugs are aware of their status even more than that which can be
- indicated by the Resolution fields.
-
- Do you want to use the QA Contact ("useqacontact") and status
- whiteboard ("usestatuswhiteboard") fields? These fields are useful
- because they allow for more flexibility, particularly when you have
- an existing Quality Assurance and/or Release Engineering team, but
- they may not be needed for many smaller installations.
+ in common.
+
- Set "whinedays" to the amount of days you want to let bugs go
- in the "New" or "Reopened" state before notifying people they have
+
+ whinedays:
+ Set this to the number of days you want to let bugs go
+ in the NEW or REOPENED state before notifying people they have
untouched new bugs. If you do not plan to use this feature, simply do
not set up the whining cron job described in the installation
instructions, or set this value to "0" (never whine).
@@ -265,8 +173,8 @@
- commenton
-
+ commenton*:
+ All these
fields allow you to dictate what changes can pass without comment,
and which must have a comment from the person who changed them.
Often, administrators will allow users to add themselves to the CC
@@ -288,30 +196,17 @@
- The
- supportwatchers
+
+ supportwatchers:
- option can be an exceptionally powerful tool in the hands of a power
- Bugzilla user. By enabling this option, you allow users to receive
- email updates whenever other users receive email updates. This is, of
+ Turning on this option allows users to ask to receive copies of
+ all a particular other user's bug email. This is, of
course, subject to the groupset restrictions on the bug; if the
watcher
-
would not normally be allowed to view a bug, the watcher cannot get
around the system by setting herself up to watch the bugs of someone
- with bugs outside her privileges. She would still only receive email
- updates for those bugs she could normally view.
-
- For Bugzilla sites which require strong inter-Product security
- to prevent snooping, watchers are not a good idea.
-
- However, for most sites you should set
- supportwatchers
-
- to "On". This feature is helpful for team leads to monitor progress
- in their respective areas, and can offer many other benefits, such as
- allowing a developer to pick up a former engineer's bugs without
- requiring her to change all the information in the bug.
+ with bugs outside her privileges. They would still only receive email
+ updates for those bugs she could normally view.
diff --git a/docs/xml/conventions.xml b/docs/xml/conventions.xml
index f6aa003387..4b03286427 100644
--- a/docs/xml/conventions.xml
+++ b/docs/xml/conventions.xml
@@ -6,7 +6,7 @@
conventions
- This document uses the following conventions
+ This document uses the following conventions:
@@ -34,7 +34,7 @@
- Warm jar lids under the hot tap to loosen them.
+ Would you like a breath mint?
@@ -140,7 +140,6 @@
para
-
Beginning and end of paragraph
para
diff --git a/docs/xml/installation.xml b/docs/xml/installation.xml
index 8cadbdd587..27291dad78 100644
--- a/docs/xml/installation.xml
+++ b/docs/xml/installation.xml
@@ -1,1729 +1,1434 @@
+
+ Installation
-
- Installation
-
- These installation instructions are presented assuming you are
- installing on a UNIX or completely POSIX-compliant system. If
- you are installing on Microsoft Windows or another oddball
- operating system, please consult the appropriate sections in
- this installation guide for notes on how to be successful.
-
-
- ERRATA
- Here are some miscellaneous notes about possible issues you
- main run into when you begin your Bugzilla installation.
- Reference platforms for Bugzilla installation are Redhat Linux
- 7.2, Linux-Mandrake 8.0, and Solaris 8.
-
-
-
- If you are installing Bugzilla on S.u.S.e. Linux, or some
- other distributions with paranoid security
- options, it is possible that the checksetup.pl script may fail
- with the error: cannot chdir(/var/spool/mqueue):
- Permission denied This is because your
- /var/spool/mqueue directory has a mode of
- drwx------. Type chmod 755
- /var/spool/mqueue as root to
- fix this problem.
-
-
-
- Bugzilla may be installed on Macintosh OS X (10), which is a
- unix-based (BSD) operating system. Everything required for
- Bugzilla on OS X will install cleanly, but the optional GD
- perl module which is used for bug charting requires some
- additional setup for installation. Please see the Mac OS X
- installation section below for details
-
-
-
- Release Notes for Bugzilla &bz-ver; are available at
- docs/rel_notes.txt in your Bugzilla
- source distribution.
-
-
-
- The preferred documentation for Bugzilla is available in
- docs/, with a variety of document types available. Please
- refer to these documents when installing, configuring, and
- maintaining your Bugzilla installation.
-
-
-
-
-
-
- Bugzilla is not a package where you can just plop it in a directory,
- twiddle a few things, and you're off. Installing Bugzilla assumes you
- know your variant of UNIX or Microsoft Windows well, are familiar with the
- command line, and are comfortable compiling and installing a plethora
- of third-party utilities. To install Bugzilla on Win32 requires
- fair Perl proficiency, and if you use a webserver other than Apache you
- should be intimately familiar with the security mechanisms and CGI
- environment thereof.
-
-
-
-
-
- Bugzilla has not undergone a complete security review. Security holes
- may exist in the code. Great care should be taken both in the installation
- and usage of this software. Carefully consider the implications of
- installing other network services with Bugzilla.
-
-
-
-
Step-by-step Install
+
Introduction
-
- Installation of bugzilla is pretty straightforward, particularly if your
- machine already has MySQL and the MySQL-related perl packages installed.
- If those aren't installed yet, then that's the first order of business. The
- other necessary ingredient is a web server set up to run cgi scripts.
- While using Apache for your webserver is not required, it is recommended.
-
-
-
- Bugzilla has been successfully installed under Solaris, Linux,
- and Win32. The peculiarities of installing on Win32 (Microsoft
- Windows) are not included in this section of the Guide; please
- check out the for further advice
- on getting Bugzilla to work on Microsoft Windows.
-
-
-
- The Bugzilla Guide is contained in the "docs/" folder in your
- Bugzilla distribution. It is available in plain text
- (docs/txt), HTML (docs/html), or SGML source (docs/sgml).
-
+
+ Bugzilla has been successfully installed under Solaris, Linux,
+ and Win32. Win32 is not yet officially supported, but many people
+ have got it working fine.
+ Please see the
+
+ for further advice on getting Bugzilla to work on Microsoft
+ Windows.
+
+
- Installing the Prerequisites
+ Package List
+
- If you want to skip these manual installation steps for
- the CPAN dependencies listed below, and are running the very
- most recent version of Perl and MySQL (both the executables
- and development libraries) on your system, check out
- Bundle::Bugzilla in
+ If you are running the very most recent
+ version of Perl and MySQL (both the executables and development
+ libraries) on your system, you can skip these manual installation
+ steps for the Perl modules by using Bundle::Bugzilla in
+ .
+
+
+
+ The software packages necessary for the proper running of
+ Bugzilla are:
+
+
+ MySQL database server and the mysql client (3.22.5 or
+ greater)
+
+
+
+ Perl (5.005 or greater, 5.6.1 is recommended if you wish to
+ use Bundle::Bugzilla)
+
+
+
+ Perl Modules (minimum version):
+
+
+ Template (v2.07)
+
+
+
+ AppConfig (v1.52)
+
+
+
+ Text::Wrap (v2001.0131)
+
+
+
+ File::Spec (v0.8.2)
+
+
+
+ Data::Dumper (any)
+
+
+
+ DBD::mysql (v1.2209)
+
+
+
+ DBI (v1.13)
+
+
+
+ Date::Parse (any)
+
+
+
+ CGI::Carp (any)
+
+
+
+ and, optionally:
+
+
+ GD (v1.19) for bug charting
+
+
+
+ Chart::Base (v0.99c) for bug charting
+
+
+
+ XML::Parser (any) for the XML interface
+
+
+
+ MIME::Parser (any) for the email interface
+
+
+
+
+
+
+
+ The web server of your choice. Apache is recommended.
+
+
+
+
+
+ It is a good idea, while installing Bugzilla, to ensure that there
+ is some kind of firewall between you and the rest of the Internet,
+ because your machine may be insecure for periods during the install.
+ Many
+ installation steps require an active Internet connection to complete,
+ but you must take care to ensure that at no point is your machine
+ vulnerable to an attack.
+
+
+
+ Linux-Mandrake 8.0 includes every
+ required and optional library for Bugzilla. The easiest way to
+ install them is by using the
+ urpmi
+
+ utility. If you follow these commands, you should have everything you
+ need for Bugzilla, and
+ checksetup.pl
+
+ should not complain about any missing libraries. You may already have
+ some of these installed.
+
+
+
+ bash#
+
+ urpmi perl-mysql
+
+
+
+ bash#
+
+ urpmi perl-chart
+
+
+
+ bash#
+
+ urpmi perl-gd
+
+
+
+ bash#
+
+ urpmi perl-MailTools
+
+ (for Bugzilla email integration)
+
+
+ bash#
+
+ urpmi apache-modules
+
+
-
- The software packages necessary for the proper running of bugzilla are:
-
-
-
- MySQL database server and the mysql client (3.22.5 or greater)
-
-
-
-
- Perl (5.004 or greater, 5.6.1 is recommended if you wish
- to use Bundle::Bugzilla)
-
-
-
-
- DBI Perl module
-
-
-
-
- Data::Dumper Perl module
-
-
-
-
- Bundle::Mysql Perl module collection
-
-
-
-
- TimeDate Perl module collection
-
-
-
-
- GD perl module (1.8.3) (optional, for bug charting)
-
-
-
-
- Chart::Base Perl module (0.99c) (optional, for bug charting)
-
-
-
-
- DB_File Perl module (optional, for bug charting)
-
-
-
-
- The web server of your choice. Apache is recommended.
-
-
-
-
- MIME::Parser Perl module (optional, for contrib/bug_email.pl interface)
-
-
-
-
-
-
- It is a good idea, while installing Bugzilla, to ensure it
- is not accessible by other machines
- on the Internet. Your machine may be vulnerable to attacks
- while you are installing. In other words, ensure there is
- some kind of firewall between you and the rest of the
- Internet. Many installation steps require an active
- Internet connection to complete, but you must take care to
- ensure that at no point is your machine vulnerable to an
- attack.
-
-
-
- Linux-Mandrake 8.0, the author's test system, includes
- every required and optional library for Bugzilla. The
- easiest way to install them is by using the
- urpmi utility. If you follow these
- commands, you should have everything you need for
- Bugzilla, and checksetup.pl should
- not complain about any missing libraries. You may already
- have some of these installed.
-
- bash# urpmi
- perl-mysql
- bash# urpmi
- perl-chart
- bash# urpmi
- perl-gd
- bash# urpmi
- perl-MailTools (for Bugzilla email
- integration)
- bash# urpmi
- apache-modules
-
-
-
+
- Installing MySQL Database
-
- Visit MySQL homepage at www.mysql.com and grab the latest stable release of the server. Many of the binary versions of MySQL store their data files in /var which is often part of a smaller root partition. If you decide to build from sources you can easily set the dataDir as an option to configure.
-
-
- If you install from source or non-package (RPM, deb, etc.)
- binaries you need to add
- mysqld to your
- init scripts so the server daemon will come back up whenever
- your machine reboots. Further discussion of UNIX init
- sequences are beyond the scope of this guide.
-
- You should have your init script start
- mysqld with the ability to accept
- large packets. By default, mysqld
- only accepts packets up to 64K long. This limits the size
- of attachments you may put on bugs. If you add to the command that starts
- mysqld (or
- safe_mysqld), then you will be able
- to have attachments up to about 1 megabyte.
-
+ MySQL
+ Visit the MySQL homepage at
+ www.mysql.com
+ to grab and install the latest stable release of the server.
+
-
- If you plan on running Bugzilla and MySQL on the same
- machine, consider using the
- option in the init script. This enhances security by
- preventing network access to MySQL.
-
+ Many of the binary
+ versions of MySQL store their data files in
+ /var.
+ On some Unix systems, this is part of a smaller root partition,
+ and may not have room for your bug database. If you decide to build
+ from sources you can easily set the dataDir as an option to
+ configure.
+
+ If you install from source or non-package (RPM, deb, etc.)
+ binaries you need to add
+ mysqld
+ to your init scripts so the server daemon will come back up whenever
+ your machine reboots. Further discussion of UNIX init sequences are
+ beyond the scope of this guide.
+
+
+ Change your init script to start
+ mysqld
+ with the ability to accept large packets. By default,
+ mysqld
+ only accepts packets up to 64K long. This limits the size of
+ attachments you may put on bugs. If you add
+
+ to the command that starts
+ mysqld
+ (or safe_mysqld),
+ then you will be able to have attachments up to about 1 megabyte.
+ There is a Bugzilla parameter for maximum attachment size;
+ you should configure it to match the value you choose here.
+
+ If you plan on running Bugzilla and MySQL on the same machine,
+ consider using the
+
+ option in the init script. This enhances security by preventing
+ network access to MySQL.
+
-
+
- Perl (5.004 or greater)
-
- Any machine that doesn't have perl on it is a sad machine
- indeed. Perl for *nix systems can be gotten in source form
- from http://www.perl.com. Although Bugzilla runs with most
- post-5.004 versions of Perl, it's a good idea to be up to the
- very latest version if you can when running Bugzilla. As of
- this writing, that is perl version &perl-ver;.
-
-
- Perl is now a far cry from the the single compiler/interpreter
- binary it once was. It includes a great many required modules
- and quite a few other support files. If you're not up to or
- not inclined to build perl from source, you'll want to install
- it on your machine using some sort of packaging system (be it
- RPM, deb, or what have you) to ensure a sane install. In the
- subsequent sections you'll be installing quite a few perl
- modules; this can be quite ornery if your perl installation
- isn't up to snuff.
+ Perl
+
+ Any machine that doesn't have Perl on it is a sad machine indeed.
+ Perl can be got in source form from
+ perl.com for the rare
+ *nix systems which don't have it.
+ Although Bugzilla runs with all post-5.005
+ versions of Perl, it's a good idea to be up to the very latest version
+ if you can when running Bugzilla. As of this writing, that is Perl
+ version &perl-ver;.
+
+
+
+ You can skip the following Perl module installation steps by
+ installing
+ Bundle::Bugzilla
+
+ from
+ CPAN,
+ which installs all required modules for you.
+ If you wish to use
+ Bundle::Bugzilla, you must be using the latest version of
+ Perl.
+
+
+
+ bash#
+
+ perl -MCPAN -e 'install "Bundle::Bugzilla"'
+
+
+
+ Bundle::Bugzilla doesn't include GD, Chart::Base, or
+ MIME::Parser, which are not essential to a basic Bugzilla install. If
+ installing this bundle fails, you should install each module
+ individually to isolate the problem.
+
+
+
+
+ Perl Modules
+
+
+ All Perl modules can be found on the
+ Comprehensive Perl Archive Network (CPAN) at http://www.cpan.org. The
+ CPAN servers have a real tendency to bog down, so please use mirrors.
+ The current location at the time of this writing can be found in
+ .
+
+
+ Quality, general Perl module installation instructions can be
+ found on the CPAN website, but the easy thing to do is to just use the
+ CPAN shell which does all the hard work for you.
+
+ To use the CPAN shell to install a module:
+
+
+
+ bash#
+ perl -MCPAN -e 'install "<modulename>"'
+
+
+
+
+ To do it the hard way:
+
+ Untar the module tarball -- it should create its own
+ directory
+
+ CD to the directory just created, and enter the following
+ commands:
+
+
+
+
+ bash#
+
+ perl Makefile.PL
+
+
+
+
+
+
+
+ bash#
+
+ make
+
+
+
+
+
+
+
+ bash#
+
+ make test
+
+
+
+
+
+
+
+ bash#
+
+ make install
+
+
+
+
+
+
+
- Many people complain that Perl modules will not install
- for them. Most times, the error messages complain that they
- are missing a file in @INC. Virtually every
- time, this is due to permissions being set too restrictively
- for you to compile Perl modules or not having the necessary
- Perl development libraries installed on your system..
- Consult your local UNIX systems administrator for help
- solving these permissions issues; if you
- are the local UNIX sysadmin, please
- consult the newsgroup/mailing list for further assistance or
- hire someone to help you out.
-
+ Many people complain that Perl modules will not install for
+ them. Most times, the error messages complain that they are missing a
+ file in
+ @INC.
+ Virtually every time, this error is due to permissions being set too
+ restrictively for you to compile Perl modules or not having the
+ necessary Perl development libraries installed on your system.
+ Consult your local UNIX systems administrator for help solving these
+ permissions issues; if you
+ are
+ the local UNIX sysadmin, please consult the newsgroup/mailing list
+ for further assistance or hire someone to help you out.
-
-
- You can skip the following Perl module installation steps by
- installing Bundle::Bugzilla from
- CPAN, which
- includes them. All Perl module installation steps require
- you have an active Internet connection. If you wish to use
- Bundle::Bugzilla, however, you must be using the latest
- version of Perl (at this writing, version &perl-ver;)
-
-
- bash#perl -MCPAN
- -e 'install "Bundle::Bugzilla"'
-
-
-
- Bundle::Bugzilla doesn't include GD, Chart::Base, or
- MIME::Parser, which are not essential to a basic Bugzilla
- install. If installing this bundle fails, you should
- install each module individually to isolate the problem.
-
-
+
+
+
+ DBI
+
+ The DBI module is a generic Perl module used the
+ MySQL-related modules. As long as your Perl installation was done
+ correctly the DBI module should be a breeze. It's a mixed Perl/C
+ module, but Perl's MakeMaker system simplifies the C compilation
+ greatly.
-
+
- DBI Perl Module
-
- The DBI module is a generic Perl module used by other database related
- Perl modules. For our purposes it's required by the MySQL-related
- modules. As long as your Perl installation was done correctly the
- DBI module should be a breeze. It's a mixed Perl/C module, but Perl's
- MakeMaker system simplifies the C compilation greatly.
-
-
- Like almost all Perl modules DBI can be found on the Comprehensive Perl
- Archive Network (CPAN) at http://www.cpan.org. The CPAN servers have a
- real tendency to bog down, so please use mirrors. The current location
- at the time of this writing can be found in .
-
-
- Quality, general Perl module installation instructions can be found on
- the CPAN website, but the easy thing to do is to just use the CPAN shell
- which does all the hard work for you.
-
-
- To use the CPAN shell to install DBI:
-
-
-
- bash#
- perl -MCPAN -e 'install "DBI"'
-
-
- Replace "DBI" with the name of whichever module you wish
- to install, such as Data::Dumper, TimeDate, GD, etc.
-
-
-
- To do it the hard way:
-
-
- Untar the module tarball -- it should create its own directory
-
-
- CD to the directory just created, and enter the following commands:
-
-
-
-
- bash#
- perl Makefile.PL
-
-
-
-
-
-
- bash#
- make
-
-
-
-
-
-
- bash#
- make test
-
-
-
-
-
-
- bash#
- make install
-
-
-
-
- If everything went ok that should be all it takes. For the vast
- majority of perl modules this is all that's required.
-
-
-
+ Data::Dumper
+
+ The Data::Dumper module provides data structure persistence for
+ Perl (similar to Java's serialization). It comes with later
+ sub-releases of Perl 5.004, but a re-installation just to be sure it's
+ available won't hurt anything.
+
- Data::Dumper Perl Module
-
- The Data::Dumper module provides data structure persistence for Perl
- (similar to Java's serialization). It comes with later sub-releases of
- Perl 5.004, but a re-installation just to be sure it's available won't
- hurt anything.
-
-
- Data::Dumper is used by the MySQL-related Perl modules. It
- can be found on CPAN (see ) and
- can be
- installed by following the same four step make sequence used
- for the DBI module.
+ MySQL-related modules
+
+ The Perl/MySQL interface requires a few mutually-dependent Perl
+ modules. These modules are grouped together into the the
+ Msql-Mysql-modules package.
+
+ The MakeMaker process will ask you a few questions about the
+ desired compilation target and your MySQL installation. For most of the
+ questions the provided default will be adequate, but when asked if your
+ desired target is the MySQL or mSQL packages, you should
+ select the MySQL related ones. Later you will be asked if you wish to
+ provide backwards compatibility with the older MySQL packages; you
+ should answer YES to this question. The default is NO.
+
+ A host of 'localhost' should be fine and a testing user of 'test'
+ with a null password should find itself with sufficient access to run
+ tests on the 'test' database which MySQL created upon installation.
-
+
- MySQL related Perl Module Collection
-
- The Perl/MySQL interface requires a few mutually-dependent perl
- modules. These modules are grouped together into the the
- Msql-Mysql-modules package. This package can be found at CPAN.
- After the archive file has been downloaded it should
- be untarred.
-
-
- The MySQL modules are all built using one make file which is generated
- by running:
- bash#
- perl Makefile.pl
-
-
- The MakeMaker process will ask you a few questions about the desired
- compilation target and your MySQL installation. For many of the questions
- the provided default will be adequate.
-
-
- When asked if your desired target is the MySQL or mSQL packages,
- select the MySQL related ones. Later you will be asked if you wish
- to provide backwards compatibility with the older MySQL packages; you
- should answer YES to this question. The default is NO.
-
-
- A host of 'localhost' should be fine and a testing user of 'test' and
- a null password should find itself with sufficient access to run tests
- on the 'test' database which MySQL created upon installation. If 'make
- test' and 'make install' go through without errors you should be ready
- to go as far as database connectivity is concerned.
-
-
+ TimeDate modules
-
- TimeDate Perl Module Collection
-
- Many of the more common date/time/calendar related Perl
- modules have been grouped into a bundle similar to the MySQL
- modules bundle. This bundle is stored on the CPAN under the
- name TimeDate (see link: ). The
- component module we're most interested in is the Date::Format
- module, but installing all of them is probably a good idea
- anyway. The standard Perl module installation instructions
- should work perfectly for this simple package.
-
-
-
- GD Perl Module (1.8.3)
-
- The GD library was written by Thomas Boutell a long while
- ago to programatically generate images in C. Since then it's
- become the defacto standard for programatic image
- construction. The Perl bindings to it found in the GD library
- are used on millions of web pages to generate graphs on the
- fly. That's what bugzilla will be using it for so you must
- install it if you want any of the graphing to work.
-
-
- Actually bugzilla uses the Graph module which relies on GD
- itself. Isn't that always the way with object-oriented
- programming? At any rate, you can find the GD library on CPAN
- in .
-
-
-
- The Perl GD library requires some other libraries that may
- or may not be installed on your system, including
- libpng and
- libgd. The full requirements are
- listed in the Perl GD library README. Just realize that if
- compiling GD fails, it's probably because you're missing a
- required library.
-
-
-
+ Many of the more common date/time/calendar related Perl modules
+ have been grouped into a bundle similar to the MySQL modules bundle.
+ This bundle is stored on the CPAN under the name TimeDate.
+ The component module we're most interested in is the Date::Format
+ module, but installing all of them is probably a good idea anyway.
+
+
-
- Chart::Base Perl Module (0.99c)
-
- The Chart module provides bugzilla with on-the-fly charting
- abilities. It can be installed in the usual fashion after it
- has been fetched from CPAN where it is found as the
- Chart-x.x... tarball, linked in . Note that
- as with the GD perl module, only the version listed above, or
- newer, will work. Earlier versions used GIF's, which are no
- longer supported by the latest versions of GD.
-
-
+
+ GD (optional)
-
- DB_File Perl Module
-
- DB_File is a module which allows Perl programs to make use
- of the facilities provided by Berkeley DB version 1.x. This
- module is required by collectstats.pl which is used for bug
- charting. If you plan to make use of bug charting, you must
- install this module.
-
-
+ The GD library was written by Thomas Boutell a long while ago to
+ programatically generate images in C. Since then it's become the
+ defacto standard for programatic image construction. The Perl bindings
+ to it found in the GD library are used on millions of web pages to
+ generate graphs on the fly. That's what Bugzilla will be using it for
+ so you must install it if you want any of the graphing to work.
-
- HTTP Server
-
- You have a freedom of choice here - Apache, Netscape or any
- other server on UNIX would do. You can easily run the web
- server on a different machine than MySQL, but need to adjust
- the MySQL bugs user permissions accordingly.
-
- I strongly recommend Apache as the web server to use.
- The Bugzilla Guide installation instructions, in general,
- assume you are using Apache. As more users use different
- webservers and send me information on the peculiarities of
- installing using their favorite webserver, I will provide
- notes for them.
-
-
-
- You'll want to make sure that your web server will run any
- file with the .cgi extension as a cgi and not just display it.
- If you're using apache that means uncommenting the following
- line in the srm.conf file:
-
-AddHandler cgi-script .cgi
-
-
-
- With apache you'll also want to make sure that within the
- access.conf file the line:
-
-Options ExecCGI
-AllowOverride Limit
-
- is in the stanza that covers the directories into which
- you intend to put the bugzilla .html and .cgi files.
-
-
- AllowOverride Limit allows the use of a Deny statement in the
- .htaccess file generated by checksetup.pl
-
-
- Users of newer versions of Apache will generally find both
- of the above lines will be in the httpd.conf file, rather
- than srm.conf or access.conf.
-
+ The Perl GD library requires some other libraries that may or
+ may not be installed on your system, including
+ libpng
+ and
+ libgd.
+ The full requirements are listed in the Perl GD library README.
+ If compiling GD fails, it's probably because you're
+ missing a required library.
-
-
- There are important files and directories that should not
- be a served by the HTTP server. These are most files in the
- data and shadow directories
- and the localconfig file. You should
- configure your HTTP server to not serve content from these
- files. Failure to do so will expose critical passwords and
- other data. Please see for details
- on how to do this for Apache. I appreciate notes on how to
- get this same functionality using other webservers.
-
-
-
+
-
- Installing the Bugzilla Files
-
- You should untar the Bugzilla files into a directory that
- you're willing to make writable by the default web server user
- (probably nobody). You may decide to put the
- files off of the main web space for your web server or perhaps
- off of /usr/local with a symbolic link in
- the web space that points to the Bugzilla directory. At any
- rate, just dump all the files in the same place, and make sure
- you can access the files in that directory through your web
- server.
-
-
-
- If you symlink the bugzilla directory into your Apache's
- HTML heirarchy, you may receive
- Forbidden errors unless you add the
- FollowSymLinks directive to the
- <Directory> entry for the HTML root.
-
-
-
- Once all the files are in a web accessible directory, make
- that directory writable by your webserver's user. This is a
- temporary step until you run the post-install
- checksetup.pl script, which locks down your
- installation.
-
-
- Lastly, you'll need to set up a symbolic link to
- /usr/bonsaitools/bin/perl for the correct
- location of your perl executable (probably
- /usr/bin/perl). Otherwise you must hack
- all the .cgi files to change where they look for perl, or use
- , found in
- . I suggest using the symlink
- approach for future release compatability.
-
- Setting up bonsaitools symlink
-
- Here's how you set up the Perl symlink on Linux to make
- Bugzilla work. Your mileage may vary. For some UNIX
- operating systems, you probably need to subsitute
- /usr/local/bin/perl for
- /usr/bin/perl below; if on certain other
- UNIX systems, Perl may live in weird places like
- /opt/perl. As root, run these commands:
-
-bash# mkdir /usr/bonsaitools
-bash# mkdir /usr/bonsaitools/bin
-bash# ln -s /usr/bin/perl /usr/bonsaitools/bin/perl
-
-
-
- Alternately, you can simply run this perl one-liner to
- change your path to perl in all the files in your Bugzilla
- installation:
-
-perl -pi -e 's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm
-processmail syncshadowdb
-
- Change the second path to perl to match your installation.
-
-
-
-
- If you don't have root access to set this symlink up,
- check out the
- , listed in . It will change the path to perl in all your Bugzilla files for you.
-
-
-
-
+
+ Chart::Base (optional)
-
- Setting Up the MySQL Database
-
- After you've gotten all the software installed and working you're ready
- to start preparing the database for its life as a the back end to a high
- quality bug tracker.
-
-
- First, you'll want to fix MySQL permissions to allow access
- from Bugzilla. For the purpose of this Installation section,
- the Bugzilla username will be bugs, and will
- have minimal permissions.
-
-
-
- Bugzilla has not undergone a thorough security audit. It
- may be possible for a system cracker to somehow trick
- Bugzilla into executing a command such as DROP
- DATABASE mysql.
-
- That would be bad.
-
-
-
-
- Give the MySQL root user a password. MySQL passwords are
- limited to 16 characters.
-
-
- bash#mysql
- -u root mysql
-
-
- mysql>
- UPDATE user SET Password=PASSWORD ('new_password')
- WHERE user='root';
-
-
- mysql>FLUSH
- PRIVILEGES;
-
- From this point on, if you need to access
- MySQL as the MySQL root user, you will need to use
- mysql -u root -p and enter your
- new_password. Remember that MySQL user names have nothing to
- do with Unix user names (login names).
-
-
- Next, we create the bugs user, and grant
- sufficient permissions for checksetup.pl, which we'll use
- later, to work its magic. This also restricts the
- bugs user to operations within a database
- called bugs, and only allows the account to
- connect from localhost. Modify it to reflect
- your setup if you will be connecting from another machine or
- as a different user.
-
-
- Remember to set bugs_password to some unique password.
-
-
-
- mysql>
- GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,
- ALTER,CREATE,DROP,REFERENCES
- ON bugs.* TO bugs@localhost
- IDENTIFIED BY 'bugs_password';
-
-
-
-
-
- mysql>
-
-
- FLUSH PRIVILEGES;
-
-
-
-
-
-
- Next, run the magic checksetup.pl script. (Many thanks to
- Holger Schurig <holgerschurig@nikocity.de> for writing
- this script!) It will make sure Bugzilla files and directories
- have reasonable permissions, set up the
- data directory, and create all the MySQL
- tables.
-
-
- bash#
- ./checksetup.pl
-
- The first time you run it, it will create a
- file called localconfig.
-
+ The Chart module provides Bugzilla with on-the-fly charting
+ abilities. It can be installed in the usual fashion after it has been
+ fetched from CPAN where it is found as the Chart-x.x... tarball, linked
+ in
+ .
+ Note that earlier versions that 0.99c used GIFs, which are no longer
+ supported by the latest versions of GD.
-
+
+
- Tweaking <filename>localconfig</filename>
-
- This file contains a variety of settings you may need to tweak including
- how Bugzilla should connect to the MySQL database.
-
-
- The connection settings include:
-
-
-
- server's host: just use localhost if the
- MySQL server is local
-
-
-
-
- database name: bugs if you're following
- these directions
-
-
-
-
- MySQL username: bugs if you're following
- these directions
-
-
-
-
- Password for the bugs MySQL account above
-
-
-
-
-
- You should also install .htaccess files that the Apache
- webserver will use to restrict access to Bugzilla data files.
- See .
-
-
- Once you are happy with the settings, re-run
- checksetup.pl. On this second run, it will
- create the database and an administrator account for which
- you will be prompted to provide information.
-
-
- When logged into an administrator account once Bugzilla is
- running, if you go to the query page (off of the Bugzilla main
- menu), you'll find an edit parameters option
- that is filled with editable treats.
+ HTTP Server
+
+ You have a freedom of choice here - Apache, Netscape or any other
+ server on UNIX would do. You can run the web server on a
+ different machine than MySQL, but need to adjust the MySQL
+ bugs
+ user permissions accordingly.
+
+ We strongly recommend Apache as the web server to use. The
+ Bugzilla Guide installation instructions, in general, assume you are
+ using Apache. If you have got Bugzilla working using another webserver,
+ please share your experiences with us.
+
-
- Should everything work, you will have a nearly empty Bugzilla
- database and a newly-created localconfig
- file in your Bugzilla root directory.
+
+ You'll want to make sure that your web server will run any file
+ with the .cgi extension as a CGI and not just display it. If you're
+ using Apache that means uncommenting the following line in the srm.conf
+ file:
+ AddHandler cgi-script .cgi
-
-
-
- The second time you run checksetup.pl, you should become
- the user your web server runs as, and that you ensure that
- you set the webservergroup parameter in localconfig to
- match the web server's group name, if any. I believe,
- for the next release of Bugzilla, this will be fixed so
- that Bugzilla supports a webserveruser parameter in
- localconfig as well.
-
- Running checksetup.pl as the web user
-
- Assuming your web server runs as user "apache", and
- Bugzilla is installed in "/usr/local/bugzilla", here's
- one way to run checksetup.pl as the web server user.
- As root, for the second run of
- checksetup.pl, do this:
-
-bash# chown -R apache:apache /usr/local/bugzilla
-bash# su - apache
-bash# cd /usr/local/bugzilla
-bash# ./checksetup.pl
-
-
-
-
-
+
+ With Apache you'll also want to make sure that within the
+ access.conf file the line:
+ Options ExecCGI AllowOverride Limit
+
+ is in the stanza that covers the directories into which you intend to
+ put the bugzilla .html and .cgi files.
+
+
+ AllowOverride Limit allows the use of a Deny statement in the
+ .htaccess file generated by checksetup.pl
+
+ Users of newer versions of Apache will generally find both of
+ the above lines will be in the httpd.conf file, rather than srm.conf
+ or access.conf.
+
-
-
- The checksetup.pl script is designed so that you can run
- it at any time without causing harm. You should run it
- after any upgrade to Bugzilla.
-
-
+
+
+ There are important files and directories that should not be a
+ served by the HTTP server - most files in the
+ data
+ and
+ shadow
+ directories and the
+ localconfig
+ file. You should configure your HTTP server to not serve
+ these files. Failure to do so will expose critical passwords and
+ other data. Please see
+
+ for details on how to do this for Apache; the checksetup.pl
+ script should create appropriate .htaccess files for you.
+
-
+
- Setting Up Maintainers Manually (Optional)
-
- If you want to add someone else to every group by hand, you
- can do it by typing the appropriate MySQL commands. Run
- mysql -u root -p bugs You
- may need different parameters, depending on your security
- settings. Then:
-
-
- mysql>update
- profiles set groupset=0x7fffffffffffffff where
- login_name = 'XXX'; (yes, that's fifteenf's.
-
- replacing XXX with the Bugzilla email address.
-
-
+ Bugzilla
+
+ You should untar the Bugzilla files into a directory that you're
+ willing to make writable by the default web server user (probably
+ nobody).
+ You may decide to put the files in the main web space for your
+ web server or perhaps in
+ /usr/local
+ with a symbolic link in the web space that points to the Bugzilla
+ directory.
-
- The Whining Cron (Optional)
-
- By now you have a fully functional bugzilla, but what good
- are bugs if they're not annoying? To help make those bugs
- more annoying you can set up bugzilla's automatic whining
- system. This can be done by adding the following command as a
- daily crontab entry (for help on that see that crontab man
- page):
-
-
- cd
- <your-bugzilla-directory> ;
- ./whineatnews.pl
-
-
-
-
- Depending on your system, crontab may have several manpages.
- The following command should lead you to the most useful
- page for this purpose:
-
- man 5 crontab
-
-
+ If you symlink the bugzilla directory into your Apache's HTML
+ heirarchy, you may receive
+ Forbidden
+ errors unless you add the
+ FollowSymLinks
+ directive to the <Directory> entry for the HTML root
+ in httpd.conf.
-
-
-
- Bug Graphs (Optional)
-
- As long as you installed the GD and Graph::Base Perl modules
- you might as well turn on the nifty bugzilla bug reporting
- graphs.
-
-
- Add a cron entry like this to run collectstats daily at 5
- after midnight:
-
-
- bash#crontab
- -e
-
-
- 5 0 * * * cd
- <your-bugzilla-directory> ; ./collectstats.pl
-
-
-
-
-
- After two days have passed you'll be able to view bug graphs
- from the Bug Reports page.
+
+ Once all the files are in a web accessible directory, make that
+ directory writable by your webserver's user. This is a temporary step
+ until you run the post-install
+ checksetup.pl
+ script, which locks down your installation.
+
+ Lastly, you'll need to set up a symbolic link to
+ /usr/bonsaitools/bin/perl
+ for the correct location of your Perl executable (probably
+ /usr/bin/perl).
+ Otherwise you must hack all the .cgi files to change where they look
+ for Perl. This can be done using
+ ,
+ found in
+ , or the below one-liner.
+ I suggest using the symlink approach for future release
+ compatibility.
+
+
+ Changing the path to Perl
+ You can simply run this Perl one-liner to change
+ your path to perl in all the files in your Bugzilla installation:
+ perl -pi -e
+ 's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm
+ processmail syncshadowdb
+
+ Change /usr/bin/perl to match the location
+ of Perl on your machine.
+
-
+
- Securing MySQL
-
- If you followed the installation instructions for setting up
- your "bugs" and "root" user in MySQL, much of this should not
- apply to you. If you are upgrading an existing installation
- of Bugzilla, you should pay close attention to this section.
-
-
- Most MySQL installs have "interesting" default security parameters:
-
- mysqld defaults to running as root
- it defaults to allowing external network connections
- it has a known port number, and is easy to detect
- it defaults to no passwords whatsoever
- it defaults to allowing "File_Priv"
-
-
-
- This means anyone from anywhere on the internet can not only
- drop the database with one SQL command, and they can write as
- root to the system.
-
-
- To see your permissions do:
-
-
-
- bash#
- mysql -u root -p
-
-
-
-
- mysql>
- use mysql;
-
-
-
-
- mysql>
- show tables;
-
-
-
-
- mysql>
- select * from user;
-
-
-
-
- mysql>
- select * from db;
-
-
-
-
-
- To fix the gaping holes:
-
- DELETE FROM user WHERE User='';
- UPDATE user SET Password=PASSWORD('new_password') WHERE user='root';
- FLUSH PRIVILEGES;
-
-
-
- If you're not running "mit-pthreads" you can use:
-
- GRANT USAGE ON *.* TO bugs@localhost;
- GRANT ALL ON bugs.* TO bugs@localhost;
- REVOKE DROP ON bugs.* FROM bugs@localhost;
- FLUSH PRIVILEGES;
-
-
-
- With "mit-pthreads" you'll need to modify the "globals.pl" Mysql->Connect
- line to specify a specific host name instead of "localhost", and accept
- external connections:
-
- GRANT USAGE ON *.* TO bugs@bounce.hop.com;
- GRANT ALL ON bugs.* TO bugs@bounce.hop.com;
- REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com;
- FLUSH PRIVILEGES;
-
+ Setting Up the MySQL Database
+
+ After you've gotten all the software installed and working you're
+ ready to start preparing the database for its life as the back end to
+ a high quality bug tracker.
+
+ First, you'll want to fix MySQL permissions to allow access from
+ Bugzilla. For the purpose of this Installation section, the Bugzilla
+ username will be
+ bugs, and will have minimal permissions.
-
- Use .htaccess files with the Apache webserver to secure your
- bugzilla install. See
-
-
- Consider also:
-
-
-
- Turning off external networking with "--skip-networking",
- unless you have "mit-pthreads", in which case you can't.
- Without networking, MySQL connects with a Unix domain socket.
-
-
-
-
- using the --user= option to mysqld to run it as an unprivileged
- user.
-
-
-
-
- starting MySQL in a chroot jail
-
-
-
-
- running the httpd in a "chrooted" jail
-
-
-
-
- making sure the MySQL passwords are different from the OS
- passwords (MySQL "root" has nothing to do with system "root").
-
-
-
-
- running MySQL on a separate untrusted machine
-
-
-
-
- making backups ;-)
-
-
-
+
+ Begin by giving the MySQL root user a password. MySQL passwords are limited
+ to 16 characters.
+
+
+
+ bash#
+
+ mysql -u root mysql
+
+
+
+
+
+ mysql>
+
+ UPDATE user SET Password=PASSWORD('<new_password'>)
+ WHERE user='root';
+
+
+
+
+
+ mysql>
+
+ FLUSH PRIVILEGES;
+
+
+
+
+ From this point on, if you need to access MySQL as the MySQL root user,
+ you will need to use
+ mysql -u root -p
+
+ and enter <new_password>. Remember that MySQL user names have
+ nothing to do with Unix user names (login names).
+
+ Next, we create the
+ bugs
+
+ user, and grant sufficient permissions for checksetup.pl, which we'll
+ use later, to work its magic. This also restricts the
+ bugs
+ user to operations within a database called
+ bugs, and only allows the account to connect from
+ localhost.
+ Modify it to reflect your setup if you will be connecting from
+ another machine or as a different user.
+
+ Remember to set <bugs_password> to some unique password.
+
+
+
+ mysql>
+
+ GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,
+ ALTER,CREATE,DROP,REFERENCES ON bugs.* TO bugs@localhost
+ IDENTIFIED BY '<bugs_password>';
+
+
+
+
+
+ mysql>
+
+ FLUSH PRIVILEGES;
+
+
+
-
-
- Mac OS X Installation Notes
-
- There are a lot of common libraries and utilities out there
- that Apple did not include with Mac OS X, but which run
- perfectly well on it. The GD library, which Bugzilla needs to
- do bug graphs, is one of these.
-
-
- The easiest way to get a lot of these is with a program called
- Fink, which is similar in nature to the CPAN installer, but
- installs common GNU utilities. Fink is available from
- <http://sourceforge.net/projects/fink/>.
-
-
- Follow the instructions for setting up Fink. Once it's
- installed, you'll want to run the following as root:
- fink install gd
-
-
- It will prompt you for a number of dependencies, type 'y' and
- hit enter to install all of the dependencies. Then watch it
- work.
-
-
- To prevent creating conflicts with the software that Apple
- installs by default, Fink creates its own directory tree at
- /sw where it installs most of the software that it installs.
- This means your libraries and headers for libgd will be at
- /sw/lib and /sw/include instead of /usr/lib and
- /usr/local/include. Because of these changed locations for
- the libraries, the Perl GD module will not install directly
- via CPAN (it looks for the specific paths instead of getting
- them from your environment). But there's a way around that
- :-)
-
-
- Instead of typing install GD at the
- cpan> prompt, type look
- GD. This should go through the motions of
- downloading the latest version of the GD module, then it will
- open a shell and drop you into the build directory. Apply the
- following patch to the Makefile.PL file (save the patch into a
- file and use the command patch <
- patchfile:
-
-
-
- PATHS: CHECK AND ADJUST <=====
--my @INC = qw(-I/usr/local/include -I/usr/local/include/gd);
--my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/usr/local/lib );
-+my @INC = qw(-I/sw/include -I/sw/include/gd -I/usr/local/include -I/usr/local/include/gd);
-+my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/sw/lib -L/usr/local/lib);
- my @LIBS = qw(-lgd -lpng -lz);
-
- # FEATURE FLAGS
-@@ -23,7 +23,7 @@
-
- push @LIBS,'-lttf' if $TTF;
- push @LIBS,'-ljpeg' if $JPEG;
--push @LIBS, '-lm' unless $^O eq 'MSWin32';
-+push @LIBS, '-lm' unless ($^O =~ /^MSWin32|darwin$/);
-
- # FreeBSD 3.3 with libgd built from ports croaks if -lXpm is specified
- if ($^O ne 'freebsd' && $^O ne 'MSWin32') {
-
-]]>
-
-
-
- Then, run these commands to finish the installation of the perl module:
+
+
+
+ <filename>checksetup.pl</filename>
+
+
+ Next, run the magic checksetup.pl script. (Many thanks to
+ Holger Schurig
+ for writing this script!)
+ This script is designed to make sure your MySQL database and other
+ configuration options are consistent with the Bugzilla CGI files.
+ It will make sure Bugzilla files and directories have reasonable
+ permissions, set up the
+ data
+ directory, and create all the MySQL tables.
- perl Makefile.PL
- make
- make test
- make install
- And don't forget to run exit to get back to cpan.
+
+
+ bash#
+
+ ./checksetup.pl
+
+
-
-
- Happy Hacking!
-
-
-
-
- BSD Installation Notes
-
- For instructions on how to set up Bugzilla on FreeBSD, NetBSD, OpenBSD, BSDi, etc. please
- consult .
-
-
-
-
-
- Installation General Notes
+
+ The first time you run it, it will create a file called
+ localconfig.
+
+ This file contains a variety of settings you may need to tweak
+ including how Bugzilla should connect to the MySQL database.
+
+ The connection settings include:
+
+
+ server's host: just use
+ localhost
+
+ if the MySQL server is local
+
+
+
+ database name:
+ bugs
+
+ if you're following these directions
+
+
+
+ MySQL username:
+ bugs
+
+ if you're following these directions
+
+
+
+ Password for the
+ bugs
+
+ MySQL account (<bugs_password>) above
+
+
+
+
+ Once you are happy with the settings,
+ su to the user
+ your web server runs as, and re-run
+ checksetup.pl.
+ On this second run, it will create the database and an administrator
+ account for which you will be prompted to provide information.
+
+
+ The checksetup.pl script is designed so that you can run it at
+ any time without causing harm. You should run it after any upgrade to
+ Bugzilla.
+
+
+
- Modifying Your Running System
-
- Bugzilla optimizes database lookups by storing all relatively static
- information in the versioncache file, located in the data/ subdirectory
- under your installation directory.
+ Securing MySQL
+
+ If you followed the installation instructions for setting up your
+ "bugs" and "root" user in MySQL, much of this should not apply to you.
+ If you are upgrading an existing installation of Bugzilla, you should
+ pay close attention to this section.
+
+ Most MySQL installs have "interesting" default security
+ parameters:
+
+ mysqld defaults to running as root
+
+ it defaults to allowing external network connections
+
+ it has a known port number, and is easy to detect
+
+ it defaults to no passwords whatsoever
+
+ it defaults to allowing "File_Priv"
+
-
- If you make a change to the structural data in your database
- (the versions table for example), or to the
- constants encoded in defparams.pl, you will
- need to remove the cached content from the data directory
- (by doing a rm data/versioncache), or your
- changes won't show up.
+
+ This means anyone from anywhere on the internet can not only drop
+ the database with one SQL command, and they can write as root to the
+ system.
+
+ To see your permissions do:
+
+
+
+ bash#
+
+ mysql -u root -p
+
+
+
+
+
+ mysql>
+
+ use mysql;
+
+
+
+
+
+ mysql>
+
+ show tables;
+
+
+
+
+
+ mysql>
+
+ select * from user;
+
+
+
+
+
+ mysql>
+
+ select * from db;
+
+
+
-
- That file gets automatically regenerated whenever it's more than an
- hour old, so Bugzilla will eventually notice your changes by itself, but
- generally you want it to notice right away, so that you can test things.
+
+ To fix the gaping holes:
+
+ DELETE FROM user WHERE User='';
+
+ UPDATE user SET Password=PASSWORD('new_password') WHERE
+ user='root';
+
+ FLUSH PRIVILEGES;
+
-
-
- Upgrading From Previous Versions
-
- A plain Bugzilla is fairly easy to upgrade from one version to a newer one.
- However, things get a bit more complicated if you've made changes to
- Bugzilla's code. In this case, you may have to re-make or reapply those
- changes.
- It is recommended that you take a backup of your database and your entire
- Bugzilla installation before attempting an upgrade. You can upgrade a 'clean'
- installation by untarring a new tarball over the old installation. If you
- are upgrading from 2.12 or later, you can type cvs -z3
- update, and resolve conflicts if there are any.
+
+ If you're not running "mit-pthreads" you can use:
+
+ GRANT USAGE ON *.* TO bugs@localhost;
+
+ GRANT ALL ON bugs.* TO bugs@localhost;
+
+ REVOKE DROP ON bugs.* FROM bugs@localhost;
+
+ FLUSH PRIVILEGES;
+
-
- Because the developers of Bugzilla are constantly adding new tables, columns
- and fields, you'll probably get SQL errors if you just update the code and
- attempt to use Bugzilla. Always run the checksetup.pl script whenever
- you upgrade your installation.
+
+ With "mit-pthreads" you'll need to modify the "globals.pl"
+ Mysql->Connect line to specify a specific host name instead of
+ "localhost", and accept external connections:
+
+ GRANT USAGE ON *.* TO bugs@bounce.hop.com;
+
+ GRANT ALL ON bugs.* TO bugs@bounce.hop.com;
+
+ REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com;
+
+ FLUSH PRIVILEGES;
+
-
- If you are running Bugzilla version 2.8 or lower, and wish to upgrade to
- the latest version, please consult the file, "UPGRADING-pre-2.8" in the
- Bugzilla root directory after untarring the archive.
+
+ Consider also:
+
+
+ Turning off external networking with "--skip-networking",
+ unless you have "mit-pthreads", in which case you can't. Without
+ networking, MySQL connects with a Unix domain socket.
+
+
+
+ using the --user= option to mysqld to run it as an
+ unprivileged user.
+
+
+
+ running MySQL in a chroot jail
+
+
+
+ running the httpd in a chroot jail
+
+
+
+ making sure the MySQL passwords are different from the OS
+ passwords (MySQL "root" has nothing to do with system
+ "root").
+
+
+
+ running MySQL on a separate untrusted machine
+
+
+
+ making backups ;-)
+
+
-
- <filename>.htaccess</filename> files and security
-
- To enhance the security of your Bugzilla installation,
- Bugzilla will generate
- .htaccess files
- which the Apache webserver can use to restrict access to
- the bugzilla data files. The checksetup script will
- generate the .htaccess files. These .htaccess files
- will not work with Apache 1.2.x - but this has security holes, so you
- shouldn't be using it anyway.
-
-
-
- If you are using an alternate provider of
- webdot services for graphing
- (as described when viewing
- editparams.cgi in your web
- browser), you will need to change the ip address in
- data/webdot/.htaccess to the ip
- address of the webdot server that you are using.
-
-
-
-
+
+ Optional Additional Configuration
+
+
+ The Whining Cron
+
+ By now you have a fully functional Bugzilla, but what good are
+ bugs if they're not annoying? To help make those bugs more annoying you
+ can set up Bugzilla's automatic whining system to complain at engineers
+ which leave their bugs in the NEW state without triaging them.
+
+
+ This can be done by
+ adding the following command as a daily crontab entry (for help on that
+ see that crontab man page):
+
+
+
+ cd <your-bugzilla-directory> ;
+ ./whineatnews.pl
+
+
+
+
+
+
+ Depending on your system, crontab may have several manpages.
+ The following command should lead you to the most useful page for
+ this purpose:
+ man 5 crontab
+
+
+
+
+
+ Bug Graphs
+
+ As long as you installed the GD and Graph::Base Perl modules you
+ might as well turn on the nifty Bugzilla bug reporting graphs.
+
+ Add a cron entry like this to run
+ collectstats.pl
+ daily at 5 after midnight:
+
+
+
+ bash#
+
+ crontab -e
+
+
+
+
+ 5 0 * * * cd <your-bugzilla-directory> ;
+ ./collectstats.pl
+
+
+
+
+ After two days have passed you'll be able to view bug graphs from
+ the Bug Reports page.
+
+
+
+
+
+ Win32 Installation Notes
+
+ This section covers installation on Microsoft Windows 95, 98, ME,
+ NT, and 2000. Bugzilla works fine on Win32 platforms, but please remember
+ that the Bugzilla team and the author of the Guide neither endorse nor
+ support installation on Microsoft Windows. Bugzilla installs and runs
+ best
+
+ and
+ easiest
+
+ on UNIX-like operating systems, and that is the way it will stay for the
+ foreseeable future. The Bugzilla team is considering supporting Win32 for
+ the 2.16 release and later.
+
+ The easiest way to install Bugzilla on Intel-archiecture machines
+ is to install some variant of GNU/Linux, then follow the UNIX
+ installation instructions in this Guide. If you have any influence in the
+ platform choice for running this system, please choose GNU/Linux instead
+ of Microsoft Windows.
+
+
+ Win32 Installation: Step-by-step
+
+
+ You should be familiar with, and cross-reference, the rest of
+ the
+
+
+ section while performing your Win32 installation.
+
+ Making Bugzilla work on Microsoft Windows is no picnic. Support
+ for Win32 has improved dramatically in the last few releases, but, if
+ you choose to proceed, you should be a
+ very
+
+ skilled Windows Systems Administrator with strong troubleshooting
+ abilities, a high tolerance for pain, and moderate perl skills.
+ Bugzilla on NT requires hacking source code and implementing some
+ advanced utilities. What follows is the recommended installation
+ procedure for Win32; additional suggestions are provided in
+
+
+ .
+
+
+
+
+ Install
+ Apache Web Server
+
+ for Windows, and copy the Bugzilla files somewhere Apache can serve
+ them. Please follow all the instructions referenced in
+
+
+ regarding your Apache configuration, particularly instructions
+ regarding the
+ AddHandler
+
+ parameter and
+ ExecCGI
+
+ .
+
+
+ You may also use Internet Information Server or Personal
+ Web Server for this purpose. However, setup is quite different.
+ If ActivePerl doesn't seem to handle your file associations
+ correctly (for .cgi and .pl files), please consult
+
+
+ .
+
+ If you are going to use IIS, if on Windows NT you must be
+ updated to at least Service Pack 4. Windows 2000 ships with a
+ sufficient version of IIS.
+
+
+
+
+ Install
+ ActivePerl
+
+ for Windows. Check
+
+ http://aspn.activestate.com/ASPN/Downloads/ActivePerl
+
+ for a current compiled binary.
+
+ Please also check the following links to fully understand the
+ status of ActivePerl on Win32:
+
+ Perl Porting
+
+ , and
+
+ Perl on Win32 FAQ
+
+
+
+
+ Use ppm from your perl\bin directory to install the following
+ packs: DBI, DBD-Mysql, TimeDate, Chart, Date-Calc, Date-Manip, GD,
+ AppConfig, and Template. You may need to extract them from .zip
+ format using Winzip or other unzip program first. Most of these
+ additional ppm modules can be downloaded from ActiveState, but
+ AppConfig and Template should be obtained from OpenInteract using
+ the
+ instructions on the Template Toolkit web site
+
+ .
+
+
+ You can find a list of modules at
+
+ http://www.activestate.com/PPMPackages/zips/5xx-builds-only/
+
+ or
+
+ http://www.activestate.com/PPMPackages/5.6plus
+
+
+
+ The syntax for ppm is:
+
+ C:>
+
+ ppm <modulename>
+
+
+
+
+ Installing ActivePerl ppd Modules on Microsoft
+ Windows
+
+
+ C:>
+
+ ppm
+
+
+
+
+ Watch your capitalization!
+
+
+ ActiveState's 5.6Plus directory also contains an AppConfig
+ ppm, so you might see the following error when trying to install
+ the version at OpenInteract:
+
+
+ Error installing package 'AppConfig': Read a PPD
+ for 'AppConfig', but it is not intended for this build of Perl
+ (MSWin32-x86-multi-thread)
+
+
+ If so, download both
+
+ the tarball
+
+ and
+
+ the ppd
+
+ directly from OpenInteract, then run ppm from within the same
+ directory to which you downloaded those files and install the
+ package by referencing the ppd file explicitly via in the install
+ command, f.e.:
+
+ Installing OpenInteract ppd Modules manually on Microsoft
+ Windows
+
+
+
+ install
+ C:\AppConfig.ppd
+
+
+
+
+
+
+
+
+ Install MySQL for NT.
+
+ You can download MySQL for Windows NT from
+ MySQL.com
+
+ . Some find it helpful to use the WinMySqlAdmin utility, included
+ with the download, to set up the database.
+
+
+
+
+
+ Setup MySQL
+
+
+
+
+
+ C:>
+
+ C:\mysql\bin\mysql -u root mysql
+
+
+
+
+
+
+
+ mysql>
+
+ DELETE FROM user WHERE Host='localhost' AND
+ User='';
+
+
+
+
+
+
+
+ mysql>
+
+ UPDATE user SET Password=PASSWORD ('new_password')
+ WHERE user='root';
+
+
+
+
+ new_password
+
+ , above, indicates whatever password you wish to use for your
+ root
+
+ user.
+
+
+
+
+
+ mysql>
+
+ GRANT SELECT, INSERT, UPDATE, DELETE, INDEX,
+ ALTER, CREATE, DROP, REFERENCES ON bugs.* to bugs@localhost
+ IDENTIFIED BY 'bugs_password';
+
+
+
+
+ bugs_password
+
+ , above, indicates whatever password you wish to use for your
+ bugs
+
+ user.
+
+
+
+
+
+ mysql>
+
+ FLUSH PRIVILEGES;
+
+
+
+
+
+
+
+ mysql>
+
+ create database bugs;
+
+
+
+
+
+
+
+ mysql>
+
+ exit;
+
+
+
+
+
+
+
+ C:>
+
+ C:\mysql\bin\mysqladmin -u root -p
+ reload
+
+
+
+
+
+
+
+ Edit
+ checksetup.pl
+
+ in your Bugzilla directory. Change this line:
+
+
+ my $webservergid =
+ getgrnam($my_webservergroup);
+
+
+ to
+
+
+ my $webservergid =
+ $my_webservergroup;
+
+ or the name of the group you wish to own the files explicitly:
+ my $webservergid =
+ 'Administrators'
+
+
+
+
+ Run
+ checksetup.pl
+
+ from the Bugzilla directory.
+
+
+
+ Edit
+ localconfig
+
+ to suit your requirements. Set
+ $db_pass
+
+ to your
+ bugs_password
+
+ from
+
+
+ , and
+ $webservergroup
+
+ to
+ 8
+
+ .
+
+
+ Not sure on the
+ 8
+
+ for
+ $webservergroup
+
+ above. If it's wrong, please send corrections.
+
+
+
+
+ Edit
+ defparams.pl
+
+ to suit your requirements. Particularly, set
+ DefParam("maintainer")
+
+ and
+ DefParam("urlbase") to match your install.
+
+
+
+ This is yet another step I'm not sure of, since the
+ maintainer of this documentation does not maintain Bugzilla on
+ NT. If you can confirm or deny that this step is required, please
+ let me know.
+
+
+
+
+
+ There are several alternatives to Sendmail that will work
+ on Win32. The one mentioned here is a
+ suggestion
-
- The default .htaccess file may not provide adequate access
- restrictions, depending on your web server configuration.
- Be sure to check the <Directory> entries for your
- Bugzilla directory so that the .htaccess
- file is allowed to override web server defaults. For instance,
- let's assume your installation of Bugzilla is installed to
- /usr/local/bugzilla. You should have
- this <Directory> entry in your httpd.conf
- file:
-
+ , not a requirement. Some other mail packages that can work
+ include
+ BLAT
-
-
-
- Options +FollowSymLinks +Indexes +Includes +ExecCGI
- AllowOverride All
-
-]]>
-
-
+ ,
+ Windmail
-
- The important part above is AllowOverride All.
- Without that, the .htaccess file created by
- checksetup.pl will not have sufficient
- permissions to protect your Bugzilla installation.
-
+ ,
+ Mercury
+ Sendmail
-
- If you are using Internet Information Server or other web
- server which does not observe .htaccess
- conventions, you can disable their creation by editing
- localconfig and setting the
- $create_htaccess variable to
- 0.
-
-
+ , and the CPAN Net::SMTP Perl module (available in .ppm). Every
+ option requires some hacking of the Perl scripts for Bugzilla to
+ make it work. The option here simply requires the least.
+
-
- <filename>mod_throttle</filename> and Security
-
- It is possible for a user, by mistake or on purpose, to access
- the database many times in a row which can result in very slow
- access speeds for other users. If your Bugzilla installation
- is experiencing this problem , you may install the Apache
- module mod_throttle which can limit
- connections by ip-address. You may download this module at
- http://www.snert.com/Software/Throttle/. Follow the instructions to install into your Apache install. This module only functions with the Apache web server!. You may use the ThrottleClientIP command provided by this module to accomplish this goal. See the Module Instructions for more information.
-
-
-
- Preventing untrusted Bugzilla content from executing malicious Javascript code
- It is possible for a Bugzilla to execute malicious
- Javascript code. Due to internationalization concerns, we are
- unable to incorporate the code changes necessary to fulfill
- the CERT advisory requirements mentioned in http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3. Executing the following code snippet from a UNIX command shell will rectify the problem if your Bugzilla installation is intended for an English-speaking audience. As always, be sure your Bugzilla installation has a good backup before making changes, and I recommend you understand what the script is doing before executing it.
-
-bash# cd $BUGZILLA_HOME; for i in `ls *.cgi`; \
- do cat $i | sed 's/Content-type\: text\/html/Content-Type: text\/html\; charset=ISO-8859-1/' >$i.tmp; \
- mv $i.tmp $i; done
-
-
- All this one-liner command does is search for all instances of
- Content-type: text/html and replaces it with
- Content-Type: text/html; charset=ISO-8859-1.
- This specification prevents possible Javascript attacks on the
- browser, and is suggested for all English-speaking sites. For
- non-english-speaking Bugzilla sites, I suggest changing
- ISO-8859-1, above, to UTF-8.
-
-
+
+
+ Download NTsendmail, available from
+
+ www.ntsendmail.com
-
-
- UNIX Installation Instructions History
-
- This document was originally adapted from the Bonsai
- installation instructions by Terry Weissman
- <terry@mozilla.org>.
-
-
- The February 25, 1999 re-write of this page was done by Ry4an
- Brase <ry4an@ry4an.org>, with some edits by Terry
- Weissman, Bryce Nesbitt, Martin Pool, & Dan Mosedale (But
- don't send bug reports to them; report them using bugzilla, at http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla ).
-
-
- This document was heavily modified again Wednesday, March 07
- 2001 to reflect changes for Bugzilla 2.12 release by Matthew
- P. Barnson. The securing MySQL section should be changed to
- become standard procedure for Bugzilla installations.
-
-
- Finally, the README in its entirety was marked up in SGML and
- included into the Guide on April 24, 2001 by Matt Barnson.
- Since that time, it's undergone extensive modification as
- Bugzilla grew.
-
-
- Comments from people using this Guide for the first time are
- particularly welcome.
-
-
-
-
-
- Win32 Installation Notes
- This section covers installation on Microsoft Windows 95,
- 98, ME, NT, and 2000. Bugzilla works fine on Win32 platforms,
- but please remember that the Bugzilla team and the author of the
- Guide neither endorse nor support installation on Microsoft
- Windows. Bugzilla installs and runs best
- and easiest on UNIX-like operating systems,
- and that is the way it will stay for the foreseeable future. The
- Bugzilla team is considering supporting Win32 for the 2.16
- release and later.
- The easiest way to install Bugzilla on Intel-archiecture
- machines is to install some variant of GNU/Linux, then follow
- the UNIX installation instructions in this Guide. If you have
- any influence in the platform choice for running this system,
- please choose GNU/Linux instead of Microsoft Windows.
+ . You must have a "real" mail server which allows you to relay
+ off it in your $ENV{"NTsendmail"} (which you should probably
+ place in globals.pl)
+
-
- Win32 Installation: Step-by-step
-
-
- You should be familiar with, and cross-reference, the rest
- of the
- section while performing your
- Win32 installation.
-
- Making Bugzilla work on Microsoft Windows is no
- picnic. Support for Win32 has improved dramatically in the
- last few releases, but, if you choose to proceed, you should
- be a very skilled Windows Systems
- Administrator with strong troubleshooting abilities, a high
- tolerance for pain, and moderate perl skills. Bugzilla on NT
- requires hacking source code and implementing some advanced
- utilities. What follows is the recommended installation
- procedure for Win32; additional suggestions are provided in
- .
-
-
-
-
-
-
- Install Apache Web
- Server for Windows, and copy the Bugzilla files
- somewhere Apache can serve them. Please follow all the
- instructions referenced in
- regarding your Apache configuration, particularly
- instructions regarding the AddHandler
- parameter and ExecCGI.
-
-
-
- You may also use Internet Information Server or Personal
- Web Server for this purpose. However, setup is quite
- different. If ActivePerl doesn't seem to handle your
- file associations correctly (for .cgi and .pl files),
- please consult .
-
-
- If you are going to use IIS, if on Windows NT you must
- be updated to at least Service Pack 4. Windows 2000
- ships with a sufficient version of IIS.
-
-
-
-
-
- Install ActivePerl for Windows. Check http://aspn.activestate.com/ASPN/Downloads/ActivePerl for a current compiled binary.
-
-
- Please also check the following links to fully understand the status
- of ActivePerl on Win32:
-
- Perl Porting, and
-
- Perl on Win32 FAQ
-
-
-
-
- Use ppm from your perl\bin directory to install the following
- packs: DBI, DBD-Mysql, TimeDate, Chart, Date-Calc, Date-Manip,
- GD, AppConfig, and Template. You may need to extract them from
- .zip format using Winzip or other unzip program first. Most of
- these additional ppm modules can be downloaded from ActiveState,
- but AppConfig and Template should be obtained from OpenInteract
- using the instructions on
- the Template Toolkit web site.
-
-
-
- You can find a list of modules at
-
- http://www.activestate.com/PPMPackages/zips/5xx-builds-only/
- or http://www.activestate.com/PPMPackages/5.6plus
-
-
-
- The syntax for ppm is:
-
- C:> ppm <modulename>
-
-
-
-
- Installing ActivePerl ppd Modules on Microsoft Windows
- C:>ppm
-
- Watch your capitalization!
-
-
-
- ActiveState's 5.6Plus directory also contains an AppConfig ppm, so
- you might see the following error when trying to install the
- version at OpenInteract:
-
-
-
- Error installing package 'AppConfig': Read a PPD for
- 'AppConfig', but it is not intended for this build of Perl
- (MSWin32-x86-multi-thread)
-
-
-
- If so, download both the
- tarball and the
- ppd directly from OpenInteract, then run ppm from within
- the same directory to which you downloaded those files and
- install the package by referencing the ppd file explicitly via in
- the install command, f.e.:
-
- Installing OpenInteract ppd Modules manually on Microsoft
- Windows
-
- install
- C:\AppConfig.ppd
+
+ Put ntsendmail.pm into your .\perl\lib directory.
+
+
+
+ Add to globals.pl:
+
+ # these settings configure the NTsendmail
+ process use NTsendmail;
+ $ENV{"NTsendmail"}="your.smtpserver.box";
+ $ENV{"NTsendmail_debug"}=1;
+ $ENV{"NTsendmail_max_tries"}=5;
+
+
+ Some mention to also edit
+ $db_pass
+
+ in
+ globals.pl
+
+ to be your
+ bugs_password
+
+ . Although this may get you around some problem
+ authenticating to your database, since globals.pl is not
+ normally restricted by
+ .htaccess
+
+ , your database password is exposed to whoever uses your web
+ server.
+
+
+
+
+ Find and comment out all occurences of
+
+ open(SENDMAIL
+
+
+ in your Bugzilla directory. Then replace them with:
+ # new sendmail functionality my $mail=new
+ NTsendmail; my $from="bugzilla\@your.machine.name.tld"; my
+ $to=$login; my $subject=$urlbase;
+ $mail->send($from,$to,$subject,$msg);
-
-
-
-
-
-
- Install MySQL for NT.
-
-
- You can download MySQL for Windows NT from MySQL.com. Some find it helpful to use the WinMySqlAdmin utility, included with the download, to set up the database.
-
-
-
-
-
-
- Setup MySQL
-
-
-
-
-
- C:>
- C:\mysql\bin\mysql -u root mysql
-
-
-
-
-
-
- mysql>
- DELETE FROM user WHERE Host='localhost' AND User='';
-
-
-
-
-
-
- mysql>
- UPDATE user SET Password=PASSWORD ('new_password')
- WHERE user='root';
-
-
- new_password, above, indicates
- whatever password you wish to use for your
- root user.
-
-
-
-
- mysql>
- GRANT SELECT, INSERT, UPDATE, DELETE,
- INDEX, ALTER, CREATE, DROP, REFERENCES
- ON bugs.* to bugs@localhost
- IDENTIFIED BY 'bugs_password';
-
-
- bugs_password, above, indicates
- whatever password you wish to use for your
- bugs user.
-
-
-
-
- mysql>
- FLUSH PRIVILEGES;
-
-
-
-
-
-
- mysql>
- create database bugs;
-
-
-
-
-
-
- mysql>
- exit;
-
-
-
-
-
-
- C:>
- C:\mysql\bin\mysqladmin -u root -p reload
-
-
-
-
-
-
-
-
- Edit checksetup.pl in your Bugzilla directory. Change
- this line:
-
-
-
-my $webservergid = getgrnam($my_webservergroup);
-
-
-
- to
-
-
-
-my $webservergid = $my_webservergroup;
-
-or the name of the group you wish to own the files explicitly:
-
-my $webservergid = 'Administrators'
-
-
-
-
-
-
- Run checksetup.pl from the Bugzilla directory.
-
-
-
-
- Edit localconfig to suit your
- requirements. Set $db_pass to your
- bugs_password from , and $webservergroup to 8.
-
- Not sure on the 8 for
- $webservergroup above. If it's
- wrong, please send corrections.
-
-
-
-
-
- Edit defparams.pl to suit your
- requirements. Particularly, set
- DefParam("maintainer") and
- DefParam("urlbase") to match your
- install.
-
-
- This is yet another step I'm not sure of, since the
- maintainer of this documentation does not maintain
- Bugzilla on NT. If you can confirm or deny that this
- step is required, please let me know.
-
-
-
-
-
-
- There are several alternatives to Sendmail that will work on Win32.
- The one mentioned here is a suggestion, not
- a requirement. Some other mail packages that can work include
- BLAT,
- Windmail,
- Mercury Sendmail,
- and the CPAN Net::SMTP Perl module (available in .ppm).
- Every option requires some hacking of the Perl scripts for Bugzilla
- to make it work. The option here simply requires the least.
-
-
-
-
-
-
- Download NTsendmail, available from www.ntsendmail.com. You must have a "real" mail server which allows you to relay off it in your $ENV{"NTsendmail"} (which you should probably place in globals.pl)
-
-
-
-
- Put ntsendmail.pm into your .\perl\lib directory.
-
-
-
- Add to globals.pl:
-
-# these settings configure the NTsendmail process
-use NTsendmail;
-$ENV{"NTsendmail"}="your.smtpserver.box";
-$ENV{"NTsendmail_debug"}=1;
-$ENV{"NTsendmail_max_tries"}=5;
-
-
-
- Some mention to also edit
- $db_pass in
- globals.pl to be your
- bugs_password. Although this may get
- you around some problem authenticating to your
- database, since globals.pl is not normally
- restricted by .htaccess, your
- database password is exposed to whoever uses your
- web server.
-
-
-
-
-
-
- Find and comment out all occurences of
- open(SENDMAIL in
- your Bugzilla directory. Then replace them with:
-
-# new sendmail functionality
-my $mail=new NTsendmail;
-my $from="bugzilla\@your.machine.name.tld";
-my $to=$login;
-my $subject=$urlbase;
-$mail->send($from,$to,$subject,$msg);
-
-
-
-
- Some have found success using the commercial product,
- Windmail.
- You could try replacing your sendmail calls with:
-
-open SENDMAIL, "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t > mail.log";
-
- or something to that effect.
-
-
-
-
-
-
-
-
- Change all references in all files from
- processmail to
- processmail.pl, and
- rename processmail to
- processmail.pl.
-
-
-
- Many think this may be a change we want to make for
- main-tree Bugzilla. It's painless for the UNIX folks,
- and will make the Win32 people happier.
-
-
-
-
- Some people have suggested using the Net::SMTP Perl module instead of NTsendmail or the other options listed here. You can change processmail.pl to make this work.
-
+
+
+ Some have found success using the commercial product,
+ Windmail
+
+ . You could try replacing your sendmail calls with:
+ open SENDMAIL,
+ "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t >
+ mail.log";
+
+ or something to that effect.
+
+
+
+
+
+
+ Change all references in all files from
+ processmail
+
+ to
+ processmail.pl
+
+ , and rename
+ processmail
+
+ to
+ processmail.pl
+
+ .
+
+
+ Many think this may be a change we want to make for
+ main-tree Bugzilla. It's painless for the UNIX folks, and will
+ make the Win32 people happier.
+
+
+
+ Some people have suggested using the Net::SMTP Perl module
+ instead of NTsendmail or the other options listed here. You can
+ change processmail.pl to make this work.
+
new(''); #connect to SMTP server
@@ -1737,9 +1442,10 @@ $logstr = "$logstr; mail sent to $tolist $cclist";
}
]]>
-
-here is a test mail program for Net::SMTP:
-
+
+
+ here is a test mail program for Net::SMTP:
+
-
-
-
-
-
-
-
- This step is optional if you are using IIS or another
- web server which only decides on an interpreter based
- upon the file extension (.pl), rather than the
- shebang line (#/usr/bonsaitools/bin/perl)
-
-
-
- Modify the path to perl on the first line (#!) of all
- files to point to your Perl installation, and add
- perl to the beginning of all Perl system
- calls that use a perl script as an argument. This may
- take you a while. There is a setperl.csh
- utility to speed part of this procedure, available in the
- section of The Bugzilla Guide.
- However, it requires the Cygwin GNU-compatible environment
- for Win32 be set up in order to work. See http://www.cygwin.com/ for details on obtaining Cygwin.
-
-
-
-
-
- Modify the invocation of all system() calls in all perl
- scripts in your Bugzilla directory. You should specify the
- full path to perl for each system() call. For instance, change
- this line in processmail:
-
+
+
+
+
+
+
+ This step is optional if you are using IIS or another web
+ server which only decides on an interpreter based upon the file
+ extension (.pl), rather than the
+ shebang
+
+ line (#/usr/bonsaitools/bin/perl)
+
+
+ Modify the path to perl on the first line (#!) of all files
+ to point to your Perl installation, and add
+ perl
+
+ to the beginning of all Perl system calls that use a perl script as
+ an argument. This may take you a while. There is a
+ setperl.csh
+
+ utility to speed part of this procedure, available in the
+
+
+ section of The Bugzilla Guide. However, it requires the Cygwin
+ GNU-compatible environment for Win32 be set up in order to work.
+ See
+ http://www.cygwin.com/
+
+ for details on obtaining Cygwin.
+
+
+
+ Modify the invocation of all system() calls in all perl
+ scripts in your Bugzilla directory. You should specify the full
+ path to perl for each system() call. For instance, change this line
+ in processmail:
+
+ to
-
+ to
+
system ("C:\\perl\\bin\\perl", "processmail", @ARGLIST);
-]]>
-
-
-
-
- Add binmode() calls so attachments
- will work (bug 62000).
+]]>
+
+
+
+
+ Add
+ binmode()
+
+ calls so attachments will work (
+ bug
+ 62000
+
+ ).
+
+ Because Microsoft Windows based systems handle binary files
+ different than Unix based systems, you need to add the following
+ lines to
+ createattachment.cgi
+
+ and
+ showattachment.cgi
+
+ before the
+ require 'CGI.pl';
+
+ line.
+
- Because Microsoft Windows based systems handle binary
- files different than Unix based systems, you need to add
- the following lines to
- createattachment.cgi and
- showattachment.cgi before the
- require 'CGI.pl'; line.
-
-
-
+
-
+
+
-
- According to bug 62000,
- the perl documentation says that you should always use
- binmode() when dealing with binary
- files, but never when dealing with text files. That seems
- to suggest that rather than arbitrarily putting
- binmode() at the beginning of the
- attachment files, there should be logic to determine if
- binmode() is needed or not.
-
+ According to
+
+ bug 62000
+
+ , the perl documentation says that you should always use
+ binmode()
+
+ when dealing with binary files, but never when dealing with text
+ files. That seems to suggest that rather than arbitrarily putting
+
+ binmode()
+
+ at the beginning of the attachment files, there should be logic
+ to determine if
+ binmode()
+
+ is needed or not.
-
- If you are using IIS or Personal Web Server, you must add cgi
- relationships to Properties -> Home directory (tab) ->
- Application Settings (section) -> Configuration (button),
- such as:
-
-
-
-.cgi to: <perl install directory>\perl.exe %s %s
-.pl to: <perl install directory>\perl.exe %s %s
-GET,HEAD,POST
-
- Change the path to Perl to match your
- install, of course.
-
+ If you are using IIS or Personal Web Server, you must add cgi
+ relationships to Properties -> Home directory (tab) ->
+ Application Settings (section) -> Configuration (button), such
+ as:
+
+
+ .cgi to: <perl install directory>\perl.exe %s
+ %s .pl to: <perl install directory>\perl.exe %s %s
+ GET,HEAD,POST
+
+ Change the path to Perl to match your install, of course.Additional Windows Tips
+
-
- From Andrew Pearson:
-
-
- You can make Bugzilla work with Personal Web Server for
- Windows 98 and higher, as well as for IIS 4.0.
- Microsoft has information available at http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP
-
-
- Basically you need to add two String Keys in the
- registry at the following location:
-
-
-
-HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap
-
-
-
- The keys should be called ".pl" and ".cgi", and both
- should have a value something like:
- c:/perl/bin/perl.exe "%s" "%s"
-
-
- The KB article only talks about .pl, but it goes into
- more detail and provides a perl test script.
-
-
-
+ From Andrew Pearson:
+
+ You can make Bugzilla work with Personal Web Server for
+ Windows 98 and higher, as well as for IIS 4.0. Microsoft has
+ information available at
+
+ http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP
+
+
+ Basically you need to add two String Keys in the registry at
+ the following location:
+
+
+
+ HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap
+
+
+ The keys should be called ".pl" and ".cgi", and both should
+ have a value something like:
+ c:/perl/bin/perl.exe "%s" "%s"
+
+
+ The KB article only talks about .pl, but it goes into more
+ detail and provides a perl test script.
+
+
+
-
- If attempting to run Bugzilla 2.12 or older, you will need
- to remove encrypt() calls from the Perl source. This is
- not necessary for Bugzilla 2.13 and
- later, which includes the current release, Bugzilla
- &bz-ver;.
-
- Removing encrypt() for Windows NT Bugzilla version
- 2.12 or earlier
-
- Replace this:
-
-SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")");
-my $enteredcryptpwd = FetchOneColumn();
-
-with this:
-
-my $enteredcryptpwd = $enteredpwd
-
- in cgi.pl.
-
-
-
+ If attempting to run Bugzilla 2.12 or older, you will need to
+ remove encrypt() calls from the Perl source. This is
+ not necessary
+
+ for Bugzilla 2.13 and later, which includes the current release,
+ Bugzilla &bz-ver;.
+
+ Removing encrypt() for Windows NT Bugzilla version 2.12 or
+ earlier
+
+ Replace this:
+ SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) .
+ ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")"); my
+ $enteredcryptpwd = FetchOneColumn();
+
+ with this:
+ my $enteredcryptpwd = $enteredpwd
+
+ in cgi.pl.
+
+
-
+
Bugzilla LDAP Integration
+
+ What follows is some late-breaking information on using the LDAP
+ authentication options with Bugzilla. The author has not tested these
+ (nor even formatted this section!) so please contribute feedback to the
+ newsgroup.
+
+ Mozilla::LDAP module The Mozilla::LDAP module allows you
+ to use LDAP for authentication to the Bugzilla system. This module is
+ not required if you are not using LDAP. Mozilla::LDAP (aka PerLDAP) is
+ available for download from http://www.mozilla.org/directory. NOTE: The
+ Mozilla::LDAP module requires Netscape's Directory SDK. Follow the link
+ for "Directory SDK for C" on that same page to download the SDK first.
+ After you have installed this SDK, then install the PerLDAP module.
+ ----------------------------------------------------------------------
+ Post-Installation Checklist
+ ----------------------------------------------------------------------
+ Set useLDAP to "On" **only** if you will be using an LDAP directory for
+ authentication. Be very careful when setting up this parameter; if you
+ set LDAP authentication, but do not have a valid LDAP directory set up,
+ you will not be able to log back in to Bugzilla once you log out. (If
+ this happens, you can get back in by manually editing the data/params
+ file, and setting useLDAP back to 0.) If using LDAP, you must set the
+ three additional parameters: Set LDAPserver to the name (and optionally
+ port) of your LDAP server. If no port is specified, it defaults to the
+ default port of 389. (e.g "ldap.mycompany.com" or
+ "ldap.mycompany.com:1234") Set LDAPBaseDN to the base DN for searching
+ for users in your LDAP directory. (e.g. "ou=People,o=MyCompany") uids
+ must be unique under the DN specified here. Set LDAPmailattribute to
+ the name of the attribute in your LDAP directory which contains the
+ primary email address. On most directory servers available, this is
+ "mail", but you may need to change this.
+ ----------------------------------------------------------------------
+ (Not sure where this bit should go, but it's important that it be in
+ there somewhere...)
+ ----------------------------------------------------------------------
+ Using LDAP authentication for Bugzilla: The existing authentication
+ scheme for Bugzilla uses email addresses as the primary user ID, and a
+ password to authenticate that user. All places within Bugzilla where
+ you need to deal with user ID (e.g assigning a bug) use the email
+ address. The LDAP authentication builds on top of this scheme, rather
+ than replacing it. The initial log in is done with a username and
+ password for the LDAP directory. This then fetches the email address
+ from LDAP and authenticates seamlessly in the standard Bugzilla
+ authentication scheme using this email address. If an account for this
+ address already exists in your Bugzilla system, it will log in to that
+ account. If no account for that email address exists, one is created at
+ the time of login. (In this case, Bugzilla will attempt to use the
+ "displayName" or "cn" attribute to determine the user's full name.)
+ After authentication, all other user-related tasks are still handled by
+ email address, not LDAP username. You still assign bugs by email
+ address, query on users by email address, etc.
+ ----------------------------------------------------------------------
+
+
+
+
+ Mac OS X Installation Notes
+
+ There are a lot of common libraries and utilities out there that
+ Apple did not include with Mac OS X, but which run perfectly well on it.
+ The GD library, which Bugzilla needs to do bug graphs, is one of
+ these.
+
+ The easiest way to get a lot of these is with a program called
+ Fink, which is similar in nature to the CPAN installer, but installs
+ common GNU utilities. Fink is available from
+ <http://sourceforge.net/projects/fink/>.
+
+ Follow the instructions for setting up Fink. Once it's installed,
+ you'll want to run the following as root:
+ fink install gd
+
+
+ It will prompt you for a number of dependencies, type 'y' and hit
+ enter to install all of the dependencies. Then watch it work.
+
+ To prevent creating conflicts with the software that Apple installs
+ by default, Fink creates its own directory tree at /sw where it installs
+ most of the software that it installs. This means your libraries and
+ headers for libgd will be at /sw/lib and /sw/include instead of /usr/lib
+ and /usr/local/include. Because of these changed locations for the
+ libraries, the Perl GD module will not install directly via CPAN (it
+ looks for the specific paths instead of getting them from your
+ environment). But there's a way around that :-)
+
+ Instead of typing
+ install GD
+ at the
+ cpan>
+ prompt, type
+ look GD.
+ This should go through the motions of downloading the latest version of
+ the GD module, then it will open a shell and drop you into the build
+ directory. Apply this patch
+ to the Makefile.PL file (save the
+ patch into a file and use the command
+ patch < patchfile.
+
+
+ Then, run these commands to finish the installation of the GD
+ module:
+
+
+ perl Makefile.PL
+
+
+
+ make
+
+
+
+ make test
+
+
+
+ make install
+
+
+ And don't forget to run
+ exit
+
+ to get back to cpan.
+
+
+
+
+
+
+ General Installation Notes
+
+
+ Modifying Your Running System
+
+ Bugzilla optimizes database lookups by storing all relatively
+ static information in the versioncache file, located in the data/
+ subdirectory under your installation directory.
+
+ If you make a change to the structural data in your database (the
+ versions table for example), or to the
+ constants
+
+ encoded in defparams.pl, you will need to remove the cached content
+ from the data directory (by doing a
+ rm data/versioncache
+
+ ), or your changes won't show up.
+
+ That file gets automatically regenerated whenever it's more than
+ an hour old, so Bugzilla will eventually notice your changes by itself,
+ but generally you want it to notice right away, so that you can test
+ things.
+
+
+
+ Upgrading From Previous Versions
+
+ A plain Bugzilla is fairly easy to upgrade from one version to a
+ newer one. However, things get a bit more complicated if you've made
+ changes to Bugzilla's code. In this case, you may have to re-make or
+ reapply those changes. It is recommended that you take a backup of your
+ database and your entire Bugzilla installation before attempting an
+ upgrade. You can upgrade a 'clean' installation by untarring a new
+ tarball over the old installation. If you are upgrading from 2.12 or
+ later, you can type
+ cvs -z3 update
+
+ , and resolve conflicts if there are any.
+
+ Because the developers of Bugzilla are constantly adding new
+ tables, columns and fields, you'll probably get SQL errors if you just
+ update the code and attempt to use Bugzilla. Always run the
+ checksetup.pl script whenever you upgrade your installation.
+
+ If you are running Bugzilla version 2.8 or lower, and wish to
+ upgrade to the latest version, please consult the file,
+ "UPGRADING-pre-2.8" in the Bugzilla root directory after untarring the
+ archive.
+
+
+
+
+ <filename>.htaccess</filename>
+
+ files and security
+
+ To enhance the security of your Bugzilla installation, Bugzilla
+ will generate
+
+ .htaccess
+
+
+ files which the Apache webserver can use to restrict access to the
+ bugzilla data files. The checksetup script will generate the
+ .htaccess
+
+ files. These .htaccess files will not work with Apache 1.2.x - but this
+ has security holes, so you shouldn't be using it anyway.
+
+ If you are using an alternate provider of
+ webdot
+
+ services for graphing (as described when viewing
+ editparams.cgi
+
+ in your web browser), you will need to change the ip address in
+ data/webdot/.htaccess
+
+ to the ip address of the webdot server that you are using.
+
+
+
+ The default .htaccess file may not provide adequate access
+ restrictions, depending on your web server configuration. Be sure to
+ check the <Directory> entries for your Bugzilla directory so that
+ the
+ .htaccess
+
+ file is allowed to override web server defaults. For instance, let's
+ assume your installation of Bugzilla is installed to
+ /usr/local/bugzilla
+
+ . You should have this <Directory> entry in your
+ httpd.conf
+
+ file:
+
+
+
+
+ Options +FollowSymLinks +Indexes +Includes +ExecCGI
+ AllowOverride All
+
+]]>
+
+
+
+ The important part above is
+ AllowOverride All
+
+ . Without that, the
+ .htaccess
+
+ file created by
+ checksetup.pl
+
+ will not have sufficient permissions to protect your Bugzilla
+ installation.
+
+ If you are using Internet Information Server or other web server
+ which does not observe
+ .htaccess
+
+ conventions, you can disable their creation by editing
+ localconfig
+
+ and setting the
+ $create_htaccess
+
+ variable to
+ 0
+
+ .
+
+
+
+
+ <filename>mod_throttle</filename>
+
+ and Security
+
+ It is possible for a user, by mistake or on purpose, to access
+ the database many times in a row which can result in very slow access
+ speeds for other users. If your Bugzilla installation is experiencing
+ this problem , you may install the Apache module
+ mod_throttle
+
+ which can limit connections by ip-address. You may download this module
+ at
+
+ http://www.snert.com/Software/Throttle/
+
+ . Follow the instructions to install into your Apache install.
+ This module only functions with the Apache web
+ server!
+
+ . You may use the
+ ThrottleClientIP
+
+ command provided by this module to accomplish this goal. See the
+ Module
+ Instructions
+
+ for more information.
+
+
+
+
+ Preventing untrusted Bugzilla content from executing malicious
+ Javascript code
+
+ It is possible for a Bugzilla to execute malicious Javascript
+ code. Due to internationalization concerns, we are unable to
+ incorporate the code changes necessary to fulfill the CERT advisory
+ requirements mentioned in
+
+ http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3.
+ Executing the following code snippet from a UNIX command shell will
+ rectify the problem if your Bugzilla installation is intended for an
+ English-speaking audience. As always, be sure your Bugzilla
+ installation has a good backup before making changes, and I recommend
+ you understand what the script is doing before executing it.
+
+
+ bash# cd <your_bugzilla_dir>;
+ for i in `ls *.cgi`; \ do
+ cat $i | sed 's/Content-type\: text\/html/Content-Type: text\/html\;
+ charset=ISO-8859-1/' >$i.tmp; \ mv $i.tmp $i;
+ done
+
+
+ All this one-liner command does is search for all instances of
+ Content-type: text/html
+
+ and replaces it with
+ Content-Type: text/html; charset=ISO-8859-1
+
+ . This specification prevents possible Javascript attacks on the
+ browser, and is suggested for all English-speaking sites. For
+ non-English-speaking Bugzilla sites, I suggest changing
+ ISO-8859-1, above, to
+ UTF-8.
+
+
+
+ cannot chdir(/var/spool/mqueue)
+
+ If you are installing Bugzilla on SuSE Linux, or some other
+ distributions with
+ paranoid
+ security options, it is possible that the checksetup.pl script may fail
+ with the error:
+ cannot chdir(/var/spool/mqueue): Permission
+ denied.
+
+
- What follows is some late-breaking information on using the
- LDAP authentication options with Bugzilla. The author has not
- tested these (nor even formatted this section!) so please
- contribute feedback to the newsgroup.
+ This is because your
+ /var/spool/mqueue
+ directory has a mode of
+ drwx------. Type
+ chmod 755
+ /var/spool/mqueue
+
+ as root to fix this problem.
-
-Mozilla::LDAP module
-
-The Mozilla::LDAP module allows you to use LDAP for authentication to
-the Bugzilla system. This module is not required if you are not using
-LDAP.
-
-Mozilla::LDAP (aka PerLDAP) is available for download from
-http://www.mozilla.org/directory.
-
-NOTE: The Mozilla::LDAP module requires Netscape's Directory SDK.
-Follow the link for "Directory SDK for C" on that same page to
-download the SDK first. After you have installed this SDK, then
-install the PerLDAP module.
-----------------------------------------------------------------------
-
-Post-Installation Checklist
-----------------------------------------------------------------------
-Set useLDAP to "On" **only** if you will be using an LDAP directory
-for authentication. Be very careful when setting up this parameter;
-if you set LDAP authentication, but do not have a valid LDAP directory
-set up, you will not be able to log back in to Bugzilla once you log
-out. (If this happens, you can get back in by manually editing the
-data/params file, and setting useLDAP back to 0.)
-
-If using LDAP, you must set the three additional parameters:
-
-Set LDAPserver to the name (and optionally port) of your LDAP server.
-If no port is specified, it defaults to the default port of 389. (e.g
-"ldap.mycompany.com" or "ldap.mycompany.com:1234")
-
-Set LDAPBaseDN to the base DN for searching for users in your LDAP
-directory. (e.g. "ou=People,o=MyCompany") uids must be unique under
-the DN specified here.
-
-Set LDAPmailattribute to the name of the attribute in your LDAP
-directory which contains the primary email address. On most directory
-servers available, this is "mail", but you may need to change this.
-----------------------------------------------------------------------
-
-(Not sure where this bit should go, but it's important that it be in
-there somewhere...)
-----------------------------------------------------------------------
-Using LDAP authentication for Bugzilla:
-
-The existing authentication scheme for Bugzilla uses email addresses
-as the primary user ID, and a password to authenticate that user. All
-places within Bugzilla where you need to deal with user ID (e.g
-assigning a bug) use the email address.
-
-The LDAP authentication builds on top of this scheme, rather than
-replacing it. The initial log in is done with a username and password
-for the LDAP directory. This then fetches the email address from LDAP
-and authenticates seamlessly in the standard Bugzilla authentication
-scheme using this email address. If an account for this address
-already exists in your Bugzilla system, it will log in to that
-account. If no account for that email address exists, one is created
-at the time of login. (In this case, Bugzilla will attempt to use the
-"displayName" or "cn" attribute to determine the user's full name.)
-
-After authentication, all other user-related tasks are still handled
-by email address, not LDAP username. You still assign bugs by email
-address, query on users by email address, etc.
-----------------------------------------------------------------------
-
-
+
diff --git a/docs/xml/using.xml b/docs/xml/using.xml
index b447ef9c00..dade59a08c 100644
--- a/docs/xml/using.xml
+++ b/docs/xml/using.xml
@@ -1,167 +1,15 @@
-
Using Bugzilla
-
- What is Bugzilla?
-
- Bugzilla is one example of a class of programs called "Defect
- Tracking Systems", or, more commonly, "Bug-Tracking Systems". Defect
- Tracking Systems allow individual or groups of developers to keep track
- of outstanding bugs in their product effectively. Bugzilla was originally
- written by Terry Weissman in a programming language called "TCL", to
- replace a crappy bug-tracking database used internally by Netscape
- Communications. Terry later ported Bugzilla to Perl from TCL, and in Perl
- it remains to this day. Most commercial defect-tracking software vendors
- at the time charged enormous licensing fees, and Bugzilla quickly became
- a favorite of the open-source crowd (with its genesis in the open-source
- browser project, Mozilla). It is now the de-facto standard
- defect-tracking system against which all others are measured.
-
- Bugzilla has matured immensely, and now boasts many advanced
- features. These include:
-
-
- Powerful searching
-
-
-
- User-configurable email notifications of bug changes
-
-
-
- Full change history
-
-
-
- Inter-bug dependency tracking and graphing
-
-
-
- Excellent attachment management
-
-
-
- Integrated, product-based, granular security schema
-
-
-
- Fully security-audited, and runs under Perl's taint mode
-
-
-
- A robust, stable RDBMS back-end
-
-
-
- Web, XML, email and console interfaces
-
-
-
- Completely customisable and/or localisable web user
- interface
-
-
-
- Extensive configurability
-
-
-
- Smooth upgrade pathway between versions
-
-
-
-
-
-
- Why Should We Use Bugzilla?
-
- For many years, defect-tracking software has remained principally
- the domain of large software development houses. Even then, most shops
- never bothered with bug-tracking software, and instead simply relied on
- shared lists and email to monitor the status of defects. This procedure
- is error-prone and tends to cause those bugs judged least significant by
- developers to be dropped or ignored.
-
- These days, many companies are finding that integrated
- defect-tracking systems reduce downtime, increase productivity, and raise
- customer satisfaction with their systems. Along with full disclosure, an
- open bug-tracker allows manufacturers to keep in touch with their clients
- and resellers, to communicate about problems effectively throughout the
- data management chain. Many corporations have also discovered that
- defect-tracking helps reduce costs by providing IT support
- accountability, telephone support knowledge bases, and a common,
- well-understood system for accounting for unusual system or software
- issues.
-
- But why should
- you
-
- use Bugzilla?
-
- Bugzilla is very adaptable to various situations. Known uses
- currently include IT support queues, Systems Administration deployment
- management, chip design and development problem tracking (both
- pre-and-post fabrication), and software and hardware bug tracking for
- luminaries such as Redhat, Loki software, Linux-Mandrake, and VA Systems.
- Combined with systems such as CVS, Bonsai, or Perforce SCM, Bugzilla
- provides a powerful, easy-to-use solution to configuration management and
- replication problems
-
- Bugzilla can dramatically increase the productivity and
- accountability of individual employees by providing a documented workflow
- and positive feedback for good performance. How many times do you wake up
- in the morning, remembering that you were supposed to do
- something
-
- today, but you just can't quite remember? Put it in Bugzilla, and you
- have a record of it from which you can extrapolate milestones, predict
- product versions for integration, and by using Bugzilla's e-mail
- integration features be able to follow the discussion trail that led to
- critical decisions.
-
- Ultimately, Bugzilla puts the power in your hands to improve your
- value to your employer or business while providing a usable framework for
- your natural attention to detail and knowledge store to flourish.
-
-
How do I use Bugzilla?
- This section contains information for end-users of Bugzilla. If you
- are administering a Bugzilla installation, please consult the Installing
- and Administering Bugzilla portions of this Guide.
-
- There is a Bugzilla test installation, called
- Landfill
-
- , which you are welcome to play with. However, it does not necessarily
+ This section contains information for end-users of Bugzilla.
+ There is a Bugzilla test installation, called
+ Landfill,
+ which you are welcome to play with. However, it does not necessarily
have all Bugzilla features enabled, and often runs cutting-edge versions
of Bugzilla for testing, so some things may work slightly differently
than mentioned here.
@@ -200,13 +48,12 @@ Chapter: Using Bugzilla
Click the
Log In
-
link in the yellow area at the bottom of the page in your browser,
enter your email address and password into the spaces provided, and
click
- Login
-
- .
+ Login.
+
+
@@ -224,7 +71,7 @@ Chapter: Using Bugzilla
url="http://landfill.tequilarista.org/bugzilla-tip/show_bug.cgi?id=1">
Bug 1 on Landfill
- is a good example. Note that the names of most fields are hyperlinks;
+ is a good example. Note that the labels for most fields are hyperlinks;
clicking them will take you to context-sensitive help on that
particular field.
@@ -240,56 +87,46 @@ Chapter: Using Bugzilla
Administration:
-
Administration of a Bugzilla installation.Bugzilla-General:
-
Anything that doesn't fit in the other components, or spans
multiple components.Creating/Changing Bugs:
-
Creating, changing, and viewing bugs.Documentation:
-
The Bugzilla documentation, including The Bugzilla Guide.Email:
-
Anything to do with email sent by Bugzilla.Installation:
-
The installation process of Bugzilla.Query/Buglist:
-
Anything to do with searching for bugs and viewing the
buglists.Reporting/Charting:
-
Getting reports from Bugzilla.User Accounts:
-
Anything about managing a user account from the user's perspective.
Saved queries, creating accounts, changing passwords, logging in,
etc.User Interface:
-
General issues having to do with the user interface cosmetics (not
functionality) including cosmetic issues, HTML templates,
etc.
@@ -301,38 +138,34 @@ Chapter: Using Bugzilla
Status and Resolution:
- A bug passes through several Statuses in its lifetime, and ends up
- in the RESOLVED status, with one of a set of Resolutions (e.g.
- FIXED, INVALID.) The different possible values for Status and
- Resolution on your installation will be documented in the
+ These define exactly what state the bug is in - from not even
+ being confirmed as a bug, through to being fixed and the fix
+ confirmed by Quality Assurance. The different possible values for
+ Status and Resolution on your installation should be documented in the
context-sensitive help for those items.Assigned To:
-
The person responsible for fixing the bug.URL:
-
A URL associated with the bug, if any.Summary:
-
A one-sentence summary of the problem.Status Whiteboard:
-
(a.k.a. Whiteboard) A free-form text area for adding short notes
and tags to a bug.
@@ -340,7 +173,6 @@ Chapter: Using Bugzilla
Keywords:
-
The administrator can define keywords which you can use to tag and
categorise bugs - e.g. The Mozilla Project has keywords like crash
and regression.
@@ -349,7 +181,6 @@ Chapter: Using Bugzilla
Platform and OS:
-
These indicate the computing environment where the bug was
found.
@@ -357,7 +188,6 @@ Chapter: Using Bugzilla
Version:
-
The "Version" field is usually used for versions of a product which
have been released, and is set to indicate which versions of a
Component have the particular problem the bug report is
@@ -367,7 +197,6 @@ Chapter: Using Bugzilla
Priority:
-
The bug assignee uses this field to prioritise his or her bugs.
It's a good idea not to change this on other people's bugs.
@@ -375,7 +204,6 @@ Chapter: Using Bugzilla
Severity:
-
This indicates how severe the problem is - from blocker
("application unusable") to trivial ("minor cosmetic issue"). You
can also use this field to indicate whether a bug is an enhancement
@@ -385,7 +213,6 @@ Chapter: Using Bugzilla
Target:
-
(a.k.a. Target Milestone) A future version by which the bug is to
be fixed. e.g. The Bugzilla Project's milestones for future
Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not
@@ -396,21 +223,18 @@ Chapter: Using Bugzilla
Reporter:
-
The person who filed the bug.CC list:
-
A list of people who get mail when the bug changes.Attachments:
-
You can attach files (e.g. testcases or patches) to bugs. If there
are any attachments, they are listed in this section.
@@ -418,7 +242,6 @@ Chapter: Using Bugzilla
Dependencies:
-
If this bug cannot be fixed unless other bugs are fixed (depends
on), or this bug stops other bugs being fixed (blocks), their
numbers are recorded here.
@@ -427,14 +250,12 @@ Chapter: Using Bugzilla
Votes:
-
Whether this bug has any votes.Additional Comments:
-
You can add your two cents to the bug discussion here, if you have
something worthwhile to say.
@@ -534,13 +355,11 @@ Chapter: Using Bugzilla
Go to
Landfill
-
in your browser and click
- Enter a new bug report
-
- .
+ Enter a new bug report.
+
@@ -563,26 +382,21 @@ Chapter: Using Bugzilla
User Preferences
- You can customise various aspects of Bugzilla, via the "Edit prefs"
- link in the page footer, once you have logged in, e.g. to
-
- Landfill
-
- . The preferences are split into four tabs.
+ Once you have logged in, you can customise various aspects of
+ Bugzilla via the "Edit prefs" link in the page footer.
+ The preferences are split into four tabs:Account Settings
- On this tab, you can change your basic Account Settings,
+ On this tab, you can change your basic account information,
including your password, email address and real name. For security
reasons, in order to change anything on this page you must type your
current
-
password into the
Password
-
- field. If you attempt to change your email address, a confirmation
+ field at the top of the page.
+ If you attempt to change your email address, a confirmation
email is sent to both the old and new addresses, with a link to use to
confirm the change. This helps to prevent account hijacking.
@@ -604,24 +418,24 @@ Chapter: Using Bugzilla
direct reports, or users go on vacation.
- This option may not be available in all Bugzilla installations.
- Ask your administrator.
+ The ability to watch other users may not be available in all
+ Bugzilla installations. If you can't see it, ask your
+ administrator.Page Footer
-
- By default, this page is quite barren. However, if you explore
- the Search page some more, you will find that you can store numerous
- queries on the server, so if you regularly run a particular query it is
- just a drop-down menu away. Once you have a stored query, you can come
+
+ On the Search page, you can store queries in Bugzilla, so if you
+ regularly run a particular query it is just a drop-down menu away.
+ Once you have a stored query, you can come
here to request that it also be displayed in your page footer.Permissions
-
+
This is a purely informative page which outlines your current
permissions on this installation of Bugzilla - what product groups you
are in, and whether you can edit bugs or perform various administration
diff --git a/docs/xml/variants.xml b/docs/xml/variants.xml
index 5fbea801fb..0626902720 100644
--- a/docs/xml/variants.xml
+++ b/docs/xml/variants.xml
@@ -30,38 +30,26 @@
Loki Bugzilla (Fenris)
- Fenris can be found at
-
- http://fenris.lokigames.com
-
- . It is a fork from Bugzilla.
+ Fenris was a fork from Bugzilla made by Loki Games; when
+ Loki went into receivership, it died. While Loki's other code lives on,
+ its custodians recommend Bugzilla for future bug-tracker deployments.
+ Issuezilla
- Issuezilla is another fork from Bugzilla, and seems nearly as
- popular as the Red Hat Bugzilla fork. Some Issuezilla team members are
- regular contributors to the Bugzilla mailing list/newsgroup. Issuezilla
- is not the primary focus of bug-tracking at tigris.org, however. Their
- Java-based bug-tracker,
-
-
- , is under heavy development and looks promising!
-
- URL:
-
- http://issuezilla.tigris.org/servlets/ProjectHome
-
+ Issuezilla was another fork from Bugzilla, made by collab.net and
+ hosted at tigris.org. It is also dead; the primary focus of bug-tracking
+ at tigris.org is their Java-based bug-tracker,
+ .
-
+ Scarab
- Scarab is a promising new bug-tracking system built using Java
- Serlet technology. As of this writing, no source code has been released
- as a package, but you can obtain the code from CVS.
+ Scarab is a new bug-tracking system built using Java
+ Serlet technology. It is currently at version 1.0 beta 7.URL:
http://scarab.tigris.org
@@ -72,9 +60,7 @@
Perforce SCMAlthough Perforce isn't really a bug tracker, it can be used as
- such through the
- jobs
-
+ such through the jobs
functionality.
@@ -87,10 +73,9 @@
SourceForge
- SourceForge is more of a way of coordinating geographically
- distributed free software and open source projects over the Internet than
- strictly a bug tracker, but if you're hunting for bug-tracking for your
- open project, it may be just what the software engineer ordered!
+ SourceForge is a way of coordinating geographically
+ distributed free software and open source projects over the Internet.
+ It has a built-in bug tracker, but it's not highly thought of.URL:
--
2.47.3