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 perl module 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 `go to
  23    bug' and `go to package' forms to work).
  24
  25 =============================================================================
  26 INSTALLATION INSTRUCTIONS
  27 =============================================================================
  28 1. Install the deb.  If you don't have a deb, consult the file list at the
  29 end of this document.
  30
  31 2. Copy the template files from /usr/share/doc/debbugs/examples to
  32 /etc/debbugs.  Edit the config file, it is necessary.  Edit the text file if
  33 you wish to change some of the text as it gets displayed.
  34
  35 3. Run "debbugsconfig"
  36
  37 4. Edit the /etc/debbugs/Maintainers file in the format of
  38 "package<whitespece>maintianer".
  39
  40 5. Set up the mail arrangements to deliver mail to the right place, and to
  41 set up a blackhole mail alias if you need one.  Ensure that owner@bugs, if
  42 that's what you're using, is handled by the MTA.  All other email should be
  43 piped into the receive script.
  44
  45 6. Set up http to point people looking for bug reports to
  46 /var/lib/debbugs/www and set /var/lib/debbugs/www/cgi as a valid cgi
  47 directory.
  48
  49 7. Test things a bit, by sending mail messages to the bug system and
  50 running .../scripts/processall and/or .../scripts/update-html.
  51
  52 8. If all seems well then install the crontab in `misc/crontab.out'.
  53
  54 =============================================================================
  55 FURTHER INFORMATION
  56 =============================================================================
  57 Web:  http://benham.net/debbugs/
  58 Email: debbugs@benham.net (mailing list)
  59        debbugs-REQUEST@benham.net with the word subscribe in the body
  60
  61 =============================================================================
  62 Filelist of installed files
  63 =============================================================================
  64 ********************config files**
  65 -rw-r--r-- root/root      1293 1999-10-14 13:14:08 ./etc/debbugs/html/Access.html
  66 -rw-r--r-- root/root      6983 1999-10-14 13:14:08 ./etc/debbugs/html/Reporting.html
  67 -rw-r--r-- root/root      7460 1999-10-14 13:14:08 ./etc/debbugs/html/Developer.html
  68 -rw-r--r-- root/root      3394 1999-10-14 13:14:08 ./etc/debbugs/html/index.html
  69 -rw-r--r-- root/root      7608 1999-10-14 13:14:08 ./etc/debbugs/html/server-control.html
  70 -rw-r--r-- root/root      6434 1999-10-14 13:14:08 ./etc/debbugs/html/server-request.html
  71 -rw-r--r-- root/root      3579 1999-10-14 13:14:08 ./etc/debbugs/html/server-refcard.html
  72 -rw-r--r-- root/root         2 1999-10-14 13:14:08 ./etc/debbugs/lynx-cfg
  73 -rw-r--r-- root/root        79 1999-10-14 13:14:08 ./etc/debbugs/Maintainers
  74 -rw-r--r-- root/root        59 1999-10-14 13:14:08 ./etc/debbugs/pseudo-packages.description
  75 ********************scripts**
  76 -rwxr-xr-x root/root       177 1999-10-14 13:14:07 ./usr/lib/debbugs/age-1
  77 -rwxr-xr-x root/root     24471 1999-10-14 13:14:07 ./usr/lib/debbugs/db2html
  78 -rwxr-xr-x root/root      2159 1999-10-14 13:14:07 ./usr/lib/debbugs/expire
  79 -rwxr-xr-x root/root      3925 1999-10-14 13:14:07 ./usr/lib/debbugs/html-install
  80 -rwxr-xr-x root/root      2747 1999-10-14 13:14:07 ./usr/lib/debbugs/mailsummary
  81 -rwxr-xr-x root/root      1621 1999-10-14 13:14:07 ./usr/lib/debbugs/processall
  82 -rwxr-xr-x root/root     25566 1999-10-14 13:14:08 ./usr/lib/debbugs/service
  83 -rw-r--r-- root/root      2952 1999-10-14 13:14:08 ./usr/lib/debbugs/errorlib
  84 -rwxr-xr-x root/root      3024 1999-10-14 13:14:08 ./usr/lib/debbugs/html-control
  85 -rwxr-xr-x root/root     29290 1999-10-14 13:14:08 ./usr/lib/debbugs/process
  86 -rwxr-xr-x root/root      3664 1999-10-14 13:14:08 ./usr/lib/debbugs/receive
  87 -rwxr-xr-x root/root      3056 1999-10-14 13:14:08 ./usr/lib/debbugs/summary
  88 ********************admin scripts*
  89 -rwxr-xr-x root/root      1958 1999-10-14 13:14:08 ./usr/sbin/debbugsconfig
  90 -rwxr-xr-x root/root       859 1999-10-14 13:14:08 ./usr/sbin/debbugs-maketxt
  91 ********************documentation**
  92 -rw-r--r-- root/root      2390 1999-10-14 13:14:08 ./usr/share/doc/debbugs/examples/config
  93 -rw-r--r-- root/root     11146 1999-10-14 13:14:08 ./usr/share/doc/debbugs/examples/text
  94 -rw-r--r-- root/root       432 1999-10-14 13:14:08 ./usr/share/doc/debbugs/examples/crontab
  95 -rw-r--r-- root/root         3 1999-10-14 13:14:08 ./usr/share/doc/debbugs/examples/nextnumber
  96 -rw-r--r-- root/root       321 1999-04-02 10:12:03 ./usr/share/doc/debbugs/TODO
  97 -rw-r--r-- root/root      1430 1999-04-02 10:08:36 ./usr/share/doc/debbugs/README.Debian
  98 -rw-r--r-- root/root       321 1999-04-02 10:12:03 ./usr/share/doc/debbugs/TODO.Debian
  99 -rw-r--r-- root/root      1419 1999-03-27 11:26:38 ./usr/share/doc/debbugs/copyright
 100 -rw-r--r-- root/root      1977 1999-04-16 17:21:00 ./usr/share/doc/debbugs/README.mail.gz
 101 -rw-r--r-- root/root       812 1999-07-27 11:27:22 ./usr/share/doc/debbugs/changelog.Debian.gz
 102 ********************web/data files
 103 drwxr-xr-x root/root         0 1999-10-14 13:14:08 ./var/lib/debbugs/www/cgi/
 104 -rwxr-xr-x root/root      1807 1999-10-14 13:14:08 ./var/lib/debbugs/www/cgi/bugs-fetch2.pl
 105 -rwxr-xr-x root/root      4755 1999-10-14 13:14:08 ./var/lib/debbugs/www/cgi/cgi-lib.pl
 106 drwxr-xr-x root/root         0 1999-10-14 13:14:08 ./var/lib/debbugs/www/db/
 107 -rw-r--r-- root/root        37 1999-10-14 13:14:08 ./var/lib/debbugs/www/db/.htaccess
 108 drwxr-xr-x root/root         0 1999-10-14 13:14:07 ./var/lib/debbugs/www/txt/
 109 -rw-r--r-- root/root        17 1999-10-14 13:14:08 ./var/lib/debbugs/spool/updateseqs
 110 ********************needed, precreated directories
 111 drwxr-xr-x root/root         0 1999-10-14 13:14:07 ./var/lib/debbugs/indices/
 112 drwxr-xr-x root/root         0 1999-10-14 13:14:07 ./var/lib/debbugs/spool/lock/
 113 drwxr-xr-x root/root         0 1999-10-14 13:14:07 ./var/lib/debbugs/spool/archive/
 114 drwxr-xr-x root/root         0 1999-10-14 13:14:07 ./var/lib/debbugs/spool/incoming/
 115 drwxr-xr-x root/root         0 1999-10-14 13:14:07 ./var/lib/debbugs/spool/db/
 116
 117 =============================================================================
 118 COPYRIGHT AND LACK-OF-WARRANTY NOTICE
 119 =============================================================================
 120 Copyright 1999 Darren O. Benham <gecko@debian.org>
 121 Copyright 1994,1995,1996,1997 Ian Jackson <ijackson@chiark.greenend.org.uk>
 122 Copyright 1997 nCipher Corporation Limited
 123 Copyright 1995 Steven Brenner (for cgi-lib.pl).
 124
 125 This bug system is free software; you can redistribute it and/or modify it
 126 under the terms of the GNU General Public License as published by the Free
 127 Software Foundation; version 2 of the License.
 128
 129 This program and documentation is distributed in the hope that it will be
 130 useful, but without any warranty; without even the implied warranty of
 131 merchantability or fitness for a particular purpose. See the GNU General
 132 Public License for more details.
 133
 134 You should have received a copy of the GNU General Public License along
 135 with this program, or one should be available above; if not, write to the
 136 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 137 02111-1307, USA.
 138
 139  - Darren Benham 14 Oct, 1999