nik/davical
1
0
Fork 0
mirror of https://gitlab.com/davical-project/davical.git synced 2026-05-24 02:24:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch 'master' of git+ssh://git.catalyst.net.nz/git/public/rscds

Browse Source
This commit is contained in:
Andrew McMillan 2007-10-19 08:48:04 +13:00
commit c6cd078f79
10 changed files with 73 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/website/administration.php
View File

@ -98,14 +98,14 @@ P4 ==>> Administers Group ==> G
</pre>
<h1>Configuring Calendar Clients for RSCDS</h1>
<p>The <a href="http://rscds.sourceforge.net/clients.php">RSCDS client setup page on sourceforge</a> has information on how
<h1>Configuring Calendar Clients for DAViCal</h1>
<p>The <a href="http://rscds.sourceforge.net/clients.php">DAViCal client setup page on sourceforge</a> has information on how
to configure Evolution, Mozilla Calendar (Sunbird &amp; Lightning) and Mulberry to use remotely hosted calendars.</p>
<p>The administrative interface has no facility for viewing or modifying calendar data.</p>
<h1>Configuring RSCDS</h1>
<h1>Configuring DAViCal</h1>
<p>If you can read this then things must be mostly working already.</p>
<p>The <a href="http://rscds.sourceforge.net/installation.php">RSCDS installation page</a> on sourceforge has
<p>The <a href="http://rscds.sourceforge.net/installation.php">DAViCal installation page</a> on sourceforge has
some further information on how to install and configure this application.</p>

4
docs/website/clients/Chandler-details.php
View File

@ -23,5 +23,5 @@ button or with a default frequency of hourly. This is quite different to the ot
have used which all aggressively push new and changed items to the server as soon as possible,
but which may be lazy about fetching updates.</p>
<p>Operation with RSCDS is not yet perfect but basic operation is satisfactory. I will be
concentrating on making RSCDS interoperate with Chandler over coming releases.</p>
<p>Operation with DAViCal is not yet perfect but basic operation is satisfactory. I will be
concentrating on making DAViCal interoperate with Chandler over coming releases.</p>

2
docs/website/clients/Interoperability-details.php
View File

@ -11,7 +11,7 @@ that Mulberry does it.</p>
</ul>
<p>The host name is, of course, up to you. The 'root path' should be <code>/caldav.php/</code> and anything following that is the calendar namespace.</p>
<p>Within the calendar namespace RSCDS uses the first element of the path as the user or resource name, so that a client connecting at the root path
<p>Within the calendar namespace DAViCal uses the first element of the path as the user or resource name, so that a client connecting at the root path
can see all of the (accessible) users and resources available to them (Mulberry displays this hierarchy) with any calendars below that.</p>
<p>Effectively this means that in Evolution, Sunbird and Lightning you should really specify a calendar URL which is something like:</p>
<pre>

2
docs/website/clients/Mozilla-details.php
View File

@ -2,7 +2,7 @@
<p>The <a href="http://www.mozilla.org/projects/calendar/">Mozilla Calendar</a> project offers their calendar under two different names:
<em><a href="http://www.mozilla.org/projects/calendar/sunbird/">Sunbird</a></em> is a standalone calendar
application, and <em><a href="http://www.mozilla.org/projects/calendar/lightning/">Lightning</a></em> is a Thunderbird extension.
The two are essentially the same, as far as RSCDS is
The two are essentially the same, as far as DAViCal is
concerned, and these instructions should work for either of them.</p>
<ol>

2
docs/website/clients/Mulberry-details.php
View File

@ -23,7 +23,7 @@ PROPFIND requests.</p>
<p>Unfortunately Mulberry is not (yet) open-source, though it is free, so we must wait on the developer to fix
the user interface niggles when he gets around to it.</p>
<p>Note that Mulberry has a complex user interface. When I wrote this I went back into Mulberry and initially
thought that RSCDS had regressed somewhat and that these instructions didn't exactly work... :-) It turned out
thought that DAViCal had regressed somewhat and that these instructions didn't exactly work... :-) It turned out
that these instructions worked <em>just fine</em> when I followed them to the letter the next day. Go figure.
I think I need to record some screenshots of this one...</p>

4
docs/website/clients/Other-details.php
View File

@ -1,8 +1,8 @@
<h1>Other Client Software</h1>
<p>I would love to have more client software available to test RSCDS
<p>I would love to have more client software available to test DAViCal
against, but so far these are the only ones I have access to.</p>
<p>If you want to point me at more free software that supports CalDAV, or
send me free copies of such proprietary software, then I will add it to
the list as well as make RSCDS work with it.</p>
the list as well as make DAViCal work with it.</p>

