Mercurial > p > roundup > code

comparison doc/index.html @ 469:d35e51360175

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mention POP interface
author Richard Jones <richard@users.sourceforge.net>
date Mon, 31 Dec 2001 03:07:04 +0000
parents b579418f7ed1
children 8298fea69bc3 c242455d9b46
comparison
equal deleted inserted replaced
468:fc44c590d4a1 469:d35e51360175
17 </ul> 17 </ul>
18 <li><a href="#starting">Getting Started</a> 18 <li><a href="#starting">Getting Started</a>
19 <ul> 19 <ul>
20 <li><a href="#instance">The Instance</a> 20 <li><a href="#instance">The Instance</a>
21 <li><a href="#startcmd">Command Line Tool</a> 21 <li><a href="#startcmd">Command Line Tool</a>
22 <li><a href="#startweb">E-Mail Interface</a> 22 <li><a href="#startmail">E-Mail Interface</a>
23 <li><a href="#startweb">Web Interface</a> 23 <li><a href="#startweb">Web Interface</a>
24 <li><a href="#users">Users and Access Control</a> (Users and permissions, Adding users) 24 <li><a href="#users">Users and Access Control</a> (Users and permissions, Adding users)
25 <li><a href="#issues">Issues</a> 25 <li><a href="#issues">Issues</a>
26 </ul> 26 </ul>
27 <li><a href="#guide">User Guide</a> 27 <li><a href="#guide">User Guide</a>
154 <br>submissions of issues 154 <br>submissions of issues
155 <li>ADMIN_EMAIL - roundup-admin@MAIL_DOMAIN 155 <li>ADMIN_EMAIL - roundup-admin@MAIL_DOMAIN
156 <br>roundup's internal use (problems, etc) 156 <br>roundup's internal use (problems, etc)
157 </ol> 157 </ol>
158 158
159 <h2><a name="startweb">E-Mail Interface</a></h2> 159 <h2><a name="startmail">E-Mail Interface</a></h2>
160 160
161 <h3>Setup 1: As a mail alias pipe process</h3> 161 <h3>Setup 1: As a mail alias pipe process</h3>
162 Set up a mail alias called "issue_tracker" as (include the quote marks): 162 Set up a mail alias called "issue_tracker" as (include the quote marks):
163 <blockquote> 163 <blockquote>
164 <tt>"|/usr/bin/python /usr/local/bin/roundup-mailgw &lt;instance_home&gt;"</tt> 164 <tt>"|/usr/bin/python /usr/local/bin/roundup-mailgw &lt;instance_home&gt;"</tt>
177 <blockquote> 177 <blockquote>
178 <tt>echo test |mail -s '[issue] test' issue_tracker@your.domain</tt> 178 <tt>echo test |mail -s '[issue] test' issue_tracker@your.domain</tt>
179 </blockquote> 179 </blockquote>
180 180
181 181
182 <h3>Setup 2: As a regular cron job</h3> 182 <h3>Setup 2: As a regular cron job using a mailbox source</h3>
183
184 Set the roundup-mailgw up to run every 10 minutes or so. For example: 183 Set the roundup-mailgw up to run every 10 minutes or so. For example:
185 <blockquote> 184 <blockquote>
186 <tt>10 * * * * /usr/local/bin/roundup-mailgw &lt;instance_home&gt; &lt;mail_spool_file&gt;</tt> 185 <tt>10 * * * * /usr/local/bin/roundup-mailgw &lt;instance_home&gt; mailbox &lt;mail_spool_file&gt;</tt>
187 </blockquote> 186 </blockquote>
188
189 Where the mail_spool_file argument is the location of the roundup 187 Where the mail_spool_file argument is the location of the roundup
190 submission user's mail spool. On most systems, the spool for a user 188 submission user's mail spool. On most systems, the spool for a user
191 "issue_tracker" will be "/var/mail/issue_tracker". 189 "issue_tracker" will be "/var/mail/issue_tracker".
192 190
191 <h3>Setup 3: As a regular cron job using a POP source</h3>
192 To retrieve from a POP mailbox, use a similar cron entry to the mailbox
193 one:
194 <blockquote>
195 <tt>10 * * * * /usr/local/bin/roundup-mailgw &lt;instance_home&gt; pop &lt;pop_spec&gt;</tt>
196 </blockquote>
197 where pop_spec is "username:password@server" that specifies the roundup
198 submission user's POP account name, password and server.
193 199
194 <h2><a name="startweb">Web Interface</a></h2> 200 <h2><a name="startweb">Web Interface</a></h2>
195 This software will work through apache or stand-alone. 201 This software will work through apache or stand-alone.
196 <p> 202 <p>
197 <strong>Stand-alone:</strong> 203 <strong>Stand-alone:</strong>
198 <ol> 204 <ol>
199 <li>Edit roundup-server at the top - ROUNDUP_INSTANCE_HOMES needs to know 205 <li>Edit roundup-server at the top - ROUNDUP_INSTANCE_HOMES needs to know
200 about your instance. *** command-line option 206 about your instance. You may also specify the values for
207 ROUNDUP_INSTANCE_HOMES on the command-line using "name=home" pairs.
201 <li><tt>roundup-server [hostname port]</tt> (hostname may be "") 208 <li><tt>roundup-server [hostname port]</tt> (hostname may be "")
202 <li>Load up the page <tt>/&lt;instance name&gt;/index</tt> where 209 <li>Load up the page <tt>/&lt;instance name&gt;/index</tt> where
203 instance name is the 210 instance name is the
204 name you nominated in <tt>ROUNDUP_INSTANCE_HOMES</tt>. 211 name you nominated in <tt>ROUNDUP_INSTANCE_HOMES</tt>.
205 *** command-line option
206 </ol> 212 </ol>
207 213
208 <strong>Apache:</strong> 214 <strong>Apache:</strong>
209 <ol> 215 <ol>
210 <li>The CGI script is found in the cgi-bin directory of the roundup 216 <li>The CGI script is found in the cgi-bin directory of the roundup
1277 Go Ping, you rock! Also, go Bizar Software for letting me implement this 1283 Go Ping, you rock! Also, go Bizar Software for letting me implement this
1278 system on their time. 1284 system on their time.
1279 1285
1280 <p>&nbsp;</p> 1286 <p>&nbsp;</p>
1281 <hr> 1287 <hr>
1282 $Id: index.html,v 1.22 2001-12-17 03:52:47 richard Exp $ 1288 $Id: index.html,v 1.23 2001-12-31 03:07:04 richard Exp $
1283 <p>&nbsp;</p> 1289 <p>&nbsp;</p>
1284 1290
1285 </body></html> 1291 </body></html>
1286 1292
Roundup Issue Tracker: http://roundup-tracker.org/