* Set version number to 7.50 across the entire system in preparation for upcoming...
[citadel] / webcit / README.txt
1                         WEBCIT for the Citadel System
2  
3    Copyright (C) 1996-2009 by the authors.  Portions written by:
4  
5         Art Cancro
6         Wilfried Goesgens
7         Dave West
8         Thierry Pasquier
9         Nathan Bryant
10         Nick Grossman
11         Andru Luvisi
12         Alessandro Fulciniti
13         Dave Lindquist
14         Matt Pfleger
15         Martin Mouritzen
16
17    This program is open source software released under the terms of the GNU
18    General Public License, version 3.  Please read COPYING.txt for more
19    licensing information.
20  
21    WebCit bundles the Prototype JavaScript Framework, writen by Sam
22    Stephenson [http://prototype.conio.net].  These components are licensed to
23    you under the terms of an MIT-style license.
24
25    WebCit bundles the script.aculo.us JavaScript library, written by
26    Thomas Fuchs [http://script.aculo.us, http://mir.aculo.us].  These
27    components are licensed to you under the terms of an MIT-style license.
28
29    WebCit bundles the TinyMCE text editor, written by Moxiecode Systems AB
30    (http://tinymce.moxiecode.com/tinymce/docs/credits.html).  This component
31    is licensed to you under the terms of the GNU Lesser General Public
32    License.
33
34    WebCit bundles the Nifty Corners library, written by Alessandro Fulciniti
35    [http://cerca.html.it/cgi-bin/cerca.cgi?q=nifty+corners].  This component
36    is licensed to you under the terms of the GNU General Public License.
37
38    One or more icons are from Milosz Wlazlo [http://miloszwl.deviantart.com]
39    whose license explicitly allows inclusion in open source projects on the
40    condition of this attribution.
41
42    The Citadel logo was designed by Lisa Aurigemma.
43
44  
45  INTRODUCTION
46  ------------
47  
48  Citadel is a sophisticated groupware platform which allows multiple
49 users to simultaneously access the system using a variety of user interfaces.
50 This package (WebCit) is a "middleware" package which presents an HTML/HTTP
51 user interface to the Citadel system.
52  
53  What this means in practice is that after you've installed WebCit, users can
54 access all functions of your system using any web browser.  Since this may be
55 the first Citadel experience for many new users, the screens have been designed
56 to be attractive and easy to navigate.
57  
58  
59  INSTALLATION
60  ------------
61  
62  Unline some web-based packages, WebCit contains its own standalone HTTP
63 engine.  As a result, you can get it running quickly without all that tedious
64 mucking about with Apache configuration files and directories.  WebCit is not
65 intended to be a general-purpose web server, however -- it *only* provides a
66 front end to Citadel.  If you do not have another web server running, you may
67 run WebCit on port 80; however, if you have Apache or some other web server
68 listening on port 80, you must run WebCit on another port.  If you do not
69 specify a port number, WebCit will bind to port 2000.
70  
71  To compile from source, enter the usual commands:
72   ./configure --prefix=/usr/local/webcit   [or whatever directory you prefer]
73   make
74   make install
75  
76  Package/Ports Maintainers: to make webcit fit smart into LHFS-ified systems
77  read on at the end of this file, Advanced configure options.
78
79  Then to initialize it:
80   cd /usr/local/webcit
81   ./setup
82  
83  After running setup, you just point your web browser to whatever port you
84 specified, such as:
85  
86   http://your.host.name
87  
88  (or if you specified some other port, such as 2000 in this example...)
89  
90   http://your.host.name:2000
91  
92  ...and log in.
93  
94  The included "setup" program is basically just an installation helper that
95 asks a series of questions and then adds the appropriate line to inittab to
96 start WebCit.  For most installations, this will do just fine.  If you have
97 special circumstances, or if you'd prefer to configure WebCit manually, you
98 may skip the setup program.  Instead, open /etc/inittab and add an entry
99 something like this:
100  
101  wc:2345:respawn:/usr/local/webcit/webcit
102  
103  
104  Several command-line options are also available.  Here's the usage for
105 the "webcit" program:
106   
107  webcit [-i ip_addr] [-p http_port] [-s] [-t tracefile]
108            [-c] [-f] [remotehost [remoteport]]
109  
110    *or*
111  
112  webcit [-i ip_addr] [-p http_port] [-s] [-t tracefile]
113            [-c] [-f] uds /your/citadel/directory
114  
115  Explained: 
116   
117   -> ip_addr: the IP address on which you wish your WebCit server to run.
118      You can leave this out, in which case WebCit will listen on all
119      available network interfaces.  Normally this will be the case, but if
120      you are running multiple Citadel systems on one host, it can be useful.
121      You can also use this option to run Apache and WebCit on different IP
122      addresses instead of different ports, if you have them available.
123  
124   -> http_port: the TCP port on which you wish your WebCit server to run.  If
125      you are installing WebCit on a dedicated server, you can use the
126      standard port 80.  Otherwise, if port 80 is already occupied by some
127      other web service (probably Apache), then you'll need to select a
128      different port.  If you do not specify a port number, WebCit will attempt
129      to use port 80.
130      
131   -> tracefile: where you want WebCit to log to.  This can be a file, a
132      virtual console, or /dev/null to suppress logging altogether.
133  
134   -> The "-c" option causes WebCit to output an extra cookie containing the
135      identity of the WebCit server.  The cookie will look like this:
136        Set-cookie: wcserver=your.host.name
137      This is useful if you have a cluster of WebCit servers sitting behind a
138      load balancer, and the load balancer has the ability to use cookies to
139      keep track of which server to send HTTP requests to.
140  
141   -> The "-s" option causes WebCit to present an HTTPS (SSL-encrypted) web
142      service.  If you want to do both HTTP and HTTPS, you can simply run two
143      instances of WebCit on two different ports.
144
145   -> The "-f" option tells WebCit that it is allowed to follow the
146      "X-Forwarded-For:" HTTP headers which may be added if your WebCit service
147      is sitting behind a front end proxy.  This will allow users in your "Who
148      is online?" list to appear as connecting from their actual host address
149      instead of the address of the proxy.  In addition, the
150      "X-Forwarded-Host:" header from the front end proxy will also be honored,
151      which will help to make automatically generated absolute URL's (for
152      things like GroupDAV and mailing list subscriptions) correct.
153  
154   -> remotehost: the name or IP address of the host on which your Citadel
155      server is running.  The default is "localhost".
156  
157   -> remoteport: the port number on which your Citadel server is running.
158      The default is port 504, the IANA-designated standard port for Citadel.
159  
160   -> "uds" is a keyword which tells WebCit that you wish to connect to a
161      Citadel server running on the same computer, rather than using a TCP/IP
162      socket.  /your/citadel/directory should be set to the actual name of the
163      directory in which you have Citadel installed
164      (such as /usr/local/citadel).  If you run Citadel and WebCit on the same
165      computer, this is recommended, as it will run much faster.
166  
167  
168  GRAPHICS
169  --------
170  
171  WebCit contains graphics, templates, JavaScript code, etc. which are kept
172 in its "static" subdirectory.  All site-specific graphics, however, are
173 fetched from the Citadel server.
174  
175  The "images" directory on a Citadel system contains these graphics.  The
176 ones which you may be interested in are:
177  
178  -> background.gif: a background texture displayed under all web pages
179  -> hello.gif: your system's logo.  It is displayed along with the logon
180     banner, and on the top left corner of each page.
181  
182  If you would like to deploy a "favicon.ico" graphic, please put it in
183 the static/ directory.  WebCit will properly serve it from there.
184  
185
186  CUSTOMIZATION
187  -------------
188
189  The default WebCit installation will create an empty directory called 
190 "static.local".  In this directory you may place a file called "webcit.css"
191 which, if present, is referenced *after* the default stylesheet.  If you
192 know CSS and wish to customize your WebCit installation, any styles you
193 declare in static.local/webcit.css will override the styles found in
194 static/webcit.css -- and your customizations will not be overwritten when
195 you upgrade WebCit later.
196
197  You may also place other files, such as images, in static.local for
198 further customization.
199
200  
201  CALENDAR SERVICE
202  ----------------
203  
204  WebCit contains support for calendaring and scheduling.  In order to use it
205 you must have libical v0.26 (or newer) on your system.  You must also be
206 running a Citadel server with calendaring support.  The calendar service will
207 be automatically configured and installed if your host system supports it.
208  
209  WebCit also provides iCalendar format free/busy data for calendar clients.
210 Unlike with some other servers, there is no need for each user to "publish"
211 free/busy data -- it is generated on-the-fly from the server-side calendar
212 of the user being queried.
213   
214  
215  HTTPS (encryption) SUPPORT
216  --------------------------
217  
218  WebCit now supports HTTPS for encrypted connections.  When a secure server
219 port is specified via the "-s" flag, an HTTPS service is enabled.
220  
221  The service will look in the "keys" directory for the following files:
222  
223  citadel.key   (your server's private key)
224  citadel.csr   (a certificate signing request)
225  citadel.cer   (your server's public certificate)
226  
227  If any of these files are not found, WebCit will first attempt to link to the
228 SSL files in the Citadel service's directory (if Citadel is running on the
229 same host as WebCit), and if that does not succeed, it will automatically
230 generate a key and certificate.
231  
232  It is up to you to decide whether to use an automatically generated,
233 self-signed certificate, or purchase a certificate signed by a well known
234 authority.
235
236
237  INTEGRATING INTO APACHE
238  -----------------------
239
240  It is best to run WebCit natively on its own HTTP port.  If, however, you wish
241 to have WebCit run as part of an Apache web server installation (for example,
242 you only have one IP address and you need to stay on port 80 or 443 in order to
243 maintain compatibility with corporate firewall policy), you can do this with
244 the "mod_proxy" Apache module.
245  
246  The preferred way to do this is to configure a NameVirtualHost for your WebCit
247 installation (for example, http://webcit.example.com) and then proxy that
248 virtual host through to WebCit.  The alternative way, which does work but is not
249 quite as robust, is to "mount" the WebCit paths as directory aliases to your
250 main document root.
251
252 Here is how to configure the NameVirtualHost method:
253
254 <VirtualHost mydomain.com:443>
255         #here some of your config stuff like logging, serveradmin...
256         NameVirtualHost www.mydomain.com
257     <location />
258          allow from all
259     </location>
260     ProxyPass / http://127.0.0.1:2000/
261     ProxyPassReverse / http://127.0.0.1:2000/
262 # The following line is optional.  It allows WebCit's static content
263 # such as images to be served directly by Apache.
264     alias /static /var/lib/citadel/www/static
265 </VirtualHost>
266
267 Here is how to configure the "subdirectory" method:
268
269 <VirtualHost mydomain.com:443>
270         #here some of your config stuff like logging, serveradmin...
271         NameVirtualHost www.mydomain.com
272     <location /webcit>
273       allow from all
274     </location>
275     <location /listsub>
276       allow from all
277     </location>
278     <location /groupdav>
279       allow from all
280     </location>
281     <location /who_inner_html>
282       allow from all
283     </location>
284
285     ProxyPass /webcit/ http://127.0.0.1:2000/webcit/
286     ProxyPassReverse /webcit/ http://127.0.0.1:2000/webcit/
287     ProxyPass /listsub/ http://127.0.0.1:2000/listsub/
288     ProxyPassReverse /listsub/ http://127.0.0.1:2000/listsub/
289     ProxyPass /groupdav/ http://127.0.0.1:2000/groupdav/
290     ProxyPassReverse /groupdav/ http://127.0.0.1:2000/groupdav/
291     ProxyPass /who_inner_html http://127.0.0.1:2000/who_inner_html
292     ProxyPassReverse /who_inner_html http://127.0.0.1:2000/who_inner_html
293 # The following line is optional.  It allows WebCit's static content
294 # such as images to be served directly by Apache.
295     alias /static /var/lib/citadel/www/static
296 </VirtualHost>
297
298   
299  ADVANCED CONFIGURE OPTIONS
300  --------------------------
301  
302 If you are building packages and prefer not to have WebCit reside entirely in
303 a single directory, there are several compile-time options available.
304
305 --with-wwwdir defines where webcit should locate and search its templates and images. 
306 --with-localedir defines where to put webcits locale files.
307
308 Also, there are possibilities to load the TinyMCE editor into a system-wide location.  WebCit 
309 uses this standard component to compose its messages for messages and postings. Several WebCit installations
310 that may differ in design but use the same TinyMCE (which is the default that WebCit ships with)
311 (set --with-editordir for that, it defaults to the dir the templates go)
312
313 Install targets have diversified to reflect these changes too:
314  (make install-.....)
315 locale: the webcit .mo files for gettext & locales.
316 tinymce: the editor. if your system brings one, just ommit this.
317 wwwdata: our templates.
318 setupbin: if you want to use webcits setup facility... but isn't needed in case you provide own init & config scripts.
319 bin: the binaries.
320
321
322  CONCLUSION
323  ----------
324  
325  That's all you need to know to get started.  If you have any questions or
326 comments, please visit UNCENSORED! BBS, the home of Citadel, at
327 http://uncensored.citadel.org - and go to the "Citadel Support" room.
328
329