]> code.citadel.org Git - citadel.git/blobdiff - webcit/README
Added the 'Nifty Corners' library and implemented our
[citadel.git] / webcit / README
index 55b2d4a0a62d9e9861c69544aac4747d5b39a760..171c0d069cfb7243d4e91f848869222111f2ddae 100644 (file)
@@ -1,9 +1,10 @@
                         WEBCIT for the Citadel System
-                               version 6.71
+                               version 6.81
  
    Copyright (C) 1996-2006 by the authors.  Portions written by:
        Art Cancro
        Nathan Bryant
+       Alessandro Fulciniti
        Wilifried Goesgens
        Nick Grossman
        Andru Luvisi
    is licensed to you under the terms of the GNU Lesser General Public
    License.
 
+   WebCit bundles the Nifty Corners library, written by Alessandro Fulciniti
+   [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.
 
  
@@ -173,12 +179,10 @@ you must have libical v0.24 (or newer) on your system.  You must also be
 running a Citadel server with calendaring support.  The calendar service will
 be automatically configured and installed if your host system supports it.
  
- WebCit also provides Kolab-compatible free/busy data for calendar clients.
-Unlike the Kolab server, however, there is no need for each user to "publish"
+ WebCit also provides iCalendar format free/busy data for calendar clients.
+Unlike with some other servers, there is no need for each user to "publish"
 free/busy data -- it is generated on-the-fly from the server-side calendar
-of the user being queried.  Note: in order to support Kolab clients, you must
-have WebCit running in HTTPS mode on port 443, because that is what Kolab
-clients will be expecting.
+of the user being queried.
   
  
  HTTPS (encryption) SUPPORT
@@ -206,32 +210,35 @@ authority.
  INTEGRATING INTO APACHE
  -----------------------
 
- If you want to include webcit into an Apache, because of you want to have it
-running alongside your i.e. php applications without adding another ip or using a 
-different port than 443 / 80 (which may be blocked by company firewalls for 
-example) you can do this with apaches mod_proxy. One can do this either to make
-webcit fill up into a full vhost (like webcit.mydomain.com) or to go into a 
-subdirectory (like www.mydomain.com/webcit). find two config snippets, that can
-be added to apaches sample ssl config (which you may find in 
-/usr/share/doc/apache2/examples/ssl.conf for example) Warning: you should be somewhat
-experienced with configuring apache to do that!
+ It is best to run WebCit natively on its own HTTP port.  If, however, you wish
+to have WebCit run as part of an Apache web server installation (for example,
+you only have one IP address and you need to stay on port 80 or 443 in order to
+maintain compatibility with corporate firewall policy), you can do this with
+the "mod_proxy" Apache module.
+ The preferred way to do this is to configure a NameVirtualHost for your WebCit
+installation (for example, http://webcit.example.com) and then proxy that
+virtual host through to WebCit.  The alternative way, which does work but is not
+quite as robust, is to "mount" the WebCit paths as directory aliases to your
+main document root.
+
+Here is how to configure the NameVirtualHost method:
 
-VHOST context:
 <VirtualHost mydomain.com:443>
        #here some of your config stuff like logging, serveradmin...
        NameVirtualHost www.mydomain.com
     <location />
          allow from all
     </location>
-
     ProxyPass / http://127.0.0.1:2000/
     ProxyPassReverse / http://127.0.0.1:2000/
-# make apache give away static content like images...
+# The following line is optional.  It allows WebCit's static content
+# such as images to be served directly by Apache.
     alias /static /var/lib/citadel/www/static
-
 </VirtualHost>
 
-SUBDIR context:
+Here is how to configure the "subdirectory" method:
+
 <VirtualHost mydomain.com:443>
        #here some of your config stuff like logging, serveradmin...
        NameVirtualHost www.mydomain.com
@@ -256,31 +263,37 @@ SUBDIR context:
     ProxyPassReverse /groupdav/ http://127.0.0.1:2000/groupdav/
     ProxyPass /who_inner_html http://127.0.0.1:2000/who_inner_html
     ProxyPassReverse /who_inner_html http://127.0.0.1:2000/who_inner_html
-# make apache give away static content like images...
+# The following line is optional.  It allows WebCit's static content
+# such as images to be served directly by Apache.
     alias /static /var/lib/citadel/www/static
 </VirtualHost>
- CONCLUSION
- ----------
- That's all you need to know to get started.  If you have any questions or
-comments, please visit UNCENSORED! BBS, the home of Citadel, at
-uncensored.citadel.org.
-
 
+  
  ADVANCED CONFIGURE OPTIONS
  --------------------------
  
- To make webcit integrate smothly into your system there are several options available.
---with-staticdir defines where webcit should put'n search its templates and images. If you
-want to go with a different Installation location then the point it is accessed at runtime, 
+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)
 
-Further there are possibilities to load the tiny_mce editor into a system uniq location. Webcit 
-uses this standard component compose its messages for mails and postings. Several webcit installations
-that may differ in design but use the same tiny_mce (which is the default that webcit ships with)
+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)
+
+
+ CONCLUSION
+ ----------
+ That's all you need to know to get started.  If you have any questions or
+comments, please visit UNCENSORED! BBS, the home of Citadel, at
+uncensored.citadel.org.
+
+