* Added the ability to listen on a single IP address instead of all addresses.

[citadel.git] / webcit / README.txt

diff --git a/webcit/README.txt b/webcit/README.txt
index aa1b553b85d98ef0881645c28e018336f4ea50f0..6151b71753968efaa8ca261d999b5c5a91516594 100644 (file)
--- a/webcit/README.txt
+++ b/webcit/README.txt
@@ -1,5 +1,5 @@
                       WEBCIT for the Citadel/UX System
-                               version 5.10
+                               version 5.20
  
    Copyright (C) 1996-2004 by the authors.  Portions written by:
        Art Cancro
@@ -67,28 +67,28 @@ something like this:
  Several command-line options are also available.  Here's the usage for
 the "webserver" program:
   
- webserver [-p http_port] [-s https_port] [-t tracefile]
+ webserver [-i ip_addr] [-p http_port] [-s] [-t tracefile]
            [-c] [remotehost [remoteport]]
  
    *or*
  
- webserver [-p http_port] [-s https_port] [-t tracefile]
+ webserver [-i ip_addr] [-p http_port] [-s] [-t tracefile]
            [-c] uds /your/citadel/directory
  
  Explained: 
   
+  -> ip_addr: the IP address on which you wish your WebCit server to run.
+     You can leave this out, in which case WebCit will listen on all
+     available network interfaces.  Normally this will be the case, but if
+     you are running multiple Citadel systems on one host, it can be useful.
+ 
   -> http_port: the TCP port on which you wish your WebCit server to run.
-     this can be any port number at all; there is no standard.  Naturally,
+     This can be any port number at all; there is no standard.  Naturally,
      you'll want to create a link to this port on your system's regular web
      pages (presumably on an Apache server running on port 80).  Or, if you
      are installing WebCit on a dedicated server, then you might choose to
      use port 80 after all.
  
-  -> https_port: an optional TCP port on which you wish your WebCit server
-     to run an SSL-encrypted web service.  The standard port number for this
-     is 443, and if you're not already running a secure web server you might
-     choose to use that port.  Otherwise, select any free port number.
- 
   -> tracefile: where you want WebCit to log to.  This can be a file, a
      virtual console, or /dev/null to suppress logging altogether.
  
@@ -99,6 +99,10 @@ the "webserver" program:
      load balancer, and the load balancer has the ability to use cookies to
      keep track of which server to send HTTP requests to.
  
+  -> The "-s" option causes WebCit to present an HTTPS (SSL-encrypted) web
+     service.  If you want to do both HTTP and HTTPS, you can simply run two
+     instances of WebCit on two different ports.
+ 
   -> remotehost: the name or IP address of the host on which your Citadel/UX
      server is running.  The default is "localhost".
  
@@ -142,7 +146,9 @@ be automatically configured and installed if your host system supports it.
  WebCit also provides Kolab-compatible free/busy data for calendar clients.
 Unlike the Kolab server, however, there is no need for each user to "publish"
 free/busy data -- it is generated on-the-fly from the server-side calendar
-of the user being queried.
+of the user being queried.  Note: in order to support Kolab clients, you must
+have WebCit running in HTTPS mode on port 443, because that is what Kolab
+clients will be expecting.
   
  
  HTTPS (encryption) SUPPORT