blob: 041aebc13d305988a9dbe4f268e1126fe68982d4 [file] [log] [blame]
ddkilzer@apple.com57772842014-10-16 16:00:58 +00001What is Bugzilla?
2=================
3Bugzilla is a free bug-tracking system that is developed by an active
4community of volunteers in the Mozilla community. You can install and
5use it without having to pay any license fee.
timothy@apple.comf42518d2008-02-06 20:19:16 +00006
ddkilzer@apple.com57772842014-10-16 16:00:58 +00007Minimum requirements
8====================
9It can be installed on Windows, Mac OS X, Linux and other Unix flavors.
10Bugzilla is written in Perl, meaning that Perl must be installed on your system.
11You will also need a web server as well as a DB server (see below).
timothy@apple.comf42518d2008-02-06 20:19:16 +000012
ddkilzer@apple.com57772842014-10-16 16:00:58 +000013Installation & Upgrading
14========================
15The documentation to install, upgrade, configure and use Bugzilla can be found
16in different formats:
17* docs/en/html/Bugzilla-Guide.html (HTML version)
18* docs/en/txt/Bugzilla-Guide.txt (text version)
19* docs/en/pdf/Bugzilla-Guide.pdf (PDF version)
timothy@apple.comf42518d2008-02-06 20:19:16 +000020
ddkilzer@apple.com57772842014-10-16 16:00:58 +000021If the documentation is missing, you can get it online by visiting
22http://www.bugzilla.org/docs/ from where you can select the documentation
23corresponding to the Bugzilla version you are installing.
timothy@apple.comf42518d2008-02-06 20:19:16 +000024
ddkilzer@apple.com57772842014-10-16 16:00:58 +000025Bugzilla Quick Start Guide
26==========================
27(or, how to get Bugzilla up and running in 10 steps)
28Christian Reis <kiko@async.com.br>
timothy@apple.comf42518d2008-02-06 20:19:16 +000029
ddkilzer@apple.com57772842014-10-16 16:00:58 +000030This express installation guide is for "normal" Bugzilla installations,
31which means a Linux or Unix system on which Apache, Perl, MySQL or PostgreSQL
32and a Sendmail compatible MTA are available. For other configurations, please
33see the "Installing Bugzilla" section of the Bugzilla Guide in the docs/ directory.
34
351. Decide from which URL and directory under your webserver root you
36 will be serving the Bugzilla webpages.
37
382. Unpack the distribution into the chosen directory (there is no copying or
39 installation involved).
40
413. Run ./checksetup.pl, look for unsolved requirements, and install them.
42 You can run checksetup as many times as necessary to check if
43 everything required has been installed.
44
45 These will usually include assorted Perl modules, MySQL or PostgreSQL,
46 and a MTA.
47
48 After a successful dependency check, checksetup should complain that
49 localconfig needs to be edited.
50
514. Edit the localconfig file, in particular the $webservergroup and
52 $db_* variables. In particular, $db_name and $db_user will define
53 your database setup in step 5.
54
555. Create a user permission for the name supplied as $db_user with
56 read/write access to the database whose name is given by $db_name.
57
58 If you are not familiar with MySQL permissions, it's a good idea to
59 use the mysql_setpermission script that is installed with the MySQL
60 distribution, and be sure to read Bugzilla Security - MySQL section
61 in the Bugzilla Guide or PostgreSQL documentation.
62
636. Run checksetup.pl once more; if all goes well, it should set up the
64 Bugzilla database for you. If not, return to step 5.
65
66 checksetup.pl should ask you, this time, for the administrator's
67 email address and password. These will be used for the initial
68 Bugzilla administrator account.
69
707. Configure Apache (or install and configure, if you don't have it up
71 yet) to point to the Bugzilla directory. You can choose between
72 mod_cgi and mod_perl. The Bugzilla documentation has detailed information
73 for both modes.
74
758. Visit the URL you chose for Bugzilla. Your browser should display the
76 default Bugzilla home page. You should then log in as the
77 administrator by following the "Log in" link and supplying the
78 account information you provided in step 6.
79
809. Visit the "Parameters" page, as suggested by the page displayed to you.
81 Set up the relevant parameters for your local setup.
82
8310. That's it. If anything unexpected comes up:
84
85 - read the error message carefully,
86 - backtrack through the steps above,
87 - check the official installation guide.
88
89Support and installation questions should be directed to the
90support-bugzilla@lists.mozilla.org mailing list.
91
92Further support information is at http://www.bugzilla.org/support/