Update of /cvsroot/tmda/tmda/htdocs
In directory sc8-pr-cvs1:/tmp/cvs-serv17449
Modified Files:
tmda-cgi.ht tmda-cgi.html
Log Message:
Web page was getting pretty long so I added an index and anchors.
Added a section on modifying your templates to allow URL confirmation. I know
I added this already but it seems to have disappeared somehow.
As per Jason's instructions, I added a credit to myself and stressed the lists
and newsgroup to contact for help.
Index: tmda-cgi.ht
===================================================================
RCS file: /cvsroot/tmda/tmda/htdocs/tmda-cgi.ht,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- tmda-cgi.ht 7 Dec 2002 04:11:21 -0000 1.8
+++ tmda-cgi.ht 7 Dec 2002 18:21:31 -0000 1.9
@@ -1,8 +1,20 @@
-Title: tmda-cgi HOWTO
+Title: tmda-cgi HOWTO
Links: overview-links.h usage-links.h howto-links.h support-links.h
<h1>tmda-cgi</h1>
+<p><a href="#What">What is it?</a><br>
+ <a href="#Require">Requirements</a><br>
+ <a href="#Blame">Credit, blame, and getting help</a><br>
+ <a href="#Install">Installation</a><br>
+ <a href="#SystemWide">System-wide mode</a><br>
+ <a href="#SingleUser">Single-user mode</a><br>
+ <a href="#nosu">no-su mode</a><br>
+ <a href="#nosuExample">Centralized
+ no-su setup</a><br>
+ <a href="#Pass">Passwords</a><br>
+ <a href="#Config">Configuration</a><br>
+ <a href="#Template">Templates</a></p>
<hr>
-<h2>What is it?</h2>
+<h2><a name="What"></a>What is it?</h2>
<p>tmda-cgi is an alpha-release program for managing your TMDA account over the
web. At the time of this writing, tmda-cgi can:</p>
<ul>
@@ -61,11 +73,40 @@
remember why the rest of my family thinks that e-mail is a pain."
</ul>
<hr>
-<h2>Requirements</h2>
+<h2><a name="Require"></a>Requirements</h2>
<p>TBD. Until we do more testing it isn't clear what systems have problems with
tmda-cgi.</p>
<hr>
-<h2>Installation</h2>
+<h2><a name="Blame" id="Blame"></a>Credit, blame, and getting help</h2>
+<p>As already mentioned, this is contributed software at an alpha-level release.
+ That means:</p>
+<ul>
+ <li>Use at your own risk.
+ <p>That's true of all software in general, but we're telling you up front
+ that not a lot of people have tested or analyzed the code yet. If it goes
+ awry or opens a security hole on your machine, I won't drop dead from the
+ shock.</p>
+ </li>
+ <li>This program wouldn't have been possible without the support and contributions
+ of Jason Mastaler, David Guerizec, Tim Legant, and others on the <a
+href="mailto:[EMAIL PROTECTED]";>tmda-gui</a>
+ and <a href="lists/listinfo/">tmda-workers</a> lists, but they didn't write
+ the actual code itself.
+ <p>When it doesn't work right, be sure you yell out "Damn that <a
+href="mailto:[EMAIL PROTECTED]";>Gre7g
+ Luterman</a>!" because I'm the one responsible for your pain.
+<winks></p>
+ </li>
+ <li>tmda-cgi is discussed some on the <a href="lists/listinfo/">tmda-workers</a>
+ list, but when you have problems, your first point of contact should be the
+ <a href="mailto:[EMAIL PROTECTED]";>tmda-gui</a> list. At some
+ point I will merge this list in with <a href="lists/listinfo/">tmda-workers</a>,
+ but I want to wait until we transition from the "adding features"
+ phase into the "fixing bugs" phase.
+ <p>tmda-gui is replicated on <a href="http://gmane.org";>Gmane</a>. Check out
+ <a
+href="news://news.gmane.org/gmane.mail.spam.tmda.web.gui";>gmane.mail.spam.tmda.web.gui</a>
+
+ if you prefer using a newsreader over mailing lists.</p>
+ </li>
+</ul>
+<hr>
+<h2><a name="Install"></a>Installation</h2>
<p>tmda-cgi is provided in your distribution's <tt>contrib/cgi</tt> directory,
however with this being alpha-revision software, revisions come out quite
frequently.
You should consider downloading from <a
href="http://sourceforge.net/cvs/?group_id=24680"; target="_blank">CVS</a>
@@ -110,7 +151,7 @@
<li>You will have to recompile tmda-cgi if you change which mode (system-wide,
single-user, or no-su) you run in.</li>
</ul>
-<h3>Installing system-wide</h3>
+<h3><a name="SystemWide"></a>Installing system-wide</h3>
<p>As root, change to the cgi directory.</p>
<blockquote>
<pre># cd contrib/cgi</pre>
@@ -133,7 +174,7 @@
<blockquote>
<pre># ln -s display /path/to/webpage/directory</pre>
</blockquote>
-<h3>Installing single-user</h3>
+<h3><a name="SingleUser"></a>Installing single-user</h3>
<p>As the (only) user who will be able to access tmda-cgi, change to the cgi
directory.</p>
<blockquote>
<pre>$ cd contrib/cgi</pre>
@@ -156,7 +197,7 @@
<blockquote>
<pre>$ ln -s display /path/to/webpage/directory</pre>
</blockquote>
-<h3>Installing no-su</h3>
+<h3><a name="nosu"></a>Installing no-su</h3>
<p>To compile tmda-cgi for no-su mode, first change to the cgi directory.</p>
<blockquote>
<pre>$ cd contrib/cgi</pre>
@@ -186,6 +227,7 @@
</blockquote>
<p>to your configuration file. That will make sure that future pending e-mails
are written such that they can be read by group members (i.e. the CGI).</p>
+<h4><a name="nosuExample"></a>Centralized no-su setup</h4>
<p>If you multiple users plan on using tmda-cgi in no-su mode, then you might
consider moving all of your TMDA files into one central location. This will
make it easier to keep group permissions on your directories and files. Here's
@@ -336,14 +378,15 @@
<td width="600" bgcolor="#CCCCCC"><tt>|preline /usr/src/tmda/bin/tmda-filter -c
/var/tmda/cgitest/config<br>
./Maildir/</tt></td>
</tr>
- </table><br>
+ </table>
</blockquote>
<p>tmda-cgi was compiled with the following:</p>
<blockquote>
<pre>./compile -nc /var/tmda/~/config -t /www/tmda.cgi</pre>
</blockquote>
<p>Use the <tt>./compile -h</tt> for more details on how to use compile.</p>
-<h3>Passwords</h3>
+<hr>
+<h2><a name="Pass"></a>Passwords</h2>
<p>tmda-cgi currently authenticate logins against user name & password pairs
stored in a password file (or files). tmda-cgi will look in two different places
for password file(s), but it (they) must be readable by the CGI.</p>
@@ -459,10 +502,24 @@
onto the end of your CGI URL. This will display some diagnostic information
if the login fails instead of simply saying "Wrong password. Try
again."</p>
<hr>
-<h2>Configuration</h2>
+<h2><a name="Config"></a>Configuration</h2>
<p>tmda-cgi is configured by a set of parameters in your configuration file(s).
All tmda-cgi configuration variables begin with a "<tt>CGI_</tt>"
and are described on the <a href="config-vars.html">Configuration Variables</a>
page.</p>
<p><em><strong>Note:</strong></em> If you change nothing else, you will have to
at least set the value for <a
href="config-vars.html#CGI_ACTIVE"><tt>CGI_ACTIVE</tt></a>.</p>
+<hr>
+<h2><a name="Template" id="Template"></a>Templates</h2>
+<p>By supplying your own templates (see the <a href="howto-template.html">Template
+ HOWTO</a> for more on customizing your templates) you can use tmda-cgi's URL
+ confirmation feature. This allows you to specify a URL in your confirmation
+ e-mail as an alternative to confirming by e-mail.</p>
+<p>To supply a confirmation URL, simply use the <tt>%(confirm_accept_url)s</tt>
+ variable in <tt>confirm_request.txt</tt> as shown in <a
+href="#nosuExample">Centralized
+ no-su setup</a>.</p>
+<p><em><strong>Note:</strong></em> Be sure you set <a
+href="config-vars.html#CGI_ACTIVE"><tt>CGI_ACTIVE</tt></a>,
+ <a href="config-vars.html#CGI_ACTIVE"><tt>CGI_ACTIVE</tt></a>, and <a
+href="config-vars.html#CGI_ACTIVE"><tt>CGI_ACTIVE</tt></a>
+ before modifying your template! No confirmation e-mails will be sent if you
+ specify a <tt>%(confirm_accept_url)</tt> until these three variables are properly
+ configured. Always test your configuration after making a change to your
+templates.</p>
Index: tmda-cgi.html
===================================================================
RCS file: /cvsroot/tmda/tmda/htdocs/tmda-cgi.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- tmda-cgi.html 7 Dec 2002 04:11:22 -0000 1.4
+++ tmda-cgi.html 7 Dec 2002 18:21:31 -0000 1.5
@@ -1,16 +1,16 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<!-- THIS PAGE IS AUTOMATICALLY GENERATED. DO NOT EDIT. -->
-<!-- Fri Dec 6 22:10:12 2002 -->
+<!-- Sat Dec 7 12:18:55 2002 -->
<!-- USING HT2HTML 2.0 -->
<!-- SEE http://ht2html.sf.net -->
<!-- User-specified headers:
-Title: tmda-cgi HOWTO
+Title: tmda-cgi.ht
-->
<head>
-<title>tmda-cgi HOWTO</title>
+<title>tmda-cgi.ht</title>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="HT2HTML/2.0">
<style type="text/css">
@@ -161,8 +161,20 @@
<!-- start of body cell -->
<td valign="top" width="90%" class="body"><br>
<h1>tmda-cgi</h1>
+<p><a href="#What">What is it?</a><br>
+ <a href="#Require">Requirements</a><br>
+ <a href="#Blame">Credit, blame, and getting help</a><br>
+ <a href="#Install">Installation</a><br>
+ <a href="#SystemWide">System-wide mode</a><br>
+ <a href="#SingleUser">Single-user mode</a><br>
+ <a href="#nosu">no-su mode</a><br>
+ <a href="#nosuExample">Centralized
+ no-su setup</a><br>
+ <a href="#Pass">Passwords</a><br>
+ <a href="#Config">Configuration</a><br>
+ <a href="#Template">Templates</a></p>
<hr>
-<h2>What is it?</h2>
+<h2><a name="What"></a>What is it?</h2>
<p>tmda-cgi is an alpha-release program for managing your TMDA account over the
web. At the time of this writing, tmda-cgi can:</p>
<ul>
@@ -221,11 +233,40 @@
remember why the rest of my family thinks that e-mail is a pain."
</ul>
<hr>
-<h2>Requirements</h2>
+<h2><a name="Require"></a>Requirements</h2>
<p>TBD. Until we do more testing it isn't clear what systems have problems with
tmda-cgi.</p>
<hr>
-<h2>Installation</h2>
+<h2><a name="Blame" id="Blame"></a>Credit, blame, and getting help</h2>
+<p>As already mentioned, this is contributed software at an alpha-level release.
+ That means:</p>
+<ul>
+ <li>Use at your own risk.
+ <p>That's true of all software in general, but we're telling you up front
+ that not a lot of people have tested or analyzed the code yet. If it goes
+ awry or opens a security hole on your machine, I won't drop dead from the
+ shock.</p>
+ </li>
+ <li>This program wouldn't have been possible without the support and contributions
+ of Jason Mastaler, David Guerizec, Tim Legant, and others on the <a
+href="mailto:[EMAIL PROTECTED]";>tmda-gui</a>
+ and <a href="lists/listinfo/">tmda-workers</a> lists, but they didn't write
+ the actual code itself.
+ <p>When it doesn't work right, be sure you yell out "Damn that <a
+href="mailto:[EMAIL PROTECTED]";>Gre7g
+ Luterman</a>!" because I'm the one responsible for your pain.
+<winks></p>
+ </li>
+ <li>tmda-cgi is discussed some on the <a href="lists/listinfo/">tmda-workers</a>
+ list, but when you have problems, your first point of contact should be the
+ <a href="mailto:[EMAIL PROTECTED]";>tmda-gui</a> list. At some
+ point I will merge this list in with <a href="lists/listinfo/">tmda-workers</a>,
+ but I want to wait until we transition from the "adding features"
+ phase into the "fixing bugs" phase.
+ <p>tmda-gui is replicated on <a href="http://gmane.org";>Gmane</a>. Check out
+ <a
+href="news://news.gmane.org/gmane.mail.spam.tmda.web.gui";>gmane.mail.spam.tmda.web.gui</a>
+
+ if you prefer using a newsreader over mailing lists.</p>
+ </li>
+</ul>
+<hr>
+<h2><a name="Install"></a>Installation</h2>
<p>tmda-cgi is provided in your distribution's <tt>contrib/cgi</tt> directory,
however with this being alpha-revision software, revisions come out quite
frequently.
You should consider downloading from <a
href="http://sourceforge.net/cvs/?group_id=24680"; target="_blank">CVS</a>
@@ -270,7 +311,7 @@
<li>You will have to recompile tmda-cgi if you change which mode (system-wide,
single-user, or no-su) you run in.</li>
</ul>
-<h3>Installing system-wide</h3>
+<h3><a name="SystemWide"></a>Installing system-wide</h3>
<p>As root, change to the cgi directory.</p>
<blockquote>
<pre># cd contrib/cgi</pre>
@@ -293,7 +334,7 @@
<blockquote>
<pre># ln -s display /path/to/webpage/directory</pre>
</blockquote>
-<h3>Installing single-user</h3>
+<h3><a name="SingleUser"></a>Installing single-user</h3>
<p>As the (only) user who will be able to access tmda-cgi, change to the cgi
directory.</p>
<blockquote>
<pre>$ cd contrib/cgi</pre>
@@ -316,7 +357,7 @@
<blockquote>
<pre>$ ln -s display /path/to/webpage/directory</pre>
</blockquote>
-<h3>Installing no-su</h3>
+<h3><a name="nosu"></a>Installing no-su</h3>
<p>To compile tmda-cgi for no-su mode, first change to the cgi directory.</p>
<blockquote>
<pre>$ cd contrib/cgi</pre>
@@ -346,6 +387,7 @@
</blockquote>
<p>to your configuration file. That will make sure that future pending e-mails
are written such that they can be read by group members (i.e. the CGI).</p>
+<h4><a name="nosuExample"></a>Centralized no-su setup</h4>
<p>If you multiple users plan on using tmda-cgi in no-su mode, then you might
consider moving all of your TMDA files into one central location. This will
make it easier to keep group permissions on your directories and files. Here's
@@ -496,14 +538,15 @@
<td width="600" bgcolor="#CCCCCC"><tt>|preline /usr/src/tmda/bin/tmda-filter -c
/var/tmda/cgitest/config<br>
./Maildir/</tt></td>
</tr>
- </table><br>
+ </table>
</blockquote>
<p>tmda-cgi was compiled with the following:</p>
<blockquote>
<pre>./compile -nc /var/tmda/~/config -t /www/tmda.cgi</pre>
</blockquote>
<p>Use the <tt>./compile -h</tt> for more details on how to use compile.</p>
-<h3>Passwords</h3>
+<hr>
+<h2><a name="Pass"></a>Passwords</h2>
<p>tmda-cgi currently authenticate logins against user name & password pairs
stored in a password file (or files). tmda-cgi will look in two different places
for password file(s), but it (they) must be readable by the CGI.</p>
@@ -619,13 +662,27 @@
onto the end of your CGI URL. This will display some diagnostic information
if the login fails instead of simply saying "Wrong password. Try
again."</p>
<hr>
-<h2>Configuration</h2>
+<h2><a name="Config"></a>Configuration</h2>
<p>tmda-cgi is configured by a set of parameters in your configuration file(s).
All tmda-cgi configuration variables begin with a "<tt>CGI_</tt>"
and are described on the <a href="config-vars.html">Configuration Variables</a>
page.</p>
<p><em><strong>Note:</strong></em> If you change nothing else, you will have to
at least set the value for <a
href="config-vars.html#CGI_ACTIVE"><tt>CGI_ACTIVE</tt></a>.</p>
+<hr>
+<h2><a name="Template" id="Template"></a>Templates</h2>
+<p>By supplying your own templates (see the <a href="howto-template.html">Template
+ HOWTO</a> for more on customizing your templates) you can use tmda-cgi's URL
+ confirmation feature. This allows you to specify a URL in your confirmation
+ e-mail as an alternative to confirming by e-mail.</p>
+<p>To supply a confirmation URL, simply use the <tt>%(confirm_accept_url)s</tt>
+ variable in <tt>confirm_request.txt</tt> as shown in <a
+href="#nosuExample">Centralized
+ no-su setup</a>.</p>
+<p><em><strong>Note:</strong></em> Be sure you set <a
+href="config-vars.html#CGI_ACTIVE"><tt>CGI_ACTIVE</tt></a>,
+ <a href="config-vars.html#CGI_ACTIVE"><tt>CGI_ACTIVE</tt></a>, and <a
+href="config-vars.html#CGI_ACTIVE"><tt>CGI_ACTIVE</tt></a>
+ before modifying your template! No confirmation e-mails will be sent if you
+ specify a <tt>%(confirm_accept_url)</tt> until these three variables are properly
+ configured. Always test your configuration after making a change to your
+templates.</p>
</td><!-- end of body cell -->
</tr><!-- end of sidebar/body row -->
_______________________________________
tmda-cvs mailing list
http://tmda.net/lists/listinfo/tmda-cvs