2
docs/website/inc/page-footer.php
View File

@ -14,7 +14,7 @@ echo $tags_to_be_closed;
Copyright 2006 | Andrew McMillan
</p>
<p align="center">
<a href="http://andrew.mcmillan.net.nz/"><img src="http://sf-rscds.mcmillan.net.nz/clear-1.png" width="1" height="1" border="0" title="The Really Simple CalDAV Store by Andrew McMillan" alt=" " /></a>
<a href="http://andrew.mcmillan.net.nz/"><img src="http://sf-rscds.mcmillan.net.nz/clear-1.png" width="1" height="1" border="0" title="DAViCal CalDAV Server by Andrew McMillan" alt=" " /></a>
<a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=179845&amp;type=2" width="125" height="37" border="0" alt="SourceForge.net Logo" /></a>
</p>
</div>

10
docs/website/inc/page-header.php
View File

@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Really Simple CalDAV Store<?php
<title>DAViCal<?php
if ( isset($title) ) {
echo " - ". $title;
}
@ -17,18 +17,18 @@ if ( isset($title) ) {
echo $title;
}
else {
echo "Really Simple CalDAV Store";
echo "DAViCal";
}
?></div>
<div id="subTitle">Really Simple CalDAV Store</div>
<div id="subTitle">A CalDAV Store</div>
<div id="headerLinks">
<a href="index.php" class="hlink">Home</a> |
<a href="installation.php" class="hlink">Installation</a> |
<a href="clients.php" class="hlink">Client Config</a> |
<a href="administration.php" class="hlink">Administration</a> |
<a href="/moin/FrontPage" class="hlink">RSCDS Wiki</a> |
<a href="/moin/FrontPage" class="hlink">DAViCal Wiki</a> |
<a href="http://andrew.mcmillan.net.nz/" class="hlink">Blog</a> |
<a href="http://sourceforge.net/projects/rscds/" class="hlink">RSCDS on Sourceforge</a>
<a href="http://sourceforge.net/projects/rscds/" class="hlink">DAViCal on Sourceforge</a>
</div>
</div>
<div id="pageContent">

9
docs/website/index.php
View File

@ -1,5 +1,5 @@
<?php
$title = "RSCDS Home";
$title = "DAViCal Home";
include("inc/page-header.php");
?>
<h1>Background</h1>
@ -30,14 +30,14 @@ but no testing has been undertaken in other PHP environments to date.</p>
operating environments, and which is <em>fully</em> ACID compliant.</p>
<h2>Simplicity of Setup</h2>
<p>For the greatest ease use you should consider installing RSCDS on the <a href="http://www.debian.org/">Debian GNU/Linux</a>
<p>For the greatest ease use you should consider installing DAViCal on the <a href="http://www.debian.org/">Debian GNU/Linux</a>
distribution from the readily available, signed packages.</p>
<p>We expect to increase the level of automation and simplicity for the Debian target release in particular, although other
distributions might also become easier at the same time. We do expect slightly greater installation complexity in the first
few releases as we come to understand the particular problems people experience.</p>
<h2>Simplicity of Operation</h2>
<p>In general RSCDS should not need significant maintenance to keep it operating.</p>
<p>In general DAViCal should not need significant maintenance to keep it operating.</p>
<p>Administrative functionality will be kept as simple as possible, within the target of supporting
organisations of up to several hundred staff.</p>
<p>This is called a <em>Store</em> rather than a <em>Server</em> because the server-side smarts are intended to be
@ -56,7 +56,7 @@ works using the CalDAV protocol.</p>
<ul>
<li>Lorena Paoletti (Spanish)</li>
<li>Cristina Radalescu (German)</li>
<li>Guillaume Rosquin (French)</li>
<li>Guillaume Rosquin &amp; Maxime Delorme (French)</li>
<li>Nick Khazov (Russian)</li>
<li>Eelco Maljaars (Dutch)</li>
</ul>
@ -68,7 +68,6 @@ works using the CalDAV protocol.</p>
<h1>Your Name Here!</h1>
<p>If you are interested in helping, there are several areas where I need help at the moment:</p>
<i>
<li>The project needs a better name - feel free to suggest one!</li>
<li>We need more documentation</li>
<li>We need to find more CalDAV-capable calendar clients to interoperate with</li>
<li>We would love you to write about your experiences in the project Wiki.</li>

85
docs/website/installation.php
View File

