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