X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=webcit%2FREADME.txt;h=f83693debc632db63d569960662dc1f7b839ff7a;hb=b2971ed49d2cfe5128190ec1d5d8c0fa239f0004;hp=628abc2c1d47496be33821edf9364c60e1690cdc;hpb=2c55ab286f3597fa44d41d21715fd38187920596;p=citadel.git diff --git a/webcit/README.txt b/webcit/README.txt index 628abc2c1..f83693deb 100644 --- a/webcit/README.txt +++ b/webcit/README.txt @@ -1,19 +1,19 @@ WEBCIT for the Citadel System - version 6.84 + version 7.11 - Copyright (C) 1996-2006 by the authors. Portions written by: + Copyright (C) 1996-2007 by the authors. Portions written by: Art Cancro - Nathan Bryant - Alessandro Fulciniti Wilifried Goesgens + Nathan Bryant Nick Grossman Andru Luvisi + Alessandro Fulciniti Dave Lindquist Matt Pfleger Martin Mouritzen This program is open source software released under the terms of the GNU - General Public License, version 2. Please read COPYING.txt for more + General Public License, version 3. Please read COPYING.txt for more licensing information. WebCit bundles the Prototype JavaScript Framework, writen by Sam @@ -33,14 +33,13 @@ [http://cerca.html.it/cgi-bin/cerca.cgi?q=nifty+corners]. This component is licensed to you under the terms of the GNU General Public License. - The Citadel logo was designed by Lisa Aurigemma. INTRODUCTION ------------ - Citadel is a sophisticated groupware and BBS package which allows multiple + Citadel is a sophisticated groupware platform which allows multiple users to simultaneously access the system using a variety of user interfaces. This package (WebCit) is a "middleware" package which presents an HTML/HTTP user interface to the Citadel system. @@ -57,11 +56,11 @@ to be attractive and easy to navigate. Unline some web-based packages, WebCit contains its own standalone HTTP engine. As a result, you can get it running quickly without all that tedious mucking about with Apache configuration files and directories. WebCit is not -intended to replace your Apache server, however -- it *only* provides a front -end to Citadel. If you do not have another web server running, you may run -WebCit on port 80; however, in the more likely situation that you have Apache -or some other web server listening on port 80, you must run WebCit on another -port. The default is port 2000. +intended to be a general-purpose web server, however -- it *only* provides a +front end to Citadel. If you do not have another web server running, you may +run WebCit on port 80; however, if you have Apache or some other web server +listening on port 80, you must run WebCit on another port. If you do not +specify a port number, WebCit will bind to port 2000. To compile from source, enter the usual commands: ./configure --prefix=/usr/local/webcit [or whatever directory you prefer] @@ -78,6 +77,10 @@ port. The default is port 2000. After running setup, you just point your web browser to whatever port you specified, such as: + http://your.host.name + + (or if you specified some other port, such as 2000 in this example...) + http://your.host.name:2000 ...and log in. @@ -109,13 +112,15 @@ the "webserver" program: You can leave this out, in which case WebCit will listen on all available network interfaces. Normally this will be the case, but if you are running multiple Citadel systems on one host, it can be useful. + You can also use this option to run Apache and WebCit on different IP + addresses instead of different ports, if you have them available. -> http_port: the TCP port on which you wish your WebCit server to run. If you are installing WebCit on a dedicated server, you can use the standard port 80. Otherwise, if port 80 is already occupied by some other web service (probably Apache), then you'll need to select a different port. If you do not specify a port number, WebCit will attempt - to use port 2000. + to use port 80. -> tracefile: where you want WebCit to log to. This can be a file, a virtual console, or /dev/null to suppress logging altogether. @@ -171,6 +176,21 @@ ones which you may be interested in are: If you would like to deploy a "favicon.ico" graphic, please put it in the static/ directory. WebCit will properly serve it from there. + + CUSTOMIZATION + ------------- + + The default WebCit installation will create an empty directory called +"static.local". In this directory you may place a file called "webcit.css" +which, if present, is referenced *after* the default stylesheet. If you +know CSS and wish to customize your WebCit installation, any styles you +declare in static.local/webcit.css will override the styles found in +static/webcit.css -- and your customizations will not be overwritten when +you upgrade WebCit later. + + You may also place other files, such as images, in static.local for +further customization. + CALENDAR SERVICE ---------------- @@ -276,19 +296,22 @@ Here is how to configure the "subdirectory" method: If you are building packages and prefer not to have WebCit reside entirely in a single directory, there are several compile-time options available. ---with-staticdir defines where webcit should locate and search its templates and images. If you -want to go with a different installation location then the point at which it is accessed at runtime, -you can use --with-staticrundir. This option is meant to ease your needs if you're going -to install the static files as 'examples' in a location like /usr/share/doc/webcit/examples, -and enable the user to copy them over to another dir (like /var/lib/citadel/www), where -they're accessed at runtime. (The debian instatll scripts provided with this package -do this to preserve user changes to the template system, see debian/citadel-webcit.postinstall) +--with-wwwdir defines where webcit should locate and search its templates and images. +--with-localedir defines where to put webcits locale files. Also, there are possibilities to load the TinyMCE editor into a system-wide location. WebCit uses this standard component to compose its messages for messages and postings. Several WebCit installations that may differ in design but use the same TinyMCE (which is the default that WebCit ships with) (set --with-editordir for that, it defaults to the dir the templates go) +Install targets have diversified to reflect these changes too: + (make install-.....) +locale: the webcit .mo files for gettext & locales. +tinymce: the editor. if your system brings one, just ommit this. +wwwdata: our templates. +setupbin: if you want to use webcits setup facility... but isn't needed in case you provide own init & config scripts. +bin: the binaries. + CONCLUSION ----------