|
3
|
1 A calendar module for Roundcube
|
|
|
2 -------------------------------
|
|
|
3
|
|
|
4 This plugin currently supports a local database as well as a Kolab groupware
|
|
|
5 server as backends for calendar and event storage. For both drivers, some
|
|
|
6 initialization of the local database is necessary. To do so, execute the
|
|
|
7 SQL commands in drivers/<yourchoice>/SQL/<yourdatabase>.initial.sql
|
|
|
8
|
|
|
9 The client-side calendar UI relies on the "fullcalendar" project by Adam Arshaw
|
|
|
10 with extensions made for the use in Roundcube. All changes are published in
|
|
|
11 an official fork at https://github.com/roundcube/fullcalendar
|
|
|
12
|
|
|
13 For some general calendar-based operations such as alarms handling or iCal
|
|
|
14 parsing/exporting this plugins requires the `libcalendaring` plugin which
|
|
|
15 is also part of the Kolab Roundcube Plugins repository. Make sure that plugin
|
|
|
16 is installed and configured correctly.
|
|
|
17
|
|
|
18 For recurring event computation, some utility classes from the Horde project
|
|
|
19 are used. They are packaged in a slightly modified version with this plugin.
|
|
|
20
|
|
|
21 IMPORTANT
|
|
|
22 ---------
|
|
|
23
|
|
|
24 The calendar module makes heavy use of PHP's DateTime as well as DateInterval
|
|
|
25 classes. The latter one requires at least PHP 5.3.0 to run.
|
|
|
26
|
|
|
27
|
|
|
28 REQUIREMENTS
|
|
|
29 ------------
|
|
|
30
|
|
|
31 Some functions are shared with other plugins and therefore being moved to
|
|
|
32 library plugins. Thus in order to run the calendar plugin, you also need the
|
|
|
33 following plugins installed:
|
|
|
34
|
|
|
35 * libcalendaring [1]
|
|
|
36 * libkolab [1] (when using the 'kolab' driver)
|
|
|
37
|
|
|
38
|
|
|
39 INSTALLATION
|
|
|
40 ------------
|
|
|
41
|
|
|
42 The preferred and automated way to install the calendar with all requirements
|
|
|
43 is via the Roundcube plugin repository: https://plugins.roundcube.net
|
|
|
44
|
|
|
45 For a manual installation of the calendar plugin (and its dependencies),
|
|
|
46 execute the following steps. This will set it up with the database backend
|
|
|
47 driver.
|
|
|
48
|
|
|
49 1. Get the source from git
|
|
|
50
|
|
|
51 $ cd /tmp
|
|
|
52 $ git clone https://git.kolab.org/diffusion/RPK/roundcubemail-plugins-kolab.git
|
|
|
53 $ cd /<path-to-roundcube>/plugins
|
|
|
54 $ cp -r /tmp/roundcubemail-plugins-kolab/plugins/calendar .
|
|
|
55 $ cp -r /tmp/roundcubemail-plugins-kolab/plugins/libcalendaring .
|
|
|
56
|
|
|
57 2. Install the dependencies with Composer
|
|
|
58
|
|
|
59 (This has to be done from the Roundcube root directory)
|
|
|
60
|
|
|
61 $ cd /<path-to-roundcube>
|
|
|
62 $ php composer.phar require sabre/vobject 3.3.3
|
|
|
63
|
|
|
64 Download the composer.phar script from https://getcomposer.org
|
|
|
65
|
|
|
66 3. Create calendar plugin configuration
|
|
|
67
|
|
|
68 $ cd calendar/
|
|
|
69 $ cp config.inc.php.dist config.inc.php
|
|
|
70 $ edit config.inc.php
|
|
|
71
|
|
|
72 4. Initialize the calendar database tables
|
|
|
73
|
|
|
74 $ mysql roundcubemail < drivers/database/SQL/mysql.initial.sql
|
|
|
75
|
|
|
76 5. Enable the calendar plugin
|
|
|
77
|
|
|
78 $ cd ../../
|
|
|
79 $ edit config/config.inc.php
|
|
|
80
|
|
|
81 Add 'calendar' to the list of active plugins:
|
|
|
82
|
|
|
83 $config['plugins'] = array(
|
|
|
84 (...)
|
|
|
85 'calendar',
|
|
|
86 );
|
|
|
87
|
|
|
88
|
|
|
89
|
|
|
90 [1] https://git.kolab.org/diffusion/RPK/
|
