webcit/README.txt

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