From: Stephen L Johnson <sjohnson@monsters.org>
Date: Wed, 4 Oct 2000 21:13:23 +0000 (+0000)
Subject: added section on configuring Web Display interface
X-Git-Tag: spong-2_7_0-beta1~14
X-Git-Url: http://git.etc.gen.nz/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e4157d4d3ff1f9723911a9f0ddd8e90656f06648;p=spong.git

added section on configuring Web Display interface
---

diff --git a/pod/admin-guide.pod b/pod/admin-guide.pod
index 8672282..dba07b2 100755
--- a/pod/admin-guide.pod
+++ b/pod/admin-guide.pod
@@ -112,6 +112,83 @@ clients. You can use tar+ftp, rcp, rdist or whatever mechamism you would
 normally use. Just be sure the Spong installation directory into the same
 location as the original client.
 
+=head2 Configure Web Server
+
+To use the Spong Web Display your need to configure you web server in
+conjuction with some configuration variable in the spong.conf configuration
+file.
+
+=over 4
+
+=item spong.conf
+
+=over 8
+
+=item $WWWSPONG
+
+This is the URI path to the location of the B<www-spong> CGI program in the web
+server's document tree. For example, if the URL of www-spong is going to be
+C<http://www.example.org/spong/cgi-bin/www-spong>, you need to set I<$WWWSPONG>
+to '/spong/cgi-bin/www-spong'. See also L</"SPONG CGI DIR">.
+
+=item $WWWACK
+
+This is the URI path to the location of the B<www-spong-ack> CGI program in the
+web server's document tree. For example, if the URL of www-spong is going to be
+C<http://www.example.org/spong/cgi-bin/www-spong-ack>, you need to set
+I<$WWWSPONG> to '/spong/cgi-bin/www-spong-ack'. See also L</"SPONG CGI DIR">.
+
+=item $WWWGIF
+
+This is the URI path to the location of the SPONG/www/gifs/ directory in the
+web server's document tree. If the location of the images directory is
+C<http://www.example.org/spong/gifs/>, then $WWWGIF is set to '/spong/gifs'.
+See also L</"Spong HTML Directory">.
+
+=item $WWWHTML
+
+This varirable is used as a part of the Spong online help/information system.
+The variable is different from the other B<$WWW> spong config varirables. This
+variable is set to the actual file location of the F<SPONG/www/html> direcotyr
+on the file system. The Web Display programs reads the requested files, does
+some token replacement, and send the files to the web server.
+
+=item $WWDOCS
+
+This varirable is used as a part of the Spong online help/information system.
+The variable is different from the other B<$WWW> spong config varirables. This
+variable is set to the actual file location of the F<SPONG/www/docs> directory
+on the file system. The Web Display programs reads the requested files, does
+some token replacement, and send the files to the web server.
+
+=back
+
+=item Web Server Configuration
+
+On the web server side of thing your will have to configure two items: the F<SPONG/www> directory and the F<SPONG/cgi-bin/> CGI directory
+
+=over 8
+
+=item Spong CGI Directory
+
+The F<SPONG/cgi-bin/> directory must be setup as a CGI directory and aliased
+into the desired location. For example, for Apache a sample configuration
+line would be:
+
+  ScriptAlias /spong/cgi-bin/ /usr/local/spong/cgi-bin/
+
+=item Spong HTML Directory
+
+The F<SPONG/www/> directory must be aliased into the desired location within
+the web server document tree. If you want the F<SPONG/www> directory 
+to be under http://www.example.org/spong/ on an Apache web server, use this
+configuration line:
+
+  Alias /spong/ /usr/local/spong/www/
+
+=back
+
+=back
 
 =head2 Debugging Problems