Mercurial > p > roundup > code

annotate doc/index.html @ 252:76c6994aa4e8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
CGI interfaces now spit up a top-level index of all instances they can serve.
author Richard Jones <richard@users.sourceforge.net>
date Sat, 29 Sep 2001 13:27:00 +0000
parents 2f4123c715f1
children 5973f1d80ace
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
251
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 <html><head>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2 <title>Roundup: an Issue-Tracking System for Knowledge Workers</title>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3 </head><body>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
5 <h1 align=center>Roundup</h1>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6 <h3 align=center>An Issue-Tracking System for Knowledge Workers</h3>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8 <h2>Contents</h2>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
10 <ul>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
11 <li><a href="overview.html">Overview</a> (Initial submission to SC Track)
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
12 <li><a href="#installation">Installation</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
13 <ul>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
14 <li><a href="#requires">Prerequisites</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
15 <li><a href="#getting">Getting Roundup</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
16 <li><a href="#installing">Installing Roundup</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
17 </ul>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
18 <li><a href="#starting">Getting Started</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
19 <ul>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
20 <li><a href="#instance">The Instance</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
21 <li><a href="#startcmd">Command Line Tool</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
22 <li><a href="#startweb">E-Mail Interface</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
23 <li><a href="#startweb">Web Interface</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
24 <li><a href="#users">Users</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
25 <li><a href="#issues">Issues</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
26 </ul>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
27 <li><a href="#admin">Administration</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
28 <ul>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
29 <li><a href="#cmd">Command Line Tool</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
30 <li><a href="#web">Web Interface</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
31 <li><a href="#mail">E-Mail Gateway</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
32 </ul>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
33 <li><a href="spec.html">Roundup's Design Document</a> ("Implementation Guide")
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
34 <li><a href="#ack">Acknowledgements</a>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
35 </ul>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
36
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
37 <p><hr>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
38 <h2><a name="installation">Installation</a></h2>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
39
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
40
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
41 <h3><a name="requires">Prerequisites</a></h3>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
42
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
43 <dl>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44 <dt>Either:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
45 <dd>Python 2.0 with pydoc installed. See http://www.lfw.org/ for pydoc.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
46 <dt>or
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
47 <dd>Python 2.1 or later
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
48 </dl>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
49
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
50 Download the latest version from
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
51 <a href="http://www.python.org/">http://www.python.org/</a>.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
52
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
53
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
54
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
55 <h3><a name="getting">Getting Roundup</a></h3>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
56
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
57 Download the latest version from
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
58 <a href="http://roundup.sf.net/">http://roundup.sf.net/</a>.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
59
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
60
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
61 <h3><a name="installing">Installing Roundup</a></h3>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
62
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
63 <ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
64 <li>Run:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
65 <br><tt>python setup.py install</tt>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
66 <li>If you would prefer the scripts installed in somewhere other than
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
67 <tt>/usr/local/bin</tt>, add <tt>"--install-scripts=&lt;dir&gt;"</tt>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
68 to the command:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
69 <br><tt>python setup.py install --install-scripts=&lt;dir&gt;</tt>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
70 <li>The command:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
71 <br><tt>python setup.py install --help</tt>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
72 <br>gives all the options available for installation.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
73 </ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
74
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
75
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
76 <p><hr>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
77 <h2><a name="starting">Getting Started</a></h2>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
78
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
79 The following instructions assume that you have installed roundup. If you
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
80 haven't, you may still proceed - just preface all commands with "./"
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
81 ie. "./roundup-admin init".
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
82
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
83
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
84 <h3><a name="instance">The Instance</a></h3>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
85
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
86 We'll be referring to the term "instance" a lot from now on. An instance is
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
87 a directory in your filesystem that is where all the information about a
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
88 live issue tracker database is stored. The data that is entered as issues,
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
89 the users who access the database and the definition of the database itself
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
90 all reside there:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
91 <ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
92 <li><strong>Hyperdatabase</strong>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
93 <br>This is the lowest component of Roundup and is where all the
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
94 issues, users, file attachments and messages are stored.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
95 <li><strong>Database schema</strong>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
96 <br>This describes the content of the hyperdatabase - what fields are
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
97 stored for issues, what user information, etc. Being stored in the
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
98 instance, this allows it to be customised for a particular application.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
99 It also means that changes in the Roundup core code do not affect a
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
100 running instance.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
101 <li><strong>Web Interface</strong>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
102 <br>The web interface templates are defined in the instance too - and
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
103 the actual CGI interface class is defined (mostly using base classes in
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
104 the Roundup core code) so it, like the database, may be customised for
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
105 each instance in use.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
106 </ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
107
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
108 Instances are created using the <tt>roundup-admin</tt> tool.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
109
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
110 <h3><a name="startcmd">Command Line Tool</a></h3>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
111
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
112 To initiliase a new instance, run <tt>roundup-admin init</tt>. You will be
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
113 asked a series of questions:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
114
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
115 <ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
116 <li>Instance home directory
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
117 <li>Schema to use
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
118 <li>Database back-end to use
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
119 <li>Administration user "admin" password.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
120 </ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
121
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
122 Roundup is configurable using a localconfig.py file in the instance home.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
123 It may have the following variable declarations:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
124
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
125 <ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
126 <li>MAILHOST
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
127 <br>The SMTP mail host that roundup will use to send mail
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
128 <li>MAIL_DOMAIN
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
129 <br>The domain name used for email addresses
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
130 </ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
131
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
132 Any further configuration should be possible by editing the instance home's
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
133 __init__.py directly.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
134 <p>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
135 The email addresses used by the system by default are:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
136
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
137 <ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
138 <li>issue_tracker@MAIL_DOMAIN
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
139 <br>submissions of issues
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
140 <li>roundup-admin@MAIL_DOMAIN
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
141 <br>roundup's internal use (problems, etc)
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
142 </ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
143
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
144 <em>Note:</em>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
145 We run the instance as group "issue_tracker" and add the mail and web user
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
146 ("mail" and "apache" on our RedHat 7.1 system) to that group, as well as
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
147 any admin people.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
148
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
149
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
150 <h3><a name="startweb">E-Mail Interface</a></h3>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
151 Set up a mail alias called "issue_tracker" as:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
152 <blockquote>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
153 <tt>|/usr/bin/python /usr/local/bin/roundup-mailgw
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
154 &lt;instance_home&gt;</tt>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
155 </blockquote>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
156
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
157 In some installations (e.g. RedHat 6.2 I think) you'll need to set up smrsh
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
158 so sendmail will accept the pipe command. In that case, symlink
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
159 /etc/smrsh/roundup-mailgw to /usr/local/bin/roundup-mailgw and change the
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
160 command to:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
161 <blockquote>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
162 <tt>|roundup-mailgw &lt;instance_home&gt;</tt>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
163 </blockquote>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
164
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
165 To test the mail gateway on unix systems, try:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
166
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
167 <blockquote>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
168 <tt>echo test |mail -s '[issue] test' issue_tracker@your.domain</tt>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
169 </blockquote>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
170
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
171
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
172
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
173 <h3><a name="startweb">Web Interface</a></h3>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
174 This software will work through apache or stand-alone.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
175 <p>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
176 <strong>Stand-alone:</strong>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
177 <ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
178 <li>Edit roundup-server at the top - ROUNDUP_INSTANCE_HOMES needs to know
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
179 about your instance. *** command-line option
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
180 <li><tt>roundup-server [hostname port]</tt> (hostname may be "")
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
181 <li>Load up the page <tt>/&lt;instance name&gt;/index</tt> where
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
182 instance name is the
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
183 name you nominated in <tt>ROUNDUP_INSTANCE_HOMES</tt>.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
184 *** command-line option
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
185 </ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
186
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
187 <strong>Apache:</strong>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
188 <ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
189 <li>Make sure roundup.cgi is executable. Edit it at the top -
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
190 ROUNDUP_INSTANCE_HOMES needs to know about your instance.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
191 <li>Edit your <tt>/etc/httpd/conf/httpd.conf</tt> and make sure that the
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
192 <tt>/home/httpd/html/roundup/roundup.cgi</tt> script will be treated as a CGI
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
193 script.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
194 <li>Add the following to your <tt>/etc/httpd/conf/httpd.conf</tt>:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
195 <pre>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
196 ------8<------- snip here ------8<-------
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
197 RewriteEngine on
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
198 RewriteCond %{HTTP:Authorization} ^(.*)
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
199 RewriteRule ^/roundup/roundup.cgi(.*) /home/httpd/html/roundup/roundup.cgi$1 [e=HTTP_CGI_AUTHORIZATION:%1,t=application/x-httpd-cgi,l]
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
200 ------8<------- snip here ------8<-------
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
201 </pre>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
202 note: the RewriteRule must be on one line - no breaks
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
203 <li>Re-start your apache to re-load the config
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
204 <li>Load up the page <tt>/roundup/roundup.cgi/&lt;instance name&gt;/index</tt> where
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
205 instance name is the name you nominated in ROUNDUP_INSTANCE_HOMES.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
206 </ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
207
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
208
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
209 <h3><a name="users">Users</a></h3>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
210 To add users, use one of the following interfaces:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
211
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
212 <ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
213 <li>On the web, access the URL <tt>.../&lt;instance name&gt;/newuser</tt>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
214 to bring up a form which may be used to add a new user.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
215 <li>On the command-line, use:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
216 <br><tt>roundup-admin -i &lt;instance home&gt; create user
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
217 username=bozo password=bozo address=richard@clown.org</tt>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
218 <br>Supply the admin username and password. roundup-admin will print the
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
219 id of the new user.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
220 <li>Any e-mail sent to roundup from an address that doesn't match an
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
221 existing user in the database will result in a new user entry being
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
222 created for that user.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
223 </ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
224
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
225
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
226
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
227 <h3><a name="issues">Issues</a></h3>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
228 To add issues, use one of the following interfaces:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
229
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
230 <ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
231 <li>On the web, access the URL <tt>.../&lt;instance name&gt;/newissue</tt>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
232 to bring up a form which may be used to add a new issue.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
233 <li>On the command-line, use:
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
234 <br><tt>roundup-admin -i &lt;instance home&gt; create issue
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
235 title="test issue"</tt>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
236 <br>Supply the admin username and password. roundup-admin will print the
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
237 id of the new issue.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
238 <li>Any e-mail sent to roundup with the subject line containing [issue]
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
239 will automatically created a new issue in the database using the
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
240 contents of the e-mail.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
241 </ol>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
242
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
243 <p><hr>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
244 <h2><a name="ack">Acknowledgements</a></h2>
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
245
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
246 Go Ping, you rock! Also, go Bizar Software for letting me implement this
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
247 system on their time.
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
248
2f4123c715f1 Started working on some _real_ documentation!
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
249 </body></html>
Roundup Issue Tracker: http://roundup-tracker.org/