webcit/README.txt

   1                       WEBCIT for the Citadel/UX System
   2                                version 5.10
   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 https_port] [-t tracefile]
  71            [-c] [remotehost [remoteport]]
  72
  73    *or*
  74
  75  webserver [-p http_port] [-s https_port] [-t tracefile]
  76            [-c] uds /your/citadel/directory
  77
  78  Explained:
  79
  80   -> http_port: the TCP port on which you wish your WebCit server to run.
  81      this can be any port number at all; there is no standard.  Naturally,
  82      you'll want to create a link to this port on your system's regular web
  83      pages (presumably on an Apache server running on port 80).  Or, if you
  84      are installing WebCit on a dedicated server, then you might choose to
  85      use port 80 after all.
  86
  87   -> https_port: an optional TCP port on which you wish your WebCit server
  88      to run an SSL-encrypted web service.  The standard port number for this
  89      is 443, and if you're not already running a secure web server you might
  90      choose to use that port.  Otherwise, select any free port number.
  91
  92   -> tracefile: where you want WebCit to log to.  This can be a file, a
  93      virtual console, or /dev/null to suppress logging altogether.
  94
  95   -> The "-c" option causes WebCit to output an extra cookie containing the
  96      identity of the WebCit server.  The cookie will look like this:
  97        Set-cookie: wcserver=your.host.name
  98      This is useful if you have a cluster of WebCit servers sitting behind a
  99      load balancer, and the load balancer has the ability to use cookies to
 100      keep track of which server to send HTTP requests to.
 101
 102   -> remotehost: the name or IP address of the host on which your Citadel/UX
 103      server is running.  The default is "localhost".
 104
 105   -> remoteport: the port number on which your Citadel/UX server is running.
 106      The default is port 504, the IANA-designated standard port for Citadel.
 107
 108   -> "uds" is a keyword which tells WebCit that you wish to connect to a
 109      Citadel server running on the same computer, rather than using a TCP/IP
 110      socket.  /your/citadel/directory should be set to the actual name of the
 111      directory in which you have Citadel installed
 112      (such as /usr/local/citadel).  If you run Citadel and WebCit on the same
 113      computer, this is recommended, as it will run much faster.
 114
 115
 116  GRAPHICS
 117  --------
 118
 119  WebCit contains a small amount of graphics (buttons, etc.) which are kept
 120 in its "static" subdirectory.  All site-specific graphics, however, are
 121 fetched from the Citadel server.
 122
 123  The "images" directory on a Citadel/UX system contains these graphics.  The
 124 ones which you may be interested in are:
 125
 126  -> background.gif: a background texture displayed under all web pages
 127  -> hello.gif: your system's logo.  It is displayed along with the logon
 128     banner, and on the top left corner of each page.
 129
 130  If you would like to deploy a "favicon.ico" graphic, please put it in
 131 the static/ directory.  WebCit will properly serve it from there.
 132
 133
 134  CALENDAR SERVICE
 135  ----------------
 136
 137  WebCit contains support for calendaring and scheduling.  In order to use it
 138 you must have libical v0.24 (or newer) on your system.  You must also be
 139 running a Citadel server with calendaring support.  The calendar service will
 140 be automatically configured and installed if your host system supports it.
 141
 142  WebCit also provides Kolab-compatible free/busy data for calendar clients.
 143 Unlike the Kolab server, however, there is no need for each user to "publish"
 144 free/busy data -- it is generated on-the-fly from the server-side calendar
 145 of the user being queried.
 146
 147
 148  HTTPS (encryption) SUPPORT
 149  --------------------------
 150
 151  WebCit now supports HTTPS for encrypted connections.  When a secure server
 152 port is specified via the "-s" flag, an HTTPS service is enabled.
 153
 154  The service will look in the "keys" directory for the following files:
 155
 156  citadel.key   (your server's private key)
 157  citadel.csr   (a certificate signing request)
 158  citadel.cer   (your server's public certificate)
 159
 160  If any of these files are not found, WebCit will first attempt to link to the
 161 SSL files in the Citadel service's directory (if Citadel is running on the
 162 same host as WebCit), and if that does not succeed, it will automatically
 163 generate a key and certificate.
 164
 165  It is up to you to decide whether to use an automatically generated,
 166 self-signed certificate, or purchase a certificate signed by a well known
 167 authority.
 168
 169
 170  CONCLUSION
 171  ----------
 172
 173  That's all you need to know to get started.  If you have any questions or
 174 comments, please visit UNCENSORED! BBS, the home of Citadel/UX, at
 175 uncensored.citadel.org.