* Lots of great changes from Nick to make the site CSS-enabled.

[citadel.git] / webcit / README.txt

diff --git a/webcit/README.txt b/webcit/README.txt
index 503da41c757164ff0829bee7df65dcedcd697e7d..77479ec41859dd2c50e905d0fbd0e3e025f4adb3 100644 (file)
--- a/webcit/README.txt
+++ b/webcit/README.txt
@@ -1,7 +1,7 @@
                       WEBCIT for the Citadel/UX System
-                               version 3.00
+                               version 4.10
  
-   Copyright (C) 1996-2000 by the authors.  Portions written by:
+   Copyright (C) 1996-2003 by the authors.  Portions written by:
        Art Cancro
        Nathan Bryant
        Nick Grossman
@@ -14,15 +14,15 @@ Public License.  Please read COPYING.txt for more licensing information.
  INTRODUCTION
  ------------
  
- Citadel/UX is a sophisticated BBS package which allows multiple users to
-simultaneously access the system using a variety of user interfaces.  This
-package (WebCit) is a "middleware" package which presents an HTML/HTTP user
-interface to the Citadel system.
+ Citadel/UX is a sophisticated BBS and groupware package which allows multiple
+users to simultaneously access the system using a variety of user interfaces.
+This package (WebCit) is a "middleware" package which presents an HTML/HTTP
+user interface to the Citadel system.
  
  What this means in practice is that after you've installed WebCit, users can
-access all functions of your BBS using any web browser.  Since this may be the
-first Citadel experience for many new users, the screens have been designed to
-be attractive and easy to navigate.
+access all functions of your system using any web browser.  Since this may be
+the first Citadel experience for many new users, the screens have been designed
+to be attractive and easy to navigate.
  
  
  INSTALLATION
@@ -61,11 +61,11 @@ any reason.  Open /etc/inittab and add an entry something like this:
  Several command-line options are also available.  Here's the usage for
 the "webserver" program:
   
- webserver [-p localport] [-t tracefile] [remotehost [remoteport]]
+ webserver [-p localport] [-t tracefile] [-c] [remotehost [remoteport]]
  
    *or*
  
- webserver [-p localport] [-t tracefile] uds /your/citadel/directory
+ webserver [-p localport] [-t tracefile] [-c] uds /your/citadel/directory
  
  Explained: 
   
@@ -77,6 +77,13 @@ the "webserver" program:
   -> tracefile: where you want WebCit to log to.  This can be a file, a
      virtual console, or /dev/null to suppress logging altogether.
  
+  -> The "-c" option causes WebCit to output an extra cookie containing the
+     identity of the WebCit server.  The cookie will look like this:
+       Set-cookie: wcserver=your.host.name
+     This is useful if you have a cluster of WebCit servers sitting behind a
+     load balancer, and the load balancer has the ability to use cookies to
+     keep track of which server to send HTTP requests to.
+ 
   -> remotehost: the name or IP address of the host on which your Citadel/UX
      server is running.  The default is "localhost".  (NOTE: if you run
      WebCit and the Citadel/UX server on different hosts, the real-time chat
@@ -91,8 +98,7 @@ the "webserver" program:
      socket.  /your/citadel/directory should be set to the actual name of the
      directory in which you have Citadel installed
      (such as /usr/local/citadel).  If you run Citadel and WebCit on the same
-     computer, this way may run a bit faster, but you may experience trouble
-     with the real-time chat facility.
+     computer, this is recommended, as it will run much faster.
  
  
  GRAPHICS
@@ -110,6 +116,15 @@ ones which you may be interested in are:
     banner, and on the top left corner of each page.
  
  
+ CALENDAR SERVICE
+ ----------------
+ 
+ WebCit contains support for calendaring and scheduling.  In order to use it
+you must have libical v0.24 (or newer) on your system.  You must also be
+running a Citadel server with calendaring support.  The calendar service will
+be automatically configured and installed if your host system supports it.
+ 
+ 
  CONCLUSION
  ----------