WEBCIT for the Citadel System
- Copyright (C) 1996-2009 by the authors. Portions written by:
+ Copyright (C) 1996-2012 by the authors. Portions written by:
Art Cancro
Wilfried Goesgens
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
is licensed to you under the terms of the GNU Lesser General Public
License.
- WebCit bundles the Nifty Corners library, written by Alessandro Fulciniti
- [http://cerca.html.it/cgi-bin/cerca.cgi?q=nifty+corners]. This component
- is licensed to you under the terms of the GNU General Public License.
+ Most of our Icons are taken from the "Essen" set by the people on
+ http://pc.de/icons/. We 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.
+ WebCit bundles the CSS3PIE library [http://css3pie.com] which is offered
+ under both the Apache license and the GNU General Public License.
+
The Citadel logo was designed by Lisa Aurigemma.
Citadel is a sophisticated groupware platform 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.
-
+This package (WebCit) is a web based front end and user interface to the
+Citadel system.
+
What this means in practice is that after you've installed WebCit, users can
access all functions of your system using any web browser. Since this may be
the first Citadel experience for many new users, the screens have been designed
INSTALLATION
------------
- Unline some web-based packages, WebCit contains its own standalone HTTP
+ Unlike some web-based packages, WebCit contains its own standalone HTTP
engine. As a result, you can get it running quickly without all that tedious
mucking about with Apache configuration files and directories. WebCit is not
intended to be a general-purpose web server, however -- it *only* provides a
...and log in.
The included "setup" program is basically just an installation helper that
-asks a series of questions and then adds the appropriate line to inittab to
+asks a series of questions and then adds the appropriate init files to
start WebCit. For most installations, this will do just fine. If you have
special circumstances, or if you'd prefer to configure WebCit manually, you
may skip the setup program. Instead, open /etc/inittab and add an entry
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:
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:
-------------
The default WebCit installation will create an empty directory called
-"static.local". In this directory you may place a file called "webcit.css"
-which, if present, is referenced *after* the default stylesheet. If you
-know CSS and wish to customize your WebCit installation, any styles you
-declare in static.local/webcit.css will override the styles found in
-static/webcit.css -- and your customizations will not be overwritten when
-you upgrade WebCit later.
+"static.local". In this directory you may place a file called "webcit.css"
+into the "styles" directory which, if present, is referenced *after* the
+default stylesheet. If you know CSS and wish to customize your WebCit
+installation, any styles you declare in static.local/styles/webcit.css
+will override the styles found in static/styles/webcit.css -- and your
+customizations will not be overwritten when you upgrade WebCit later.
You may also place other files, such as images, in static.local for
further customization.
----------------
WebCit contains support for calendaring and scheduling. In order to use it
-you must have libical v0.26 (or newer) on your system. You must also be
-running a Citadel server with calendaring support. The calendar service will
-be automatically configured and installed if your host system supports it.
+you must have libical v0.26 (or newer) on your system.
WebCit also provides iCalendar format free/busy data for calendar clients.
Unlike with some other servers, there is no need for each user to "publish"
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...
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...
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>
- ADVANCED CONFIGURE OPTIONS
- --------------------------
+ ADVANCED CONFIGURATION OPTIONS
+ ------------------------------
If you are building packages and prefer not to have WebCit reside entirely in
a single directory, there are several compile-time options available.
----------
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
projects / citadel.git / blobdiff