WEBCIT for the Citadel/UX System
- version 2.00
+ version 4.10
+
+ Copyright (C) 1996-2003 by the authors. Portions written by:
+ Art Cancro
+ Nathan Bryant
+ Nick Grossman
+ Andru Luvisi
- Copyright (C) 1996-1999 by Art Cancro, Nathan Bryant, and Nick Grossman
This program is free software released under the terms of the GNU General
Public License. Please read COPYING.txt for more licensing information.
INTRODUCTION
------------
- Citadel/UX is a sophisticated 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.
+ Citadel/UX is a sophisticated BBS and groupware 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.
What this means in practice is that after you've installed WebCit, users can
-access all functions of your BBS using any web browser. Since this may be the
-first Citadel experience for many new users, the screens have been designed to
-be attractive and easy to navigate.
+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
+to be attractive and easy to navigate.
INSTALLATION
------------
- If you've installed WebCit v1.xx before, you'll be pleased to know that the
-new version doesn't require all that tedious mucking about with Apache
-configuration files and directories. WebCit now contains its own standalone
-webserver, which you run on another port (port 2000 by default).
+ Unline 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 replace your Apache server, however -- it *only* provides a front
+end to Citadel. If you do not have another web server running, you may run
+WebCit on port 80; however, in the more likely situation that you have Apache
+or some other web server listening on port 80, you must run WebCit on another
+port. The default is port 2000.
To compile from source, enter the usual commands:
./configure
Several command-line options are also available. Here's the usage for
the "webserver" program:
- webserver [-p localport] [-t tracefile] [remotehost [remoteport]]
+ webserver [-p localport] [-t tracefile] [-c] [remotehost [remoteport]]
+
+ *or*
+
+ webserver [-p localport] [-t tracefile] [-c] uds /your/citadel/directory
Explained:
-> tracefile: where you want WebCit to log to. This can be a file, a
virtual console, or /dev/null to suppress logging altogether.
+ -> The "-c" option causes WebCit to output an extra cookie containing the
+ identity of the WebCit server. The cookie will look like this:
+ Set-cookie: wcserver=your.host.name
+ This is useful if you have a cluster of WebCit servers sitting behind a
+ 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
-> remoteport: the port number on which your Citadel/UX 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
+ Citadel server running on the same computer, rather than using a TCP/IP
+ socket. /your/citadel/directory should be set to the actual name of the
+ directory in which you have Citadel installed
+ (such as /usr/local/citadel). If you run Citadel and WebCit on the same
+ computer, this is recommended, as it will run much faster.
+
GRAPHICS
--------
banner, and on the top left corner of each page.
+ CALENDAR SERVICE
+ ----------------
+
+ WebCit contains support for calendaring and scheduling. In order to use it
+you must have libical v0.24 (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.
+
+
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 one of the
-following locations:
- via Internet: uncnsrd.mt-kisco.ny.us
- modem dialup: 914-244-3252
+comments, please visit UNCENSORED! BBS, the home of Citadel/UX, at
+uncensored.citadel.org.
projects / citadel.git / blobdiff