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 (this is easiest if the bug system can write
  21    directly to the webspace).
  22  - Somewhere to run CGI scripts (unless you don't need the web forms for
  23    searching for bugs by number, package, maintainer or submitter).
  24
  25 =============================================================================
  26 INSTALLATION INSTRUCTIONS
  27 =============================================================================
  28
  29 Install the Debian package and read /usr/share/doc/debbugs/README.Debian file.
  30
  31 If you can't use the .deb, do the following:
  32
  33 1. Run "make install" from the source directory.
  34
  35 2. Edit the config files in /etc/debbugs/ directory to suit your needs.
  36
  37 3. Set up the mail arrangements to deliver mail to the right place, and to
  38 set up a blackhole mail alias if you need one.  Ensure that owner@bugs, the
  39 address of the BTS owner, if that's what you're using, is handled by the MTA.
  40 All other email should be piped into the receive script.
  41
  42 4. Set up your HTTP server to point people looking for bug reports to
  43 /var/lib/debbugs/www and set /var/lib/debbugs/www/cgi as a valid CGI
  44 directory.
  45
  46 5. Test things a bit, by sending mail messages to the bug system and
  47 running .../scripts/processall and/or .../scripts/update-html.
  48
  49 6. If all seems well then install the crontab from
  50 /usr/share/doc/debbugs/examples/crontab.
  51
  52 Notes:
  53
  54 Each line of /etc/debbugs/Maintainers file needs to be formatted like
  55 this: "package       maintainer name <e-mail@address>".
  56
  57 If you need a template, look in /usr/share/doc/debbugs/examples/ directory.
  58
  59 =============================================================================
  60 FURTHER INFORMATION
  61 =============================================================================
  62 Web:  http://benham.net/debbugs/
  63 Email: debbugs@benham.net (mailing list)
  64        debbugs-REQUEST@benham.net with the word subscribe in the body
  65
  66 =============================================================================
  67 COPYRIGHT AND LACK-OF-WARRANTY NOTICE
  68 =============================================================================
  69 Copyright 1999 Darren O. Benham <gecko@debian.org>
  70 Copyright 1994,1995,1996,1997 Ian Jackson <ijackson@chiark.greenend.org.uk>
  71 Copyright 1997 nCipher Corporation Limited
  72 Copyright 1995 Steven Brenner (for cgi-lib.pl).
  73
  74 This bug system is free software; you can redistribute it and/or modify it
  75 under the terms of the GNU General Public License as published by the Free
  76 Software Foundation; version 2 of the License.
  77
  78 This program and documentation is distributed in the hope that it will be
  79 useful, but without any warranty; without even the implied warranty of
  80 merchantability or fitness for a particular purpose. See the GNU General
  81 Public License for more details.
  82
  83 You should have received a copy of the GNU General Public License along
  84 with this program, or one should be available above; if not, write to the
  85 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  86 02111-1307, USA.
  87
  88  - Darren Benham 14 Oct, 1999