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