webcit/README.txt

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