BugsSite/QUICKSTART

   1 Bugzilla Quick Start Guide
   2 ==========================
   3 (or, how to get Bugzilla up and running in 10 steps)
   4 Christian Reis <kiko@async.com.br>
   5
   6 This express installation guide is for "normal" Bugzilla installations,
   7 which means a Linux or Unix system on which Apache, Perl, MySQL or PostgreSQL
   8 and a Sendmail compatible MTA are available. For other configurations, please
   9 see Section 4 of the Bugzilla Guide in the docs/ directory.
  10
  11 1. Decide from which URL and directory under your webserver root you
  12    will be serving the Bugzilla webpages.
  13
  14 2. Unpack the distribution into the chosen directory (there is no copying or
  15    installation involved).
  16
  17 3. Run ./checksetup.pl, look for unsolved requirements, and install them.
  18    You can run checksetup as many times as necessary to check if
  19    everything required has been installed.
  20
  21    These will usually include assorted Perl modules, MySQL or PostgreSQL,
  22    and a MTA.
  23
  24    After a successful dependency check, checksetup should complain that
  25    localconfig needs to be edited.
  26
  27 4. Edit the localconfig file, in particular the $webservergroup and
  28    $db_* variables. In particular, $db_name and $db_user will define
  29    your database setup in step 5.
  30
  31 5. Using the name you provided as $db_name above, create a MySQL database
  32    for Bugzilla. You should also create a user permission for the name
  33    supplied as $db_user with read/write access to that database.
  34
  35    If you are not familiar with MySQL permissions, it's a good idea to
  36    use the mysql_setpermission script that is installed with the MySQL
  37    distribution, and be sure to read Bugzilla Security - MySQL section
  38    in the Bugzilla Guide or PostgreSQL documentation.
  39
  40 6. Run checksetup.pl once more; if all goes well, it should set up the
  41    Bugzilla database for you. If not, return to step 5.
  42
  43    checksetup.pl should ask you, this time, for the administrator's
  44    email address and password. These will be used for the initial
  45    Bugzilla administrator account.
  46
  47 7. Configure Apache (or install and configure, if you don't have it up
  48    yet) to point to the Bugzilla directory. You should enable and
  49    activate mod_cgi, and add the configuration entries
  50
  51         Options +ExecCGI
  52         AllowOverride Limit
  53         DirectoryIndex index.cgi
  54
  55    to your Bugzilla <Directory> block. You may also need
  56
  57         AddHandler cgi-script .cgi
  58
  59    if you don't have that in your Apache configuration file yet.
  60
  61 8. Visit the URL you chose for Bugzilla. Your browser should display the
  62    default Bugzilla home page. You should then log in as the
  63    administrator by following the "Log in" link and supplying the
  64    account information you provided in step 6.
  65
  66 9. Scroll to the bottom of the page after logging in, and select
  67    "Parameters". Set up the relevant parameters for your local setup.
  68
  69    See section 4.2 of the Bugzilla Guide for a in-depth description of
  70    some of the configuration parameters available.
  71
  72 10. That's it. If anything unexpected comes up:
  73
  74     - read the error message carefully,
  75     - backtrack through the steps above,
  76     - check the official installation guide, which is section 4 in the
  77       Bugzilla Guide, included in the docs/ directory in various
  78       formats.
  79
  80 Support and installation questions should be directed to the
  81 mozilla-webtools@mozilla.org mailing list -- don't write to the
  82 developer mailing list: your post *will* be ignored if you do.
  83
  84 Further support information is at http://www.bugzilla.org/support/