X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=webcit%2FREADME.txt;h=aa8f6061fddcc2af4e0a05eafd855431d6eb015d;hb=HEAD;hp=2bc50943d32c7c30cb4e95802c8847551827bf5b;hpb=fdb646c4707aa49a90850189f4c60e81ee2784d3;p=citadel.git
diff --git a/webcit/README.txt b/webcit/README.txt
index 2bc50943d..aa8f6061f 100644
--- a/webcit/README.txt
+++ b/webcit/README.txt
@@ -1,6 +1,6 @@
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
@@ -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
@@ -107,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:
@@ -131,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:
@@ -254,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) :
#here some of your config stuff like logging, serveradmin...
@@ -269,7 +275,7 @@ Here is how to configure the NameVirtualHost method:
alias /static /var/lib/citadel/www/static
-Here is how to configure the "subdirectory" method:
+Here is how to configure the "subdirectory" method (not recommended) :
#here some of your config stuff like logging, serveradmin...
@@ -295,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
@@ -328,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