webcit/README.txt

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