ddkilzer@apple.com | 5777284 | 2014-10-16 16:00:58 +0000 | [diff] [blame^] | 1 | What is Bugzilla? |
| 2 | ================= |
| 3 | Bugzilla is a free bug-tracking system that is developed by an active |
| 4 | community of volunteers in the Mozilla community. You can install and |
| 5 | use it without having to pay any license fee. |
timothy@apple.com | f42518d | 2008-02-06 20:19:16 +0000 | [diff] [blame] | 6 | |
ddkilzer@apple.com | 5777284 | 2014-10-16 16:00:58 +0000 | [diff] [blame^] | 7 | Minimum requirements |
| 8 | ==================== |
| 9 | It can be installed on Windows, Mac OS X, Linux and other Unix flavors. |
| 10 | Bugzilla is written in Perl, meaning that Perl must be installed on your system. |
| 11 | You will also need a web server as well as a DB server (see below). |
timothy@apple.com | f42518d | 2008-02-06 20:19:16 +0000 | [diff] [blame] | 12 | |
ddkilzer@apple.com | 5777284 | 2014-10-16 16:00:58 +0000 | [diff] [blame^] | 13 | Installation & Upgrading |
| 14 | ======================== |
| 15 | The documentation to install, upgrade, configure and use Bugzilla can be found |
| 16 | in 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.com | f42518d | 2008-02-06 20:19:16 +0000 | [diff] [blame] | 20 | |
ddkilzer@apple.com | 5777284 | 2014-10-16 16:00:58 +0000 | [diff] [blame^] | 21 | If the documentation is missing, you can get it online by visiting |
| 22 | http://www.bugzilla.org/docs/ from where you can select the documentation |
| 23 | corresponding to the Bugzilla version you are installing. |
timothy@apple.com | f42518d | 2008-02-06 20:19:16 +0000 | [diff] [blame] | 24 | |
ddkilzer@apple.com | 5777284 | 2014-10-16 16:00:58 +0000 | [diff] [blame^] | 25 | Bugzilla Quick Start Guide |
| 26 | ========================== |
| 27 | (or, how to get Bugzilla up and running in 10 steps) |
| 28 | Christian Reis <kiko@async.com.br> |
timothy@apple.com | f42518d | 2008-02-06 20:19:16 +0000 | [diff] [blame] | 29 | |
ddkilzer@apple.com | 5777284 | 2014-10-16 16:00:58 +0000 | [diff] [blame^] | 30 | This express installation guide is for "normal" Bugzilla installations, |
| 31 | which means a Linux or Unix system on which Apache, Perl, MySQL or PostgreSQL |
| 32 | and a Sendmail compatible MTA are available. For other configurations, please |
| 33 | see the "Installing Bugzilla" section of the Bugzilla Guide in the docs/ directory. |
| 34 | |
| 35 | 1. Decide from which URL and directory under your webserver root you |
| 36 | will be serving the Bugzilla webpages. |
| 37 | |
| 38 | 2. Unpack the distribution into the chosen directory (there is no copying or |
| 39 | installation involved). |
| 40 | |
| 41 | 3. 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 | |
| 51 | 4. 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 | |
| 55 | 5. 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 | |
| 63 | 6. 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 | |
| 70 | 7. 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 | |
| 75 | 8. 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 | |
| 80 | 9. Visit the "Parameters" page, as suggested by the page displayed to you. |
| 81 | Set up the relevant parameters for your local setup. |
| 82 | |
| 83 | 10. 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 | |
| 89 | Support and installation questions should be directed to the |
| 90 | support-bugzilla@lists.mozilla.org mailing list. |
| 91 | |
| 92 | Further support information is at http://www.bugzilla.org/support/ |