From 96a0037afe2fd59183fbc5028311f04f02b7d540 Mon Sep 17 00:00:00 2001 From: "gerv%gerv.net" <> Date: Fri, 16 Jan 2004 07:54:28 +0000 Subject: Another pre-2.17.7 rev. --- docs/txt/Bugzilla-Guide.txt | 426 +++++++++++++++++++++----------------------- 1 file changed, 203 insertions(+), 223 deletions(-) (limited to 'docs/txt/Bugzilla-Guide.txt') diff --git a/docs/txt/Bugzilla-Guide.txt b/docs/txt/Bugzilla-Guide.txt index d7cf3974c..b4c4026bc 100644 --- a/docs/txt/Bugzilla-Guide.txt +++ b/docs/txt/Bugzilla-Guide.txt @@ -31,15 +31,16 @@ The Bugzilla Team 3. Using Bugzilla - 3.1. Create a Bugzilla Account - 3.2. Anatomy of a Bug - 3.3. Searching for Bugs - 3.4. Bug Lists - 3.5. Filing Bugs - 3.6. Patch Viewer - 3.7. Hints and Tips - 3.8. User Preferences - 3.9. Reports + 3.1. Introduction + 3.2. Create a Bugzilla Account + 3.3. Anatomy of a Bug + 3.4. Searching for Bugs + 3.5. Bug Lists + 3.6. Filing Bugs + 3.7. Patch Viewer + 3.8. Hints and Tips + 3.9. User Preferences + 3.10. Reports 4. Installation @@ -153,13 +154,11 @@ Chapter 1. About This Guide match the current version of Bugzilla. This version of the guide, like its associated Bugzilla version, is a development version. - The newest version of this guide can always be found at - http://www.bugzilla.org; however, you should read the version which - came with the Bugzilla release you are using. - - The latest version of this document can always be checked out via CVS. - Please follow the Mozilla CVS instructions and check out the - mozilla/webtools/bugzilla/docs/ subtree. + The latest version of this guide can always be found at + http://www.bugzilla.org, or checked out via CVS. (Please follow the + Mozilla CVS instructions and check out the + mozilla/webtools/bugzilla/docs/ subtree.) However, you should read the + version which came with the Bugzilla release you are using. The Bugzilla Guide is currently only available in English. If you would like to volunteer to translate it, please contact Dave Miller. @@ -187,7 +186,7 @@ Chapter 1. About This Guide This document uses the following conventions: Descriptions Appearance - Warnings + Warning Caution @@ -197,7 +196,7 @@ Chapter 1. About This Guide Tip Would you like a breath mint? - Notes + Note Note @@ -207,12 +206,12 @@ Chapter 1. About This Guide Warning Read this or the cat gets it. - File and directory names filename - Commands to be typed command - Applications names application - Prompt of users command under bash shell bash$ - Prompt of root users command under bash shell bash# - Prompt of user command under tcsh shell tcsh$ + File or directory name filename + Command to be typed command + Application name application + Normal user's prompt under bash shell bash$ + Root user's prompt under bash shell bash# + Normal user's prompt under tcsh shell tcsh$ Environment variables VARIABLE Term found in the glossary Bugzilla Code example @@ -238,26 +237,21 @@ Chapter 2. Introduction 2.2. Why use a bug-tracking system? - For many years, defect-tracking software was principally the domain of - large software development houses. Most smaller shops simply relied on - shared lists and email to monitor the status of defects. This - procedure was error-prone and tended to cause those bugs judged least - significant by developers to be dropped or ignored. + Those who do not use a bug-tracking system tend to rely on shared + lists, email, spreadsheets and/or Post-It notes to monitor the status + of defects. This procedure is usually error-prone and tends to cause + those bugs judged least significant by developers to be dropped or + ignored. - Integrated defect-tracking systems reduce downtime, increase - productivity, and raise customer satisfaction with their systems. - Along with full disclosure, an open bug-tracker allows you to keep in - touch with your 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 method for accounting for unusual - system or software issues. + Integrated defect-tracking systems make sure that nothing gets swept + under the carpet; they provide a method of creating, storing, + arranging and processing defect reports and enhancement requests. _________________________________________________________________ 2.3. Why use Bugzilla? - Bugzilla boasts many advanced features. These include: + Bugzilla is the leading open-source/free software bug tracking system. + It boasts many advanced features, including: * Powerful searching * User-configurable email notifications of bug changes @@ -267,8 +261,8 @@ Chapter 2. Introduction * 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 + * Additional XML, email and console interfaces * Extensive configurability * Smooth upgrade pathway between versions @@ -278,12 +272,13 @@ Chapter 2. Introduction 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. + provides a powerful, easy-to-use configuration management solution. _________________________________________________________________ Chapter 3. Using Bugzilla +3.1. Introduction + This section contains information for end-users of Bugzilla. There is a Bugzilla test installation, called Landfill, which you are welcome to play with (if it's up.) However, it does not necessarily have all @@ -291,7 +286,7 @@ Chapter 3. Using Bugzilla some things may not quite work as this document describes. _________________________________________________________________ -3.1. Create a Bugzilla Account +3.2. Create a Bugzilla Account If you want to use Bugzilla, first you need to create an account. Consult with the administrator responsible for your installation of @@ -315,7 +310,7 @@ Chapter 3. Using Bugzilla changes, you should not have to log in again. _________________________________________________________________ -3.2. Anatomy of a Bug +3.3. Anatomy of a Bug The core of Bugzilla is the screen which displays a particular bug. It's a good place to explain some Bugzilla concepts. Bug 1 on Landfill @@ -391,7 +386,7 @@ Chapter 3. Using Bugzilla discussion here, if you have something worthwhile to say. _________________________________________________________________ -3.3. Searching for Bugs +3.4. Searching for Bugs The Bugzilla Search page is is the interface where you can find any bug report, comment, or patch currently in the Bugzilla system. You @@ -411,7 +406,7 @@ Chapter 3. Using Bugzilla Charts help link on the Search page for more information. _________________________________________________________________ -3.4. Bug Lists +3.5. Bug Lists If you run a search, a list of matching bugs will be returned. @@ -421,19 +416,23 @@ Chapter 3. Using Bugzilla Long Format: this gives you a large page with a non-editable summary of the fields of each bug. + CSV: get the buglist as comma-separated values, for import into e.g. a + spreadsheet. 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. 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 Search: 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. + Remember Search As: You can give a search a name and remember it; a + link will appear in your page footer giving you quick access to run it + again later. _________________________________________________________________ -3.5. Filing Bugs +3.6. Filing Bugs Years of bug writing experience has been distilled for your reading pleasure into the Bug Writing Guidelines. While some of the advice is @@ -452,9 +451,21 @@ Chapter 3. Using Bugzilla based upon your browser, for the "Platform" and "OS" drop-down boxes. If they are wrong, change them. 4. Select "Commit" and send in your bug report. + + Try to make sure that everything said in the summary is also said in + the first comment. Summaries are often updated and this will ensure + your original information is easily accessible. + + You do not need to put "any" or similar strings in the URL field. If + there is no specific URL associated with the bug, leave this field + blank. + + If you feel a bug you filed was incorrectly marked as a DUPLICATE of + another, please question it in your bug, not the bug it was duped to. + Feel free to CC the person who duped it if they are not already CCed. _________________________________________________________________ -3.6. Patch Viewer +3.7. Patch Viewer Viewing and reviewing patches in Bugzilla is often difficult due to lack of context, improper format and the inherent readability issues @@ -476,7 +487,7 @@ Chapter 3. Using Bugzilla format it came from _________________________________________________________________ -3.6.1. Viewing Patches in Patch Viewer +3.7.1. Viewing Patches in Patch Viewer The main way to view a patch in patch viewer is to click on the "Diff" link next to a patch in the Attachments list on a bug. You may also do @@ -484,7 +495,7 @@ Chapter 3. Using Bugzilla button in the Edit Attachment screen. _________________________________________________________________ -3.6.2. Seeing the Difference Between Two Patches +3.7.2. Seeing the Difference Between Two Patches To see the difference between two patches, you must first view the newer patch in Patch Viewer. Then select the older patch from the @@ -493,7 +504,7 @@ Chapter 3. Using Bugzilla new or changed in the newer patch. _________________________________________________________________ -3.6.3. Getting More Context in a Patch +3.7.3. Getting More Context in a Patch To get more context in a patch, you put a number in the textbox at the top of Patch Viewer ("Patch / File / [textbox]") and hit enter. This @@ -503,7 +514,7 @@ Chapter 3. Using Bugzilla against files that were diffed using "cvs diff". _________________________________________________________________ -3.6.4. Collapsing and Expanding Sections of a Patch +3.7.4. Collapsing and Expanding Sections of a Patch To view only a certain set of files in a patch (for example, if a patch is absolutely huge and you want to only review part of it at a @@ -513,7 +524,7 @@ Chapter 3. Using Bugzilla the top of the page. _________________________________________________________________ -3.6.5. Linking to a Section of a Patch +3.7.5. Linking to a Section of a Patch To link to a section of a patch (for example, if you want to be able to give someone a URL to show them which part you are talking about) @@ -522,7 +533,7 @@ Chapter 3. Using Bugzilla Location in Mozilla works as well.) _________________________________________________________________ -3.6.6. Going to Bonsai and LXR +3.7.6. Going to Bonsai and LXR To go to Bonsai to get blame for the lines you are interested in, you can click the "Lines XX-YY" link on the section header you are @@ -534,20 +545,20 @@ Chapter 3. Using Bugzilla numbers are likely to rot). _________________________________________________________________ -3.6.7. Creating a Unified Diff +3.7.7. Creating a Unified Diff If the patch is not in a format that you like, you can turn it into a unified diff format by clicking the "Raw Unified" link at the top of the page. _________________________________________________________________ -3.7. Hints and Tips +3.8. Hints and Tips This section distills some Bugzilla tips and best practices that have been developed. _________________________________________________________________ -3.7.1. Autolinkification +3.8.1. Autolinkification Bugzilla comments are plain text - so typing will produce less-than, U, greater-than rather than underlined text. However, @@ -570,7 +581,7 @@ Chapter 3. Using Bugzilla convenience of others. _________________________________________________________________ -3.7.2. Quicksearch +3.8.2. Quicksearch Quicksearch is a single-text-box query tool which uses metacharacters to indicate what is to be searched. For example, typing "foo|bar" into @@ -582,7 +593,7 @@ Chapter 3. Using Bugzilla Help link which details how to use it. _________________________________________________________________ -3.7.3. Comments +3.8.3. Comments If you are changing the fields on a bug, only comment if either you have something pertinent to say, or Bugzilla requires it. Otherwise, @@ -598,7 +609,7 @@ Chapter 3. Using Bugzilla art creations are not. _________________________________________________________________ -3.7.4. Attachments +3.8.4. Attachments Use attachments, rather than comments, for large chunks of ASCII data, such as trace, debugging output files, or log files. That way, it @@ -614,29 +625,14 @@ Chapter 3. Using Bugzilla way, the test case works immediately out of the bug. _________________________________________________________________ -3.7.5. Filing Bugs - - Try to make sure that everything said in the summary is also said in - the first comment. Summaries are often updated and this will ensure - your original information is easily accessible. - - You do not need to put "any" or similar strings in the URL field. If - there is no specific URL associated with the bug, leave this field - blank. - - If you feel a bug you filed was incorrectly marked as a DUPLICATE of - another, please question it in your bug, not the bug it was duped to. - Feel free to CC the person who duped it if they are not already CCed. - _________________________________________________________________ - -3.8. User Preferences +3.9. User Preferences 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 three tabs: _________________________________________________________________ -3.8.1. Account Settings +3.9.1. Account Settings On this tab, you can change your basic account information, including your password, email address and real name. For security reasons, in @@ -647,7 +643,7 @@ Chapter 3. Using Bugzilla change. This helps to prevent account hijacking. _________________________________________________________________ -3.8.2. Email Settings +3.9.2. Email Settings 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 @@ -671,7 +667,7 @@ Chapter 3. Using Bugzilla installations. If you can't see it, ask your administrator. _________________________________________________________________ -3.8.3. Permissions +3.9.3. Permissions This is a purely informative page which outlines your current permissions on this installation of Bugzilla - what product groups you @@ -679,7 +675,7 @@ Chapter 3. Using Bugzilla administration functions. _________________________________________________________________ -3.9. Reports +3.10. Reports To be written _________________________________________________________________ @@ -692,8 +688,8 @@ Chapter 4. Installation operating systems including almost all Unix clones and Microsoft Windows. Many operating systems have utilities that make installation easier or quirks that make it harder. We have tried to collect that - information in Section 4.4, so be sure to check out that section - before you start your installation. + information in Section 4.4, so unless you are on Linux, be sure to + check out that section before you start your installation. Note @@ -704,27 +700,25 @@ Chapter 4. Installation Warning While installing Bugzilla, it is a good idea to ensure that there is - some kind of firewall between you and the rest of the Internet as 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. + some kind of configurable firewall between you and the rest of the + Internet as 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. This guide assumes that you already have your operating system installed, network configured, and have administrative access to the - shell on the machine you are installing Bugzilla onto. It is possible - to install and run Bugzilla without administrative access, but you + machine onto which you are installing Bugzilla. It is possible to + install and run Bugzilla itself without administrative access, but you have to either make sure all the required software is installed or get somebody with administrative access to install it for you. You are strongly recommended to make a backup of your system before - installing Bugzilla and at regular intervals thereafter. + installing Bugzilla (and at regular intervals thereafter :-). - The listing below is a basic step-by-step list. More information can - be found in the sections below. Minimum versions will be included in - parenthesis where appropriate. - 1. Install Perl (5.6) - 2. Install MySQL (3.23.41) + Here's a basic step-by-step list: + 1. Install Perl (5.6.0 or above) + 2. Install MySQL (3.23.41 or above) 3. Install a Webserver 4. Put Bugzilla in the Webspace 5. Install Perl Modules @@ -733,18 +727,20 @@ Chapter 4. Installation 4.1.1. Perl - Any machine that doesn't have Perl on it is a sad machine indeed. Perl - can be got in source form from http://www.perl.com. There are also - binary versions available for many platforms, most of which are linked - to from perl.com. Although Bugzilla runs with perl 5.6, 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.8. + Any machine that doesn't have Perl on it is a sad machine indeed. If + your OS doesn't come with it, Perl can be got in source form from + http://www.perl.com. There are also binary versions available for many + platforms, most of which are linked to from perl.com. Although + Bugzilla runs with perl 5.6.0, 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.8.2. _________________________________________________________________ 4.1.2. MySQL - Visit the MySQL homepage at http://www.mysql.com to grab and install - the latest stable release of the server. + If your OS doesn't come with it or provide official packages, visit + the MySQL homepage at http://www.mysql.com to grab and install the + latest stable release of the server. Note @@ -771,29 +767,30 @@ Chapter 4. Installation set-variable = max_allowed_packet=1M If you are running Bugzilla and MySQL on the same machine, you may - also wish to utilize the skip-networking option as mentioned in + also wish to utilize the --skip-networking option as mentioned in Section 4.5.2 for the added security. _________________________________________________________________ -4.1.2.1. Configuring MySQL +4.1.2.1. Adding a user to MySQL This first thing you'll want to do is make sure you've given the - "root" user a password as suggested in Section 4.5.2. For clarity, - these instructions will assume that your MySQL user for Bugzilla will - be "bugs_user", the database will be called "bugs_db" and the password - for the "bugs_user" user is "bugs_password". You should, of course, - substitute the values you intend to use for your site. + "root" user a password as suggested in Section 4.5.2. Then, you need + to add a user for Bugzilla to use. For clarity, these instructions + will assume that your MySQL user for Bugzilla will be "bugs_user", the + database will be called "bugs_db" and the password for the "bugs_user" + user is "bugs_password". You should, of course, substitute the values + you intend to use for your site. Note - Most people use "bugs" for both the user and database name. + Most people use "bugs" for both the user and database name. Don't use + it for the password, though... - Next, we use an SQL GRANT command to create a "bugs_user" user, and - grant sufficient permissions for checksetup.pl, which we'll use later, - to work its magic. This also restricts the "bugs_user" user to - operations within a database called "bugs_db", 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. + We use an SQL GRANT command to create a "bugs_user" user. This also + restricts the "bugs_user" user to operations within a database called + "bugs_db", 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. mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE, DROP,REFERENCES ON bugs_db.* TO bugs_user@localhost IDENTIFIED BY 'bugs_password'; @@ -802,7 +799,8 @@ set-variable = max_allowed_packet=1M Note If you are using MySQL 4, the bugs user also needs to be granted the - LOCK TABLES and CREATE TEMPORARY TABLES permissions. + LOCK TABLES and CREATE TEMPORARY TABLES permissions, so add them to + the list in the GRANT command. _________________________________________________________________ 4.1.3. HTTP Server @@ -830,28 +828,71 @@ set-variable = max_allowed_packet=1M Tip - If you symlink the bugzilla directory into your Apache's HTML + If you symlink the bugzilla directory into your Apache's html hierarchy, you may receive Forbidden errors unless you add the - "FollowSymLinks" directive to the entry for the HTML root - in httpd.conf. + FollowSymLinks directive to the entry for the HTML root + directory in httpd.conf. + + Caution + + The default Bugzilla distribution is not designed to be placed in a + cgi-bin directory (this includes any directory which is configured + using the ScriptAlias directive of Apache). 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. + _________________________________________________________________ - Caution +4.1.5. checksetup.pl - The default Bugzilla distribution is not designed to be placed in a - cgi-bin directory (this includes any directory which is configured - using the ScriptAlias directive of Apache). + Next, run the magic checksetup.pl script. This is designed to check + whether you have all of the right Perl modules in the correct + versions, and that Bugzilla is generally set up correctly. + + Eventually, it will make sure Bugzilla files and directories have + reasonable permissions, set up the data directory, and create all the + MySQL tables. But the first time you run it, it's highly likely to + tell you that you are missing a few Perl modules. Make a note of which + ones they are, and then proceed to the next section to install them. +bash# ./checksetup.pl + + The first time you run it with all the correct modules installed, 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: + + 1. server's host: just use "localhost" if the MySQL server is local + 2. database name: "bugs_db" if you're following these directions + 3. MySQL username: "bugs_user" if you're following these directions + 4. Password for the "bugs_user" MySQL account; ("bugs_password" + above) + + Edit the file to change these. Once you are happy with the settings, + su to the user your web server runs as, and re-run checksetup.pl. + (Note: on some security-conscious systems, you may need to change the + login shell for the webserver account before you can do this.) On this + second run, it will create the database and an administrator account + for which you will be prompted to provide information. + + Note + + 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. _________________________________________________________________ -4.1.5. Perl Modules +4.1.6. Perl Modules + + Don't be intimidated by this long list of modules. See Section 4.1.6.1 + for a way of installing all the ones you need with a single command. Perl modules can be found using CPAN on Unix based systems or PPM on - Win32. The root servers have a real tendency to bog down, so please - use mirrors. + Win32. Good instuctions can be found for using each of these services on their respective websites. The basics can be found in Example 4-1 for @@ -892,16 +933,14 @@ bash# make install Perl Modules (minimum version): 1. Bundle::Bugzilla (Will allow you to skip the rest) - 2. AppConfig (1.52) - 3. CGI (2.88) - 4. Data::Dumper (any) - 5. Date::Format (2.21) - 6. DBI (1.32) - 7. DBD::mysql (2.1010) - 8. File::Spec (0.82) - 9. File::Temp (any) - 10. Template Toolkit (2.08) - 11. Text::Wrap (2001.0131) + 2. CGI (2.88) + 3. Date::Format (2.21) + 4. DBI (1.32) + 5. DBD::mysql (2.1010) + 6. File::Spec (0.82) + 7. File::Temp (any) + 8. Template Toolkit (2.08) + 9. Text::Wrap (2001.0131) and, optionally: @@ -914,7 +953,7 @@ bash# make install 7. PatchReader (0.9.1) for pretty HTML view of patches _________________________________________________________________ -4.1.5.1. Bundle::Bugzilla +4.1.6.1. Bundle::Bugzilla If you are running at least perl 5.6.1, you can save yourself a lot of time by using Bundle::Bugzilla. This bundle contains every module @@ -937,13 +976,7 @@ cpan> you'll have to go through a series of configuration steps. _________________________________________________________________ -4.1.5.2. AppConfig (1.52) - - Dependency for Template Toolkit. We probably don't need to - specifically check for it anymore. - _________________________________________________________________ - -4.1.5.3. CGI (2.88) +4.1.6.2. CGI (2.88) The CGI module parses form elements and cookies and does many other usefule things. It come as a part of recent perl distributions, but @@ -955,21 +988,7 @@ cpan> Documentation: http://www.perldoc.com/perl5.8.0/lib/CGI.html _________________________________________________________________ -4.1.5.4. Data::Dumper (any) - - 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. - - CPAN Download Page: http://search.cpan.org/dist/Data-Dumper/ - PPM Download Link: http://ppm.activestate.com/PPMPackages/zips - /6xx-builds-only/Data-Dumper.zip - Documentation: http://www.perldoc.com/perl5.8.0/lib/Data/Dumpe - r.html - _________________________________________________________________ - -4.1.5.5. TimeDate modules (2.21) +4.1.6.3. TimeDate modules (2.21) Many of the more common date/time/calendar related Perl modules have been grouped into a bundle similar to the MySQL modules bundle. This @@ -984,7 +1003,7 @@ cpan> ormat.pm _________________________________________________________________ -4.1.5.6. DBI (1.32) +4.1.6.4. DBI (1.32) The DBI module is a generic Perl module used the MySQL-related modules. As long as your Perl installation was done correctly the DBI @@ -997,7 +1016,7 @@ cpan> Documentation: http://dbi.perl.org/doc/ _________________________________________________________________ -4.1.5.7. MySQL-related modules +4.1.6.5. MySQL-related modules The Perl/MySQL interface requires a few mutually-dependent Perl modules. These modules are grouped together into the the @@ -1022,7 +1041,7 @@ cpan> ysql.pod _________________________________________________________________ -4.1.5.8. File::Spec (0.82) +4.1.6.6. File::Spec (0.82) File::Spec is a perl module that allows file operations, such as generating full path names, to work cross platform. @@ -1034,7 +1053,7 @@ cpan> html _________________________________________________________________ -4.1.5.9. File::Temp (any) +4.1.6.7. File::Temp (any) File::Temp is used to generate a temporary filename that is guaranteed to be unique. It comes as a standard part of perl @@ -1046,7 +1065,7 @@ cpan> html _________________________________________________________________ -4.1.5.10. Template Toolkit (2.08) +4.1.6.8. Template Toolkit (2.08) When you install Template Toolkit, you'll get asked various questions about features to enable. The defaults are fine, except that it is @@ -1060,7 +1079,7 @@ cpan> Documentation: http://www.template-toolkit.org/docs.html _________________________________________________________________ -4.1.5.11. Text::Wrap (2001.0131) +4.1.6.9. Text::Wrap (2001.0131) Text::Wrap is designed to proved intelligent text wrapping. @@ -1070,15 +1089,9 @@ cpan> html _________________________________________________________________ -4.1.5.12. GD (1.20) [optional] +4.1.6.10. GD (1.20) [optional] - The GD library was written by Thomas Boutell a long while ago to - programmatically generate images in C. Since then it's become the - defacto standard for programmatic 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. + You need the GD library if you want any of the graphing to work. Note @@ -1099,7 +1112,7 @@ cpan> Documentation: http://stein.cshl.org/WWW/software/GD/ _________________________________________________________________ -4.1.5.13. Chart::Base (0.99c) [optional] +4.1.6.11. Chart::Base (0.99c) [optional] The Chart module provides Bugzilla with on-the-fly charting abilities. It can be installed in the usual fashion after it has been fetched @@ -1111,7 +1124,7 @@ cpan> /6xx-builds-only/Chart.zip _________________________________________________________________ -4.1.5.14. XML::Parser (any) [Optional] +4.1.6.12. XML::Parser (any) [optional] XML::Parser is used by the importxml.pl script. You only need it if you are going to be importing bugs (such as for bug moving). @@ -1123,7 +1136,7 @@ cpan> .html _________________________________________________________________ -4.1.5.15. GD::Graph (any) [Optional] +4.1.6.13. GD::Graph (any) [optional] In addition to GD listed above, the reporting interface of Bugzilla needs to have the GD::Graph module installed. @@ -1134,7 +1147,7 @@ cpan> Documentation: http://search.cpan.org/dist/GDGraph/Graph.pm _________________________________________________________________ -4.1.5.16. GD::Text::Align (any) [Optional] +4.1.6.14. GD::Text::Align (any) [optional] GD::Text::Align, as the name implies, is used to draw aligned strings of text. It is needed by the reporting interface. @@ -1146,7 +1159,7 @@ cpan> gn.pm _________________________________________________________________ -4.1.5.17. MIME::Parser (any) [Optional] +4.1.6.15. MIME::Parser (any) [optional] MIME::Parser is only needed if you want to use the e-mail interface located in the contrib directory. @@ -1158,7 +1171,7 @@ cpan> /Parser.pm _________________________________________________________________ -4.1.5.18. PatchReader (0.9.1) [Optional] +4.1.6.16. PatchReader (0.9.1) [optional] PatchReader is only needed if you want to use Patch Viewer, a Bugzilla feature to format patches in a pretty HTML fashion. There are a number @@ -1176,45 +1189,12 @@ cpan> html _________________________________________________________________ -4.1.6. checksetup.pl - - Next, run the magic checksetup.pl script. This is designed to make - sure your perl modules are the correct version and 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. -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. - - The connection settings include: - - 1. server's host: just use "localhost" if the MySQL server is local - 2. database name: "bugs_db" if you're following these directions - 3. MySQL username: "bugs_user" if you're following these directions - 4. Password for the "bugs_user" 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. (Note: on some security-conscious - systems, you may need to change the login shell for the webserver - account before you can do this.) On this second run, it will create - the database and an administrator account for which you will be - prompted to provide information. - - Note - - 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. - _________________________________________________________________ - 4.1.7. Configuring Bugzilla + Once checksetup.pl has run successfully, Bugzilla should start up. + Proceed to the correct URL and log in with the administrator account + you defined in the last checksetup.pl run. + You should run through the parameters on the Edit Parameters page (link in the footer) and set them all to appropriate values. They key parameters are documented in Section 5.1. @@ -1536,7 +1516,7 @@ Javascript code 4.4.1.2. Perl Modules on Win32 Bugzilla on Windows requires the same perl modules found in Section - 4.1.5. The main difference is that windows uses PPM instead of CPAN. + 4.1.6. The main difference is that windows uses PPM instead of CPAN. C:\perl> ppm Note -- cgit v1.2.3-24-g4f1b