Update version number to 8.15 across all components

[citadel.git] / webcit / README.txt

diff --git a/webcit/README.txt b/webcit/README.txt
index a59f8b0a393ffac8f0c19676ab34a398301749cf..19fd15dda1ce6b348a51fea458cb1ac0d3b9e0e4 100644 (file)
--- a/webcit/README.txt
+++ b/webcit/README.txt
@@ -1,9 +1,10 @@
                         WEBCIT for the Citadel System
  
-   Copyright (C) 1996-2011 by the authors.  Portions written by:
+   Copyright (C) 1996-2012 by the authors.  Portions written by:
  
        Art Cancro
        Wilfried Goesgens
+       Stefan Garthe
        Dave West
        Thierry Pasquier
        Nathan Bryant
@@ -15,7 +16,7 @@
        Martin Mouritzen
 
    This program is open source software released under the terms of the GNU
-   General Public License, version 3.  Please read COPYING.txt for more
+   General Public License, version 3. Please read COPYING.txt for more
    licensing information.
  
    WebCit bundles the Prototype JavaScript Framework, writen by Sam
@@ -31,6 +32,10 @@
    is licensed to you under the terms of the GNU Lesser General Public
    License.
 
+   Most of our Icons are taken from the "Essen" set by the people on
+   http://pc.de/icons/. We would like to thank them for their astonishing
+   work!  Their site explicitly states: "Free for commercial use as well."
+
    One or more icons are from Milosz Wlazlo [http://miloszwl.deviantart.com]
    whose license explicitly allows inclusion in open source projects on the
    condition of this attribution.
@@ -103,12 +108,14 @@ something like this:
  Several command-line options are also available.  Here's the usage for
 the "webcit" program:
   
- webcit [-i ip_addr] [-p http_port] [-s] [-S cipher_suite] [-t tracefile]
+ webcit [-i ip_addr] [-p http_port] [-s] [-S cipher_suite]
+           [-g guest_landing_page]
            [-c] [-f] [remotehost [remoteport]]
  
    *or*
  
- webcit [-i ip_addr] [-p http_port] [-s] [-S cipher_suite] [-t tracefile]
+ webcit [-i ip_addr] [-p http_port] [-s] [-S cipher_suite]
+           [-g guest_landing_page]
            [-c] [-f] uds /your/citadel/directory
  
  Explained: 
@@ -127,8 +134,11 @@ the "webcit" program:
      different port.  If you do not specify a port number, WebCit will attempt
      to use port 80.
      
-  -> tracefile: where you want WebCit to log to.  This can be a file, a
-     virtual console, or /dev/null to suppress logging altogether.
+  -> The "guest landing page" is a location on your WebCit installation where
+     unauthenticated guest users are taken when they first enter the root of
+     your site.  If guest mode is not enabled on your Citadel server, they will
+     be taken to a login page instead.  If guest mode is enabled but no landing
+     page is defined, they will be taken to the Lobby.
  
   -> The "-c" option causes WebCit to output an extra cookie containing the
      identity of the WebCit server.  The cookie will look like this:
@@ -250,7 +260,7 @@ virtual host through to WebCit.  The alternative way, which does work but is not
 quite as robust, is to "mount" the WebCit paths as directory aliases to your
 main document root.
 
-Here is how to configure the NameVirtualHost method:
+Here is how to configure the NameVirtualHost method (recommended) :
 
 <VirtualHost mydomain.com:443>
        #here some of your config stuff like logging, serveradmin...
@@ -265,7 +275,7 @@ Here is how to configure the NameVirtualHost method:
     alias /static /var/lib/citadel/www/static
 </VirtualHost>
 
-Here is how to configure the "subdirectory" method:
+Here is how to configure the "subdirectory" method (not recommended) :
 
 <VirtualHost mydomain.com:443>
        #here some of your config stuff like logging, serveradmin...
@@ -291,9 +301,6 @@ Here is how to configure the "subdirectory" method:
     ProxyPassReverse /groupdav/ http://127.0.0.1:2000/groupdav/
     ProxyPass /who_inner_html http://127.0.0.1:2000/who_inner_html
     ProxyPassReverse /who_inner_html http://127.0.0.1:2000/who_inner_html
-# The following line is optional.  It allows WebCit's static content
-# such as images to be served directly by Apache.
-    alias /static /var/lib/citadel/www/static
 </VirtualHost>
 
   
@@ -324,5 +331,5 @@ bin: the binaries.
  ----------
  
  That's all you need to know to get started.  If you have any questions or
-comments, please visit UNCENSORED! BBS, the home of Citadel, at
-http://uncensored.citadel.org - and go to the "Citadel Support" room.
+comments, visit the Citadel Support room on UNCENSORED! BBS, the home of Citadel:
+http://uncensored.citadel.org/dotgoto?room=Citadel%20Support