README

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