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