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