we don't want autoconf/make stuff in svn. this should be added on distributing the...

[citadel.git] / webcit / README.txt

diff --git a/webcit/README.txt b/webcit/README.txt
index 9c319b1075e8c1cbc4f91caac6a62dd2207097d0..a530f5e29fb45b61b06bf76b31332ca9c4195733 100644 (file)
--- a/webcit/README.txt
+++ b/webcit/README.txt
@@ -1,23 +1,39 @@
                         WEBCIT for the Citadel System
-                               version 6.19
+                               version 6.71
  
-   Copyright (C) 1996-2005 by the authors.  Portions written by:
+   Copyright (C) 1996-2006 by the authors.  Portions written by:
        Art Cancro
        Nathan Bryant
+       Wilifried Goesgens
        Nick Grossman
        Andru Luvisi
-        Kevin Roth
        Dave Lindquist
        Martin Mouritzen
- 
-This program is free software released under the terms of the GNU General
-Public License.  Please read COPYING.txt for more licensing information.
- 
+
+   This program is open source software released under the terms of the GNU
+   General Public License, version 2.  Please read COPYING.txt for more
+   licensing information.
+ 
+   WebCit bundles the Prototype JavaScript Framework, writen by Sam
+   Stephenson [http://prototype.conio.net].  These components are licensed to
+   you under the terms of an MIT-style license.
+
+   WebCit bundles the script.aculo.us JavaScript library, written by
+   Thomas Fuchs [http://script.aculo.us, http://mir.aculo.us].  These
+   components are licensed to you under the terms of an MIT-style license.
+
+   WebCit bundles the TinyMCE text editor, written by Moxiecode Systems AB
+   (http://tinymce.moxiecode.com/tinymce/docs/credits.html).  This component
+   is licensed to you under the terms of the GNU Lesser General Public
+   License.
+
+   The Citadel logo was designed by Lisa Aurigemma.
+
  
  INTRODUCTION
  ------------
  
- Citadel is a sophisticated BBS and groupware package which allows multiple
+ Citadel is a sophisticated groupware and 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.
@@ -70,12 +86,12 @@ something like this:
 the "webserver" program:
   
  webserver [-i ip_addr] [-p http_port] [-s] [-t tracefile]
-           [-c] [remotehost [remoteport]]
+           [-c] [-f] [remotehost [remoteport]]
  
    *or*
  
  webserver [-i ip_addr] [-p http_port] [-s] [-t tracefile]
-           [-c] uds /your/citadel/directory
+           [-c] [-f] uds /your/citadel/directory
  
  Explained: 
   
@@ -84,13 +100,13 @@ the "webserver" program:
      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,
-     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.
- 
+  -> http_port: the TCP port on which you wish your WebCit server to run.  If
+     you are installing WebCit on a dedicated server, you can use the
+     standard port 80.  Otherwise, if port 80 is already occupied by some
+     other web service (probably Apache), then you'll need to select a
+     different port.  If you do not specify a port number, WebCit will attempt
+     to use port 2000.
+     
   -> tracefile: where you want WebCit to log to.  This can be a file, a
      virtual console, or /dev/null to suppress logging altogether.
  
@@ -104,6 +120,15 @@ the "webserver" program:
   -> 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.
+
+  -> The "-f" option tells WebCit that it is allowed to follow the
+     "X-Forwarded-For:" HTTP headers which may be added if your WebCit service
+     is sitting behind a front end proxy.  This will allow users in your "Who
+     is online?" list to appear as connecting from their actual host address
+     instead of the address of the proxy.  In addition, the
+     "X-Forwarded-Host:" header from the front end proxy will also be honored,
+     which will help to make automatically generated absolute URL's (for
+     things like GroupDAV and mailing list subscriptions) correct.
  
   -> remotehost: the name or IP address of the host on which your Citadel
      server is running.  The default is "localhost".
@@ -122,7 +147,7 @@ the "webserver" program:
  GRAPHICS
  --------
  
- WebCit contains a small amount of graphics (buttons, etc.) which are kept
+ WebCit contains graphics, templates, JavaScript code, etc. which are kept
 in its "static" subdirectory.  All site-specific graphics, however, are
 fetched from the Citadel server.