webcit/README.txt

   1                         WEBCIT for the Citadel System
   2                                version 6.21
   3
   4    Copyright (C) 1996-2005 by the authors.  Portions written by:
   5         Art Cancro
   6         Nathan Bryant
   7         Wilifried Goesgens
   8         Nick Grossman
   9         Andru Luvisi
  10         Kevin Roth
  11         Dave Lindquist
  12         Martin Mouritzen
  13
  14    This program is open source software released under the terms of the GNU
  15    General Public License.  Please read COPYING.txt for more licensing
  16    information.
  17
  18    WebCit bundles the Rico Ajax Engine, written by Darren James, Bill Scott,
  19    et. al. [http://www.openrico.org].  These components are licensed to you
  20    under the terms of the Apache 2.0 License.
  21
  22    WebCit bundles the Prototype JavaScript Framework, writen by Sam
  23    Stephenson [http://prototype.conio.net].  These components are licensed to
  24    you under the terms of an MIT-style license.
  25
  26    The Citadel logo was designed by Lisa Aurigemma.
  27
  28  INTRODUCTION
  29  ------------
  30
  31  Citadel is a sophisticated groupware and BBS package which allows multiple
  32 users to simultaneously access the system using a variety of user interfaces.
  33 This package (WebCit) is a "middleware" package which presents an HTML/HTTP
  34 user interface to the Citadel system.
  35
  36  What this means in practice is that after you've installed WebCit, users can
  37 access all functions of your system using any web browser.  Since this may be
  38 the first Citadel experience for many new users, the screens have been designed
  39 to be attractive and easy to navigate.
  40
  41
  42  INSTALLATION
  43  ------------
  44
  45  Unline some web-based packages, WebCit contains its own standalone HTTP
  46 engine.  As a result, you can get it running quickly without all that tedious
  47 mucking about with Apache configuration files and directories.  WebCit is not
  48 intended to replace your Apache server, however -- it *only* provides a front
  49 end to Citadel.  If you do not have another web server running, you may run
  50 WebCit on port 80; however, in the more likely situation that you have Apache
  51 or some other web server listening on port 80, you must run WebCit on another
  52 port.  The default is port 2000.
  53
  54  To compile from source, enter the usual commands:
  55   ./configure --prefix=/usr/local/webcit   [or whatever directory you prefer]
  56   make
  57   make install
  58
  59  Then to initialize it:
  60   cd /usr/local/webcit
  61   ./setup
  62
  63  After running setup, you just point your web browser to whatever port you
  64 specified, such as:
  65
  66   http://your.host.name:2000
  67
  68  ...and log in.
  69
  70  The included "setup" program is basically just an installation helper that
  71 asks a series of questions and then adds the appropriate line to inittab to
  72 start WebCit.  For most installations, this will do just fine.  If you have
  73 special circumstances, or if you'd prefer to configure WebCit manually, you
  74 may skip the setup program.  Instead, open /etc/inittab and add an entry
  75 something like this:
  76
  77  wc:2345:respawn:/usr/local/webcit/webserver
  78
  79
  80  Several command-line options are also available.  Here's the usage for
  81 the "webserver" program:
  82
  83  webserver [-i ip_addr] [-p http_port] [-s] [-t tracefile]
  84            [-c] [remotehost [remoteport]]
  85
  86    *or*
  87
  88  webserver [-i ip_addr] [-p http_port] [-s] [-t tracefile]
  89            [-c] uds /your/citadel/directory
  90
  91  Explained:
  92
  93   -> ip_addr: the IP address on which you wish your WebCit server to run.
  94      You can leave this out, in which case WebCit will listen on all
  95      available network interfaces.  Normally this will be the case, but if
  96      you are running multiple Citadel systems on one host, it can be useful.
  97
  98   -> http_port: the TCP port on which you wish your WebCit server to run.
  99      This can be any port number at all; there is no standard.  Naturally,
 100      you'll want to create a link to this port on your system's regular web
 101      pages (presumably on an Apache server running on port 80).  Or, if you
 102      are installing WebCit on a dedicated server, then you might choose to
 103      use port 80 after all.
 104
 105   -> tracefile: where you want WebCit to log to.  This can be a file, a
 106      virtual console, or /dev/null to suppress logging altogether.
 107
 108   -> The "-c" option causes WebCit to output an extra cookie containing the
 109      identity of the WebCit server.  The cookie will look like this:
 110        Set-cookie: wcserver=your.host.name
 111      This is useful if you have a cluster of WebCit servers sitting behind a
 112      load balancer, and the load balancer has the ability to use cookies to
 113      keep track of which server to send HTTP requests to.
 114
 115   -> The "-s" option causes WebCit to present an HTTPS (SSL-encrypted) web
 116      service.  If you want to do both HTTP and HTTPS, you can simply run two
 117      instances of WebCit on two different ports.
 118
 119   -> remotehost: the name or IP address of the host on which your Citadel
 120      server is running.  The default is "localhost".
 121
 122   -> remoteport: the port number on which your Citadel server is running.
 123      The default is port 504, the IANA-designated standard port for Citadel.
 124
 125   -> "uds" is a keyword which tells WebCit that you wish to connect to a
 126      Citadel server running on the same computer, rather than using a TCP/IP
 127      socket.  /your/citadel/directory should be set to the actual name of the
 128      directory in which you have Citadel installed
 129      (such as /usr/local/citadel).  If you run Citadel and WebCit on the same
 130      computer, this is recommended, as it will run much faster.
 131
 132
 133  GRAPHICS
 134  --------
 135
 136  WebCit contains a small amount of graphics (icons, etc.) which are kept
 137 in its "static" subdirectory.  All site-specific graphics, however, are
 138 fetched from the Citadel server.
 139
 140  The "images" directory on a Citadel system contains these graphics.  The
 141 ones which you may be interested in are:
 142
 143  -> background.gif: a background texture displayed under all web pages
 144  -> hello.gif: your system's logo.  It is displayed along with the logon
 145     banner, and on the top left corner of each page.
 146
 147  If you would like to deploy a "favicon.ico" graphic, please put it in
 148 the static/ directory.  WebCit will properly serve it from there.
 149
 150
 151  CALENDAR SERVICE
 152  ----------------
 153
 154  WebCit contains support for calendaring and scheduling.  In order to use it
 155 you must have libical v0.24 (or newer) on your system.  You must also be
 156 running a Citadel server with calendaring support.  The calendar service will
 157 be automatically configured and installed if your host system supports it.
 158
 159  WebCit also provides Kolab-compatible free/busy data for calendar clients.
 160 Unlike the Kolab server, however, there is no need for each user to "publish"
 161 free/busy data -- it is generated on-the-fly from the server-side calendar
 162 of the user being queried.  Note: in order to support Kolab clients, you must
 163 have WebCit running in HTTPS mode on port 443, because that is what Kolab
 164 clients will be expecting.
 165
 166
 167  HTTPS (encryption) SUPPORT
 168  --------------------------
 169
 170  WebCit now supports HTTPS for encrypted connections.  When a secure server
 171 port is specified via the "-s" flag, an HTTPS service is enabled.
 172
 173  The service will look in the "keys" directory for the following files:
 174
 175  citadel.key   (your server's private key)
 176  citadel.csr   (a certificate signing request)
 177  citadel.cer   (your server's public certificate)
 178
 179  If any of these files are not found, WebCit will first attempt to link to the
 180 SSL files in the Citadel service's directory (if Citadel is running on the
 181 same host as WebCit), and if that does not succeed, it will automatically
 182 generate a key and certificate.
 183
 184  It is up to you to decide whether to use an automatically generated,
 185 self-signed certificate, or purchase a certificate signed by a well known
 186 authority.
 187
 188
 189  CONCLUSION
 190  ----------
 191
 192  That's all you need to know to get started.  If you have any questions or
 193 comments, please visit UNCENSORED! BBS, the home of Citadel, at
 194 uncensored.citadel.org.