README

   1                      debbugs, Debian bug tracking system
   2                      -----------------------------------
   3
   4 This bug tracking system was developed by Ian Jackson from 1994-1997,
   5 with assistance from nCipher Corporation Limited in 1997.  nCipher allowed
   6 Ian to redistribute modifications he made to the system while working as an
   7 employee of nCipher.
   8
   9 Since then, it has been developed by the various administrators of
  10 bugs.debian.org, including Darren Benham, Adam Heath, Josip Rodin, Anthony
  11 Towns, and Colin Watson.  As in the case of Ian, nCipher allowed Colin to
  12 redistribute modifications he made while working as an employee of nCipher.
  13
  14 =============================================================================
  15 SYSTEM REQUIREMENTS
  16 =============================================================================
  17
  18  - GNU date
  19  - GNU gzip
  20  - Perl 5 (5.005 is known to work)
  21  - Mailtools and MIME-tools perl modules to manipulate email
  22  - Lynx 2.7 or later
  23  - The bug system requires its own mail domain.  It comes with code
  24    which understands how exim, qmail and sendmail deliver mail for such a
  25    domain to a script.
  26  - A webserver.  For the old system of static HTML pages generated for
  27    bug reports and index pages, this is easiest if the bug system can
  28    write directly to the webspace; for the new system of CGI scripts
  29    that generate web pages on the fly, write access is not required.
  30  - Somewhere to run CGI scripts (unless you don't need the web forms for
  31    searching for bugs by number, package, maintainer or submitter).
  32
  33 =============================================================================
  34 INSTALLATION INSTRUCTIONS
  35 =============================================================================
  36
  37 Install the Debian package and read /usr/share/doc/debbugs/README.Debian file.
  38
  39 If you can't use the .deb, do the following:
  40
  41 1. Run "make install" from the source directory.
  42
  43 2. Edit the config files in /etc/debbugs/ directory to suit your needs.
  44 Re-run debbugsconfig when you're finished to regenerate the
  45 documentation.
  46
  47 3. Set up the mail arrangements to deliver mail to the right place, and to
  48 set up a blackhole mail alias if you need one.  Ensure that owner@bugs, the
  49 address of the BTS owner, if that's what you're using, is handled by the MTA.
  50 All other email should be piped into the receive script.
  51
  52 4. Set up your HTTP server to point people looking for bug reports to
  53 /var/lib/debbugs/www and set /var/lib/debbugs/www/cgi as a valid CGI
  54 directory.
  55
  56 5. Test things a bit, by sending mail messages to the bug system and
  57 running /usr/lib/debbugs/processall and/or /usr/lib/debbugs/rebuild.
  58 The latter updates index files used by the CGI scripts.  If you're
  59 feeling brave, you can link /var/lib/debbugs/spool/index.db to
  60 index.db.realtime and .../index.archive to index.archive.realtime to
  61 remove the need for the rebuild script; this is still semi-experimental.
  62
  63 6. If all seems well then install the crontab from
  64 /usr/share/doc/debbugs/examples/crontab.
  65
  66 Notes:
  67
  68 Each line of /etc/debbugs/Maintainers file needs to be formatted like
  69 this: "package       maintainer name <e-mail@address>".
  70
  71 If you need a template, look in /usr/share/doc/debbugs/examples/ directory.
  72
  73 =============================================================================
  74 FURTHER INFORMATION
  75 =============================================================================
  76
  77 Email: debian-debbugs@lists.debian.org (mailing list)
  78        To subscribe, email debian-debbugs-request@lists.debian.org
  79        with the word "subscribe" in the subject line
  80 Outdated web site: http://benham.net/debbugs/
  81
  82 =============================================================================
  83 COPYRIGHT AND LACK-OF-WARRANTY NOTICE
  84 =============================================================================
  85
  86 Copyright 1999 Darren O. Benham
  87 Copyright 1994-1997 Ian Jackson
  88 Copyright 1997,2003 nCipher Corporation Limited
  89
  90 This bug system is free software; you can redistribute it and/or modify it
  91 under the terms of the GNU General Public License as published by the Free
  92 Software Foundation; version 2 of the License.
  93
  94 This program and documentation is distributed in the hope that it will be
  95 useful, but without any warranty; without even the implied warranty of
  96 merchantability or fitness for a particular purpose. See the GNU General
  97 Public License for more details.
  98
  99 You should have received a copy of the GNU General Public License along
 100 with this program, or one should be available above; if not, write to the
 101 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 102 02111-1307, USA.