From 938c535f8ca7934c3d7c9597024316596192eea8 Mon Sep 17 00:00:00 2001 From: "jake%bugzilla.org" <> Date: Fri, 4 Apr 2008 11:46:35 +0000 Subject: Bug 191034 - Making the installation chapter a little more generic. Replaced a lot of OS Specific hints with links to the OS Specific section. --- docs/en/xml/Bugzilla-Guide.xml | 6 +- docs/en/xml/glossary.xml | 27 +- docs/en/xml/installation.xml | 867 +++++++++++++++++++++++------------------ 3 files changed, 525 insertions(+), 375 deletions(-) (limited to 'docs') diff --git a/docs/en/xml/Bugzilla-Guide.xml b/docs/en/xml/Bugzilla-Guide.xml index fd7353e8d..e50784f81 100644 --- a/docs/en/xml/Bugzilla-Guide.xml +++ b/docs/en/xml/Bugzilla-Guide.xml @@ -34,7 +34,7 @@ - + @@ -47,7 +47,7 @@ - + @@ -121,7 +121,7 @@ try to avoid clutter and feel free to waste space in the code to make it more re This documentation is maintained in DocBook 4.1.2 XML format. Changes are best submitted as plain text or XML diffs, attached - to a bug filed in the &bzg-bugs; compontent. + to a bug filed in the &bzg-bugs; component. This is a development version of this guide. Information in it diff --git a/docs/en/xml/glossary.xml b/docs/en/xml/glossary.xml index 807b7e647..d43b699dd 100644 --- a/docs/en/xml/glossary.xml +++ b/docs/en/xml/glossary.xml @@ -154,10 +154,10 @@ - - CPAN - + Comprehensive Perl Archive Network + CPAN + CPAN @@ -283,6 +283,16 @@ P + + Perl Package Manager + PPM + + + + + + + Product @@ -347,6 +357,17 @@ + + + Regular Expression + regexp + + + A regular expression is an expression used for pattern matching. + Documentation + + + diff --git a/docs/en/xml/installation.xml b/docs/en/xml/installation.xml index 142afaba7..7914200ee 100644 --- a/docs/en/xml/installation.xml +++ b/docs/en/xml/installation.xml @@ -1,406 +1,446 @@ - + + Installation -
+
Step-by-step Install -
- Introduction + Bugzilla has been successfully installed under many different + 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 + , so be sure to check out that section before + you start your installation. + - 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 - - for further advice on getting Bugzilla to work on Microsoft - Windows. + + Windows is one of those operating systems that has many quirks + and is not yet officially supported by the Bugzilla team. If you wish + to install Bugzilla on Windows, be sure to see + . + + -
+ + 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. + + + 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 have to + either make sure all the required software is installed or get somebody + with administrative access to install it for you. + + + 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. + + + + + Install MySQL + (&min-mysql-ver;) + + + + Install Perl + (&min-perl-ver;) + + + + Install Perl Modules + + + + Install a Webserver + + + + Put Bugzilla in the Webspace + + + + Setup the MySQL Database + + + -
- Package List +
+ MySQL + Visit the MySQL homepage at + + to grab and install the latest stable release of the server. + + - 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; see - . - + 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. You can set the data + directory as an option to configure + if you build MySQL from source yourself. - The software packages necessary for the proper running of - Bugzilla (with download links) are: - - + If you install from something other than a packaging/installation + system (such as .rpm, .dep, .exe, or .msi) you will need to configure + your system so the MySQL server daemon will come back up whenever + your machine reboots. + + + If you wish to have attachments larger than 64K, you will have to + configure MySQL to accept large packets. This is done by adding the text + in to your + my.conf file. There is also a parameter in Bugzilla + for setting the maximum allowable attachment size. + + You should set this value to be slightly larger than that parameter. + + +
+ Set Max Packet Size in MySQL + + +[mysqld] +# Allow packets up to 1M +set-variable = max_allowed_packet=1M + +
+ + If you are running Bugzilla and MySQL on the same machine, you may + also wish to utilize the option as + mentioned in for the added security. + +
+ +
+ Perl + + Any machine that doesn't have Perl on it is a sad machine indeed. + Perl can be got in source form from . + There are also binary versions available for many platforms, most of which + are linked to from perl.com. + Although Bugzilla runs with perl &min-perl-ver;, + 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 &newest-perl-ver;. +
+ +
+ Perl Modules - - - MySQL database server - (&min-mysql-ver; or greater) - - + 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. + + + Good instuctions can be found for using each of these services on + their respective websites. The basics can be found in + for CPAN and + for PPM. + + + + Installing perl modules with CPAN + + The easy way: + +bash# perl -MCPAN -e 'install "<modulename>"' + + + + Or the hard way: + +bash# tar xzvf <module>.tar.gz +bash# cd <module> +bash# perl Makefile.PL +bash# make +bash# make test +bash# make install + + + + This assumes that you've already downloaded the + <module>.tar.gz to the current working + directory. + + + + The process of untaring the module as defined in + will create the + <module> directory. + + + + + + + + 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. + - - - Perl - (&min-perl-ver;, 5.6.1 is recommended if you wish to - use Bundle::Bugzilla) - - - + Perl Modules (minimum version): + - Template - (v&min-template-ver;) + Bundle::Bugzilla + (Will allow you to skip the rest) - - File::Temp - (&min-file-temp-ver;) (Prerequisite for Template) + AppConfig + (&min-appconfig-ver;) - AppConfig - - (&min-appconfig-ver;) + CGI + (&min-cgi-ver;) - Text::Wrap - (&min-text-wrap-ver;) + Data::Dumper + (&min-data-dumper-ver;) - File::Spec - - (&min-file-spec-ver;) + Date::Format + (&min-date-format-ver;) - Data::Dumper - - (&min-data-dumper-ver;) + DBI + (&min-dbi-ver;) - DBD::mysql - + DBD::mysql (&min-dbd-mysql-ver;) - DBI - (&min-dbi-ver;) + File::Spec + (&min-file-spec-ver;) - Date::Parse - - (&min-date-format-ver;) + File::Temp + (&min-file-temp-ver;) - CGI - - (&min-cgi-ver;) + Template Toolkit + (&min-template-ver;) + + + Text::Wrap + (&min-text-wrap-ver;) + + + and, optionally: - GD + GD (&min-gd-ver;) for bug charting - GD::Graph - (&min-gd-graph-ver;) for bug charting + Chart::Base + (&min-chart-base-ver;) for bug charting - GD::Text::Align - (&min-gd-text-align-ver;) for bug charting + XML::Parser + (&min-xml-parser-ver;) for the XML interface - Chart::Base - - (&min-chart-base-ver;) for bug charting + GD::Graph + (&min-gd-graph-ver;) for bug charting - XML::Parser - (&min-xml-parser-ver;) for the XML interface + GD::Text::Align + (&min-gd-text-align-ver;) for bug charting - MIME::Parser + MIME::Parser (&min-mime-parser-ver;) for the email interface - - - - The web server of your choice. - Apache - is highly 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. - +
+ 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 + required to get Bugzilla running. It does not include GD and friends, but + these are not required for a base install and can always be added later + if the need arises. -
-
- MySQL - - Visit the MySQL homepage at - - to grab and install the latest stable release of the server. + Assuming your perl was installed with CPAN (most unix installations + are), using Bundle::Bugzilla is really easy. Simply follow along with the + commands below. - - - 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. You can set the data - directory as an option to configure - if you build MySQL from source yourself. - - If you install from something other than an RPM or Debian - package, you will 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 - Any machine that doesn't have Perl on it is a sad machine indeed. - Perl can be got in source form from - for the rare - *nix systems which don't have it. - Although Bugzilla runs with perl &min-perl-ver;, - 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 &newest-perl-ver;. + +bash# perl -MCPAN -eshell +cpan shell -- CPAN exploration and modules installation (v1.63) +ReadLine support enabled - +cpan> - You can skip the following Perl module installation steps by - installing - Bundle::Bugzilla + - from - CPAN, - which installs all required modules for you. - - - - 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. - + + + At this point, unless you've used CPAN on this machine before, + you'll have to go through a series of configuration steps. + + +
-
- Perl Modules - - - All Perl modules can be found on the - Comprehensive Perl - Archive Network (CPAN). The - CPAN servers have a real tendency to bog down, so please use mirrors. - - - 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: - +
+ AppConfig (&min-appconfig-ver;) - - - bash# - perl -MCPAN -e 'install "<modulename>"' - + Dependency for Template Toolkit. We probably don't need to + specifically check for it anymore. - - - 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# +
+ CGI (&min-cgi-ver;) - perl Makefile.PL - - - + The CGI module parses form elements and cookies and does many + other usefule things. It come as a part of recent perl distributions, but + Bugzilla needs a fairly new version. + - - - - bash# + + CPAN Download Page: + PPM Download Link: + Documentation: + +
- make - - - +
+ Data::Dumper (&min-data-dumper-ver;) - - - - bash# + 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. + - make test - - - + + CPAN Download Page: + PPM Download Link: + Documentation: + +
- - - - bash# +
+ TimeDate modules (&min-date-format-ver;) - make install - - - - + 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. - - - 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. - + + CPAN Download Page: + PPM Download Link: + Documentation: + +
-
- DBI +
+ DBI (&min-dbi-ver;) 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. -
- -
- 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. + + CPAN Download Page: + PPM Download Link: + Documentation: +
-
+
MySQL-related modules The Perl/MySQL interface requires a few mutually-dependent Perl @@ -419,24 +459,77 @@ with a null password should find itself with sufficient access to run tests on the 'test' database which MySQL created upon installation. + + + CPAN Download Page: + PPM Download Link: + Documentation: +
-
- TimeDate modules +
+ File::Spec (&min-file-spec-ver;) - 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. + File::Spec is a perl module that allows file operations, such as + generating full path names, to work cross platform. + + + CPAN Download Page: + PPM Download Page: + Documentation: +
-
- GD (optional) +
+ File::Temp (&min-file-temp-ver;) + + File::Temp is used to generate a temporary filename that is + guaranteed to be unique. It comes as a standard part of perl + + + + CPAN Download Page: + PPM Download Link: + Documentation: + +
+ +
+ Template Toolkit (&min-template-ver;) + + When you install Template Toolkit, you'll get asked various + questions about features to enable. The defaults are fine, except + that it is recommended you use the high speed XS Stash of the Template + Toolkit, in order to achieve best performance. + + + + CPAN Download Page: + PPM Download Link: + Documentation: + +
+ +
+ Text::Wrap (&min-text-wrap-ver;) + + Text::Wrap is designed to proved intelligent text wrapping. + + + + + CPAN Download Page: + Documentation: + +
+ + +
+ GD (&min-gd-ver;) [optional] The GD library was written by Thomas Boutell a long while ago to - programatically generate images in C. Since then it's become the + 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 @@ -452,32 +545,99 @@ If compiling GD fails, it's probably because you're missing a required library. + + + The version of the GD perl module you need is very closely tied + to the libgd version installed on your system. + If you have a version 1.x of libgd the 2.x + versions of the GD perl module won't work for you. + + + + + CPAN Download Page: + PPM Download Link: + Documentation: +
-
- Chart::Base (optional) +
+ Chart::Base (&min-chart-base-ver;) [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 from CPAN. Note that earlier versions that 0.99c used GIFs, which are no longer supported by the latest versions of GD. + + + + CPAN Download Page: + PPM Download Link: +
- -
- Template Toolkit - When you install Template Toolkit, you'll get asked various - questions about features to enable. The defaults are fine, except - that it is recommended you use the high speed XS Stash of the Template - Toolkit, in order to achieve best performance. +
+ XML::Parser (&min-xml-parser-ver;) [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). XML::Parser requires that the + expat library is already installed on your machine. -
- + + + CPAN Download Page: + Documentation: + +
+ +
+ GD::Graph (&min-gd-graph-ver;) [Optional] + + In addition to GD listed above, the reporting interface of Bugzilla + needs to have the GD::Graph module installed. + + + + CPAN Download Page: + PPM Download Link: + Documentation: + +
+ +
+ GD::Text::Align (&min-gd-text-align-ver;) [Optional] + + GD::Text::Align, as the name implies, is used to draw aligned + strings of text. It is needed by the reporting interface. + + + + CPAN Download Page: + PPM Download Page: + Documentation: + +
+ +
+ MIME::Parser (&min-mime-parser-ver;) [Optional] + + MIME::Parser is only needed if you want to use the e-mail interface + located in the contrib directory. + + + + CPAN Download Page: + PPM Download Link: + Documentation: + +
-
+
HTTP Server You have freedom of choice here, pretty much any web server that @@ -490,12 +650,13 @@ 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. + please share your experiences with us by filing a bug in &bzg-bugs;. +
-
+
Bugzilla You should untar the Bugzilla files into a directory that you're @@ -522,94 +683,63 @@ until you run the post-install checksetup.pl script, which locks down your installation. + + + The default Bugzilla distribution is not designed to be placed + in a cgi-bin directory (this + includes any directory which is configured using the + directive of Apache). This will probably + change as part of + bug + 44659. + +
-
+
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. + This first thing you'll want to do is make sure you've given the + root user a password as suggested in + . 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. - 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). + + Most people use bugs for both the user and + database name. + + Next, we use an SQL GRANT command to create a - bugs - + bugs_user user, and grant sufficient permissions for checksetup.pl, which we'll use later, to work its magic. This also restricts the - bugs + bugs_user user to operations within a database called - bugs, and only allows the account to connect from + 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. - 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; - - - - + +mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE, + DROP,REFERENCES ON bugs_db.* TO bugs_user@localhost + IDENTIFIED BY 'bugs_password'; +mysql> FLUSH PRIVILEGES; + If you are using MySQL 4, the bugs user also needs to be granted - the LOCK TABLES and CREATE TEMPORARY TABLES permissions. + the LOCK TABLES and + CREATE TEMPORARY TABLES permissions.
@@ -622,22 +752,20 @@ 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 + This script 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 - - - + +bash# ./checksetup.pl + + The first time you run it, it will create a file called localconfig. @@ -654,20 +782,20 @@ database name: - bugs + bugs_db if you're following these directions MySQL username: - bugs + bugs_user if you're following these directions Password for the - bugs - MySQL account; (<bugs_password>) above + bugs_user + MySQL account; (bugs_password above) @@ -975,7 +1103,7 @@ bash# perl -pi -e "s/Content-Type\: text\/html/Content-Type\: text\/html\; chars which can limit connections by ip-address. You may download this module at - + . Follow the instructions to install into your Apache install. This module only functions with the Apache web server! @@ -1034,12 +1162,13 @@ bash# perl -pi -e "s/Content-Type\: text\/html/Content-Type\: text\/html\; chars
-
+
Perl Modules on Win32 Bugzilla on Windows requires the same perl modules found in - . The main difference is that - windows uses ppm instead of CPAN. + . The main difference is that + windows uses PPM instead of + CPAN. @@ -1211,7 +1340,7 @@ my $webservergid = '8' bash# urpmi perl-mysql bash# urpmi perl-chart bash# urpmi perl-gd -bash# urpmi perl-MailTools +bash# urpmi perl-MailTools bash# urpmi apache-modules -- cgit v1.2.3-24-g4f1b