webcit/README.txt

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