- WEBCIT for the Citadel/UX System
- version 5.00
+ WEBCIT for the Citadel System
+ version 6.25
- Copyright (C) 1996-2003 by the authors. Portions written by:
+ Copyright (C) 1996-2005 by the authors. Portions written by:
Art Cancro
Nathan Bryant
+ Wilifried Goesgens
Nick Grossman
Andru Luvisi
-
-This program is free software released under the terms of the GNU General
-Public License. Please read COPYING.txt for more licensing information.
-
+ Kevin Roth
+ Dave Lindquist
+ Martin Mouritzen
+
+ This program is open source software released under the terms of the GNU
+ General Public License. Please read COPYING.txt for more licensing
+ information.
+
+ WebCit bundles the Rico Ajax Engine, written by Darren James, Bill Scott,
+ et. al. [http://www.openrico.org]. These components are licensed to you
+ under the terms of the Apache 2.0 License.
+
+ 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.
+
+
+ The Citadel logo was designed by Lisa Aurigemma.
INTRODUCTION
------------
- Citadel/UX 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.
port. The default is port 2000.
To compile from source, enter the usual commands:
- ./configure
+ ./configure --prefix=/usr/local/webcit [or whatever directory you prefer]
make
+ make install
- Then to test it, simply run the webserver:
- ./webserver
+ Then to initialize it:
+ cd /usr/local/webcit
+ ./setup
- You'll see a bunch of diagnostic messages on the screen. At this time you
-can try it out. Point your web browser to WebCit using a URL such as:
+ After running setup, you just point your web browser to whatever port you
+specified, such as:
http://your.host.name:2000
- ...and log in. When you're satisfied that the program is working the way you
-want it to, you should set it up to be automatically started by the system at
-boot time. The recommended way to do this is with an entry in /etc/inittab,
-because init can then automatically restart WebCit if it happens to crash for
-any reason. Open /etc/inittab and add an entry something like this:
+ ...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
+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
+something like this:
wc:2345:respawn:/usr/local/webcit/webserver
Several command-line options are also available. Here's the usage for
the "webserver" program:
- webserver [-p localport] [-t tracefile] [-c] [remotehost [remoteport]]
+ webserver [-i ip_addr] [-p http_port] [-s] [-t tracefile]
+ [-c] [remotehost [remoteport]]
*or*
- webserver [-p localport] [-t tracefile] [-c] uds /your/citadel/directory
+ webserver [-i ip_addr] [-p http_port] [-s] [-t tracefile]
+ [-c] uds /your/citadel/directory
Explained:
- -> localport: 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,
+ -> ip_addr: the IP address on which you wish your WebCit server to run.
+ You can leave this out, in which case WebCit will listen on all
+ 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).
+ 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.
-> tracefile: where you want WebCit to log to. This can be a file, a
virtual console, or /dev/null to suppress logging altogether.
load balancer, and the load balancer has the ability to use cookies to
keep track of which server to send HTTP requests to.
- -> remotehost: the name or IP address of the host on which your Citadel/UX
- server is running. The default is "localhost". (NOTE: if you run
- WebCit and the Citadel/UX server on different hosts, the real-time chat
- screen will not work, due to the Java security model. Only the chat
- window is written as a Java applet; everything else is plain HTML.)
+ -> 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.
- -> remoteport: the port number on which your Citadel/UX server is running.
+ -> remotehost: the name or IP address of the host on which your Citadel
+ server is running. The default is "localhost".
+
+ -> remoteport: the port number on which your Citadel server is running.
The default is port 504, the IANA-designated standard port for Citadel.
-> "uds" is a keyword which tells WebCit that you wish to connect to a
GRAPHICS
--------
- WebCit contains a small amount of graphics (buttons, etc.) which are kept
+ WebCit contains a small amount of graphics (icons, etc.) which are kept
in its "static" subdirectory. All site-specific graphics, however, are
fetched from the Citadel server.
- The "images" directory on a Citadel/UX system contains these graphics. The
+ The "images" directory on a Citadel system contains these graphics. The
ones which you may be interested in are:
-> background.gif: a background texture displayed under all web pages
-> hello.gif: your system's logo. It is displayed along with the logon
banner, and on the top left corner of each page.
+ If you would like to deploy a "favicon.ico" graphic, please put it in
+the static/ directory. WebCit will properly serve it from there.
+
CALENDAR SERVICE
----------------
running a Citadel server with calendaring support. The calendar service will
be automatically configured and installed if your host system supports it.
+ WebCit also provides Kolab-compatible free/busy data for calendar clients.
+Unlike the Kolab server, however, there is no need for each user to "publish"
+free/busy data -- it is generated on-the-fly from the server-side calendar
+of the user being queried. Note: in order to support Kolab clients, you must
+have WebCit running in HTTPS mode on port 443, because that is what Kolab
+clients will be expecting.
+
+
+ HTTPS (encryption) SUPPORT
+ --------------------------
+
+ WebCit now supports HTTPS for encrypted connections. When a secure server
+port is specified via the "-s" flag, an HTTPS service is enabled.
+
+ The service will look in the "keys" directory for the following files:
+
+ citadel.key (your server's private key)
+ citadel.csr (a certificate signing request)
+ citadel.cer (your server's public certificate)
+
+ If any of these files are not found, WebCit will first attempt to link to the
+SSL files in the Citadel service's directory (if Citadel is running on the
+same host as WebCit), and if that does not succeed, it will automatically
+generate a key and certificate.
+
+ It is up to you to decide whether to use an automatically generated,
+self-signed certificate, or purchase a certificate signed by a well known
+authority.
+
CONCLUSION
----------
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/UX, at
+comments, please visit UNCENSORED! BBS, the home of Citadel, at
uncensored.citadel.org.
projects / citadel.git / blobdiff