Implemented and documented a '-g' option for WebCit to enable a default landing page...

[citadel.git] / webcit / README.txt

diff --git a/webcit/README.txt b/webcit/README.txt
index 2bc50943d32c7c30cb4e95802c8847551827bf5b..14a20655e87d1ca8f7a864d5186421935c9960e9 100644 (file)
--- a/webcit/README.txt
+++ b/webcit/README.txt
@@ -13,9 +13,10 @@
        Dave Lindquist
        Matt Pfleger
        Martin Mouritzen
+       Stefan Garthe
 
    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
@@ -108,11 +109,13 @@ something like this:
 the "webcit" program:
   
  webcit [-i ip_addr] [-p http_port] [-s] [-S cipher_suite] [-t tracefile]
+           [-g guest_landing_page ]
            [-c] [-f] [remotehost [remoteport]]
  
    *or*
  
  webcit [-i ip_addr] [-p http_port] [-s] [-S cipher_suite] [-t tracefile]
+           [-g guest_landing_page ]
            [-c] [-f] uds /your/citadel/directory
  
  Explained: 
@@ -133,6 +136,12 @@ the "webcit" 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 "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:
@@ -254,7 +263,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...
@@ -269,7 +278,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...
@@ -295,9 +304,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>
 
   
@@ -328,5 +334,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