@ -12,7 +12,7 @@ deb http://debian.mcmillan.net.nz/debian unstable awm
</pre>
<p>to your <code>/etc/apt/sources.list</code>. Once you have done that you
can use <code>apt-get</code> or <code>synaptic</code> or some other equivalent package
manager to fetch and install <code>rscds</code> and all the dependencies.</p>
manager to fetch and install <code>DAViCal</code> and all the dependencies.</p>
<p>This repository is signed by Andrew McMillan's public key, which you can install so that
you don't get asked for confirmation all the time:</p>
@ -29,18 +29,18 @@ sudo apt-key advanced --keyserver subkeys.pgp.net --recv-keys CCA377BD77494424B0
notes to pages somewhere under here:
<a href="http://rscds.sourceforge.net/moin/InstallationStuff">http://rscds.sourceforge.net/moin/InstallationStuff</a></p>
<h3>RPM Packages of RSCDS</h3>
<p>We have created RPM packages of RSCDS and libawl-php from the .deb packages
using "alien". I don't know how well these work, so would appreciate feedback
about your success with them.</p>
<h3>RPM Packages of DAViCal</h3>
<p>We have created RPM packages of DAViCal and libawl-php from the .deb packages
using "alien". These are reported to work fine, so use them and then proceed to the
Pre-requisites section below.</p>
<h3>SuSE Linux</h3>
<p>On SuSE Linux you may need to look in /var/lib/pgsql/data/ for the pg_hba.conf file.</p>
<h3>Gentoo, Slackware, BSD and the rest</h3>
<p>You will need to download the latest versions of the <code>rscds</code> and <code>awl</code> packages
from the <a href="http://sourceforge.net/project/showfiles.php?group_id=179845">sourceforge download page for rscds</a>.</p>
<p>You will need to download the latest versions of the <code>DAViCal</code> and <code>awl</code> packages
from the <a href="http://sourceforge.net/project/showfiles.php?group_id=179845">sourceforge download page for DAViCal</a>.</p>
<p>You will need to untar these. Preferably you will untar them from within the "<code>/usr/share</code>" directory and everything
will be in it's expected location (well, except the docs, but it will at least be tidy and everything will be in one place).</p>
@ -60,7 +60,7 @@ the database creation scripts are likely to need love.</p>
<h1>Pre-requisites</h1>
<p>RSCDS depends on a number of things. Firstly, it depends
<p>DAViCal depends on a number of things. Firstly, it depends
on Andrew's Web Libraries (AWL) which is a set of useful
PHP functions and objects written by Andrew McMillan over
a number of years.</p>
@ -68,8 +68,8 @@ a number of years.</p>
<p>The following other software is also needed:</p>
<ul>
<li>Apache: 1.3.x or 2.x.x</li>
<li>PHP: 4.3 or greater, including PHP5</li>
<li>PostgreSQL: 7.4 or greater (8.1 or better recommended)</li>
<li>PHP: 5.0 or greater</li>
<li>PostgreSQL: 8.1 or greater</li>
</ul>
<p>The PostgreSQL database may be installed on a server other
@ -78,10 +78,11 @@ if you want to increase the security or scalability of your
installation.</p>
<p>Since the CalDAV store takes over a significant amount of path
hierarchy, it is designed to be installed in it's own virtual
hierarchy, it can be easier in it's own virtual
host. If you want it to operate within the web root of some
other application there are instructions on the Wiki about doing this,
and other fancy tricks such as URL rewriting to shorten the path.</p>
as well as other fancy tricks such as configuring URL rewriting in
order to shorten the path.</p>
<h1>Database Setup</h1>
@ -124,7 +125,7 @@ have put them.</p>
running as a user who has rights to create a new database, so you
may need to do this as the "postgres" user, for example:</p>
<pre>
su postgres -c /usr/share/rscds/dba/create-database.sh
su postgres -c /usr/share/davical/dba/create-database.sh
</pre>
<h2>Connecting to the Database</h2>
@ -139,11 +140,11 @@ computer as the web server, the following line (near the top
of the pg_hba.conf file) should be enough:</p>
<pre>
local rscds general trust
local davical general trust
</pre>
<p>This means that anyone on the local computer (including the
web application) will have rights to connect to the RSCDS
web application) will have rights to connect to the DAViCal
database as the 'general' user. It will not allow remote access,
or access as any user other than 'general'.</p>
@ -152,7 +153,7 @@ unix sockets, the line in the pg_hba.conf file should look something
like:</p>
<pre>
host rscds general 127.0.0.1/32 trust
host davical general 127.0.0.1/32 trust
</pre>
<p>If the webserver is on a different machine to the database, that
@ -163,24 +164,42 @@ database on a different server, you should read the
<a href="http://www.postgresql.org/docs/8.1/interactive/client-authentication.html">PostgreSQL documentation on pg_hba.conf</a>
for the version you are using.</p>
<h1>Apache VHost Configuration</h1>
<h1>Apache Configuration</h1>
<h2>Relative to an existing DocumentRoot</h2>
<p>You can create a symlink from an existing web root directory to the
/usr/share/rscds/htdocs directory, such as:</p>
<pre>
cd /my/apache/docroot
ln -s /usr/share/davical/htdocs davical
</pre>
You will need to change your global PHP configuration to include the
directory '/usr/share/awl/inc' in the 'include_path' setting, along with
any other directories already needed by other applications.
You will also need to ensure that 'magic_quotes_gpc' is off.
<h2>Using a Virtual Host</h2>
<p>Your Apache instance needs to be configured for Virtual Hosts. If
this is not already the case you may want to read some documentation
about that, and you most likely will want to ensure that any existing
site becomes the **default** virtual host, with RSCDS only being a
site becomes the **default** virtual host, with DAViCal only being a
single virtual host.</p>
<p>I use a Virtual Host stanza like this:</p>
<pre>
#
# Virtual Host def for Debian packaged RSCDS
# Virtual Host def for Debian packaged DAViCal
&lt;VirtualHost 123.4.56.78 >
DocumentRoot /usr/share/rscds/htdocs
DocumentRoot /usr/share/davical/htdocs
DirectoryIndex index.php index.html
ServerName rscds.example.net
ServerName davical.example.net
ServerAlias calendar.example.net
Alias /images/ /usr/share/rscds/htdocs/images/
Alias /images/ /usr/share/davical/htdocs/images/
php_value include_path /usr/share/awl/inc
php_value magic_quotes_gpc 0
php_value register_globals 0
@ -199,30 +218,30 @@ installed from a package.</p>
<p>Once your VHost is installed an working correctly, you should be
able to browse to that address and see a page telling you that
you need to configure RSCDS.</p>
you need to configure DAViCal.</p>
<p>On Debian systems (or derivatives such as Ubuntu), when you are
using Apache 2, you should put this definition in the /etc/apache2/sites-available
directory and you can use the 'a2ensite' command to enable it.</p>
<h1>RSCDS Configuration</h1>
<h1>DAViCal Configuration</h1>
<p>The RSCDS configuration generally resides in /etc/rscds/&lt;domain&gt;-conf.php
<p>The DAViCal configuration generally resides in /etc/davical/&lt;domain&gt;-conf.php
and is a regular PHP file which sets (or overrides) some specific variables.</p>
<pre>
&lt;?php
// $c->domain_name = "calendar.example.net";
// $c->sysabbr = 'rscds';
// $c->sysabbr = 'DAViCal';
// $c->admin_email = 'admin@example.net';
// $c->system_name = "Really Simple CalDAV Store";
// $c->system_name = "DAViCal Server Administration";
// $c->collections_always_exist = true;
// $c->enable_row_linking = true;
// $c->default_locale = en_NZ.UTF-8;
// $c->pg_connect[] = 'dbname=rscds port=5433 user=general';
$c->pg_connect[] = 'dbname=rscds port=5432 user=general';
$c->pg_connect[] = 'dbname=davical port=5433 user=general';
$c->pg_connect[] = 'dbname=davical port=5432 user=general';
?>
</pre>
@ -241,7 +260,7 @@ creation of calendar collections.</p>
<p>The "enable_row_linking" option controls whether javascript is used
to make the entire row clickable in browse lists in the administration
pages. Since this doesn't work in Konqueror you may want to set this
to false if you expect people to be using Konqueror with the RSCDS
to false if you expect people to be using Konqueror with the DAViCal
administration pages.</p>
<p>You should set the 'domain_name' and 'admin_email' as they are used
@ -278,7 +297,7 @@ are supported on your system.</p>
pages and log in as 'admin' (the password is the bit after the '**'
in the 'password' field of the 'usr' table so:</p>
<pre>
psql rscds -c 'select username, password from usr;'
psql davical -c 'select username, password from usr;'
</pre>
<p>should show you a list. Note that once you change a password it
@ -296,8 +315,8 @@ about your experiences in the Wiki, including distribution specific notes, to pa
<h1>Upgrades</h1>
<p>Whenever you upgrade the RSCDS application to a new version you will need to
run dba/update-rscds-database which will apply any pending database patches, as well as
<p>Whenever you upgrade the DAViCal application to a new version you will need to
run dba/update-davical-database which will apply any pending database patches, as well as
enabling any new translations.</p>
<p>In due course the running of this script will be able to be handled by