webcit/README

   1                         WEBCIT for the Citadel System
   2                                version 6.71
   3
   4    Copyright (C) 1996-2006 by the authors.  Portions written by:
   5         Art Cancro
   6         Nathan Bryant
   7         Wilifried Goesgens
   8         Nick Grossman
   9         Andru Luvisi
  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, version 2.  Please read COPYING.txt for more
  15    licensing information.
  16
  17    WebCit bundles the Prototype JavaScript Framework, writen by Sam
  18    Stephenson [http://prototype.conio.net].  These components are licensed to
  19    you under the terms of an MIT-style license.
  20
  21    WebCit bundles the script.aculo.us JavaScript library, written by
  22    Thomas Fuchs [http://script.aculo.us, http://mir.aculo.us].  These
  23    components are licensed to you under the terms of an MIT-style license.
  24
  25    WebCit bundles the TinyMCE text editor, written by Moxiecode Systems AB
  26    (http://tinymce.moxiecode.com/tinymce/docs/credits.html).  This component
  27    is licensed to you under the terms of the GNU Lesser General Public
  28    License.
  29
  30    The Citadel logo was designed by Lisa Aurigemma.
  31
  32
  33  INTRODUCTION
  34  ------------
  35
  36  Citadel is a sophisticated groupware and BBS package which allows multiple
  37 users to simultaneously access the system using a variety of user interfaces.
  38 This package (WebCit) is a "middleware" package which presents an HTML/HTTP
  39 user interface to the Citadel system.
  40
  41  What this means in practice is that after you've installed WebCit, users can
  42 access all functions of your system using any web browser.  Since this may be
  43 the first Citadel experience for many new users, the screens have been designed
  44 to be attractive and easy to navigate.
  45
  46
  47  INSTALLATION
  48  ------------
  49
  50  Unline some web-based packages, WebCit contains its own standalone HTTP
  51 engine.  As a result, you can get it running quickly without all that tedious
  52 mucking about with Apache configuration files and directories.  WebCit is not
  53 intended to replace your Apache server, however -- it *only* provides a front
  54 end to Citadel.  If you do not have another web server running, you may run
  55 WebCit on port 80; however, in the more likely situation that you have Apache
  56 or some other web server listening on port 80, you must run WebCit on another
  57 port.  The default is port 2000.
  58
  59  To compile from source, enter the usual commands:
  60   ./configure --prefix=/usr/local/webcit   [or whatever directory you prefer]
  61   make
  62   make install
  63
  64  Package/Ports Maintainers: to make webcit fit smart into LHFS-ified systems
  65  read on at the end of this file, Advanced configure options.
  66
  67  Then to initialize it:
  68   cd /usr/local/webcit
  69   ./setup
  70
  71  After running setup, you just point your web browser to whatever port you
  72 specified, such as:
  73
  74   http://your.host.name:2000
  75
  76  ...and log in.
  77
  78  The included "setup" program is basically just an installation helper that
  79 asks a series of questions and then adds the appropriate line to inittab to
  80 start WebCit.  For most installations, this will do just fine.  If you have
  81 special circumstances, or if you'd prefer to configure WebCit manually, you
  82 may skip the setup program.  Instead, open /etc/inittab and add an entry
  83 something like this:
  84
  85  wc:2345:respawn:/usr/local/webcit/webserver
  86
  87
  88  Several command-line options are also available.  Here's the usage for
  89 the "webserver" program:
  90
  91  webserver [-i ip_addr] [-p http_port] [-s] [-t tracefile]
  92            [-c] [-f] [remotehost [remoteport]]
  93
  94    *or*
  95
  96  webserver [-i ip_addr] [-p http_port] [-s] [-t tracefile]
  97            [-c] [-f] uds /your/citadel/directory
  98
  99  Explained:
 100
 101   -> ip_addr: the IP address on which you wish your WebCit server to run.
 102      You can leave this out, in which case WebCit will listen on all
 103      available network interfaces.  Normally this will be the case, but if
 104      you are running multiple Citadel systems on one host, it can be useful.
 105
 106   -> http_port: the TCP port on which you wish your WebCit server to run.  If
 107      you are installing WebCit on a dedicated server, you can use the
 108      standard port 80.  Otherwise, if port 80 is already occupied by some
 109      other web service (probably Apache), then you'll need to select a
 110      different port.  If you do not specify a port number, WebCit will attempt
 111      to use port 2000.
 112
 113   -> tracefile: where you want WebCit to log to.  This can be a file, a
 114      virtual console, or /dev/null to suppress logging altogether.
 115
 116   -> The "-c" option causes WebCit to output an extra cookie containing the
 117      identity of the WebCit server.  The cookie will look like this:
 118        Set-cookie: wcserver=your.host.name
 119      This is useful if you have a cluster of WebCit servers sitting behind a
 120      load balancer, and the load balancer has the ability to use cookies to
 121      keep track of which server to send HTTP requests to.
 122
 123   -> The "-s" option causes WebCit to present an HTTPS (SSL-encrypted) web
 124      service.  If you want to do both HTTP and HTTPS, you can simply run two
 125      instances of WebCit on two different ports.
 126
 127   -> The "-f" option tells WebCit that it is allowed to follow the
 128      "X-Forwarded-For:" HTTP headers which may be added if your WebCit service
 129      is sitting behind a front end proxy.  This will allow users in your "Who
 130      is online?" list to appear as connecting from their actual host address
 131      instead of the address of the proxy.  In addition, the
 132      "X-Forwarded-Host:" header from the front end proxy will also be honored,
 133      which will help to make automatically generated absolute URL's (for
 134      things like GroupDAV and mailing list subscriptions) correct.
 135
 136   -> remotehost: the name or IP address of the host on which your Citadel
 137      server is running.  The default is "localhost".
 138
 139   -> remoteport: the port number on which your Citadel server is running.
 140      The default is port 504, the IANA-designated standard port for Citadel.
 141
 142   -> "uds" is a keyword which tells WebCit that you wish to connect to a
 143      Citadel server running on the same computer, rather than using a TCP/IP
 144      socket.  /your/citadel/directory should be set to the actual name of the
 145      directory in which you have Citadel installed
 146      (such as /usr/local/citadel).  If you run Citadel and WebCit on the same
 147      computer, this is recommended, as it will run much faster.
 148
 149
 150  GRAPHICS
 151  --------
 152
 153  WebCit contains graphics, templates, JavaScript code, etc. which are kept
 154 in its "static" subdirectory.  All site-specific graphics, however, are
 155 fetched from the Citadel server.
 156
 157  The "images" directory on a Citadel system contains these graphics.  The
 158 ones which you may be interested in are:
 159
 160  -> background.gif: a background texture displayed under all web pages
 161  -> hello.gif: your system's logo.  It is displayed along with the logon
 162     banner, and on the top left corner of each page.
 163
 164  If you would like to deploy a "favicon.ico" graphic, please put it in
 165 the static/ directory.  WebCit will properly serve it from there.
 166
 167
 168  CALENDAR SERVICE
 169  ----------------
 170
 171  WebCit contains support for calendaring and scheduling.  In order to use it
 172 you must have libical v0.24 (or newer) on your system.  You must also be
 173 running a Citadel server with calendaring support.  The calendar service will
 174 be automatically configured and installed if your host system supports it.
 175
 176  WebCit also provides Kolab-compatible free/busy data for calendar clients.
 177 Unlike the Kolab server, however, there is no need for each user to "publish"
 178 free/busy data -- it is generated on-the-fly from the server-side calendar
 179 of the user being queried.  Note: in order to support Kolab clients, you must
 180 have WebCit running in HTTPS mode on port 443, because that is what Kolab
 181 clients will be expecting.
 182
 183
 184  HTTPS (encryption) SUPPORT
 185  --------------------------
 186
 187  WebCit now supports HTTPS for encrypted connections.  When a secure server
 188 port is specified via the "-s" flag, an HTTPS service is enabled.
 189
 190  The service will look in the "keys" directory for the following files:
 191
 192  citadel.key   (your server's private key)
 193  citadel.csr   (a certificate signing request)
 194  citadel.cer   (your server's public certificate)
 195
 196  If any of these files are not found, WebCit will first attempt to link to the
 197 SSL files in the Citadel service's directory (if Citadel is running on the
 198 same host as WebCit), and if that does not succeed, it will automatically
 199 generate a key and certificate.
 200
 201  It is up to you to decide whether to use an automatically generated,
 202 self-signed certificate, or purchase a certificate signed by a well known
 203 authority.
 204
 205
 206  INTEGRATING INTO APACHE
 207  -----------------------
 208
 209  If you want to include webcit into an Apache, because of you want to have it
 210 running alongside your i.e. php applications without adding another ip or using a
 211 different port than 443 / 80 (which may be blocked by company firewalls for
 212 example) you can do this with apaches mod_proxy. One can do this either to make
 213 webcit fill up into a full vhost (like webcit.mydomain.com) or to go into a
 214 subdirectory (like www.mydomain.com/webcit). find two config snippets, that can
 215 be added to apaches sample ssl config (which you may find in
 216 /usr/share/doc/apache2/examples/ssl.conf for example) Warning: you should be somewhat
 217 experienced with configuring apache to do that!
 218
 219 VHOST context:
 220 <VirtualHost mydomain.com:443>
 221         #here some of your config stuff like logging, serveradmin...
 222         NameVirtualHost www.mydomain.com
 223     <location />
 224          allow from all
 225     </location>
 226
 227     ProxyPass / http://127.0.0.1:2000/
 228     ProxyPassReverse / http://127.0.0.1:2000/
 229 # make apache give away static content like images...
 230     alias /static /var/lib/citadel/www/static
 231
 232 </VirtualHost>
 233
 234 SUBDIR context:
 235 <VirtualHost mydomain.com:443>
 236         #here some of your config stuff like logging, serveradmin...
 237         NameVirtualHost www.mydomain.com
 238     <location /webcit>
 239       allow from all
 240     </location>
 241     <location /listsub>
 242       allow from all
 243     </location>
 244     <location /groupdav>
 245       allow from all
 246     </location>
 247     <location /who_inner_html>
 248       allow from all
 249     </location>
 250
 251     ProxyPass /webcit/ http://127.0.0.1:2000/webcit/
 252     ProxyPassReverse /webcit/ http://127.0.0.1:2000/webcit/
 253     ProxyPass /listsub/ http://127.0.0.1:2000/listsub/
 254     ProxyPassReverse /listsub/ http://127.0.0.1:2000/listsub/
 255     ProxyPass /groupdav/ http://127.0.0.1:2000/groupdav/
 256     ProxyPassReverse /groupdav/ http://127.0.0.1:2000/groupdav/
 257     ProxyPass /who_inner_html http://127.0.0.1:2000/who_inner_html
 258     ProxyPassReverse /who_inner_html http://127.0.0.1:2000/who_inner_html
 259 # make apache give away static content like images...
 260     alias /static /var/lib/citadel/www/static
 261 </VirtualHost>
 262
 263  CONCLUSION
 264  ----------
 265
 266  That's all you need to know to get started.  If you have any questions or
 267 comments, please visit UNCENSORED! BBS, the home of Citadel, at
 268 uncensored.citadel.org.
 269
 270
 271  ADVANCED CONFIGURE OPTIONS
 272  --------------------------
 273
 274  To make webcit integrate smothly into your system there are several options available.
 275 --with-staticdir defines where webcit should put'n search its templates and images. If you
 276 want to go with a different Installation location then the point it is accessed at runtime,
 277 you can use --with-staticrundir. This option is meant to ease your needs if you're going
 278 to install the static files as 'examples' in a location like /usr/share/doc/webcit/examples,
 279 and enable the user to copy them over to another dir (like /var/lib/citadel/www), where
 280 they're accessed at runtime. (The debian instatll scripts provided with this package
 281 do this to preserve user changes to the template system, see debian/citadel-webcit.postinstall)
 282
 283 Further there are possibilities to load the tiny_mce editor into a system uniq location. Webcit
 284 uses this standard component compose its messages for mails and postings. Several webcit installations
 285 that may differ in design but use the same tiny_mce (which is the default that webcit ships with)
 286 (set --with-editordir for that, it defaults to the dir the templates go)