Page MenuHomePhorge
Files F256756

README.md
No OneTemporary
Actions

README.md
View Options

INSTALLATION PROCEDURE
======================
This package uses [Composer][1] to install and maintain required PHP libraries
as well as the Roundcube framework. The requirements are basically the same as
for Roundcube so please read the INSTALLATION section in the Roundcube
framework's [README][2] file.
1. Install Composer
Execute this in the project root directory:
$ curl -s http://getcomposer.org/installer | php
This will create a file named composer.phar in the project directory.
2. Install Dependencies
$ cp composer.json-dist composer.json
$ php composer.phar install
3. Import the Roundcube Framework (1.2) and Kolab plugins
3.1. Either copy or symlink the Roundcube framework package into lib/ext/Roundcube
3.2. Either copy or symlink the roundcubemail-plugins-kolab into lib/drivers/kolab/plugins
4. Create local config
The configuration for this service inherits basic options from the Roundcube
config. To make that available, symlink the Roundcube config file
(config.inc.php) into the local config/ directory.
5. Give write access for the webserver user to the logs, cache and temp folders:
$ chown <www-user> logs
$ chown <www-user> cache
$ chown <www-user> temp
6. Execute database initialization scripts from doc/SQL/ on Roundcube database.
7. Optionally, configure your webserver to point to the 'public_html' directory of this
package as document root.
CREATING BACKEND-DRIVER
=======================
Chwala API supports creation of different storage backends.
It is possible to create a driver class that will store files on
any storage e.g. local filesystem. As for now it is possible to use
only one storage driver at a time.
There are currently two drivers available for Chwala: Kolab and Seafile.
The Kolab driver is considered the reference driver. Both can be found
in the lib/drivers directory.
The Kolab driver is based on Roundcube Framework and implements storage
the "Kolab way", which is to store files in IMAP. The main file is
lib/drivers/kolab/kolab_file_storage.php.
To create a new driver for a different storage system you need to:
1. Create driver directory as lib/drivers/<driver_name>. This directory will be
added to PHP's include path.
2. Create lib/drivers/<driver_name>/<driver_name>_file_storage.php file.
This file should define a class <driver_name>_file_storage which
implements the file_storage interface as defined in lib/file_storage.php.
3. To change the driver set 'fileapi_backend' option to the driver name
in main configuration file. The default is 'kolab'.
Driver initialization
---------------------
Driver object is initialized in file_api::api_init() method.
After the object instance is created we call configure() method.
Driver methods
--------------
1. configure - Is used to configure the driver.
2. authenticate - Is used to authenticate a user in authenticate
request.
3. capabilities - Is supposed to return capabilities and limitations
(like max. upload size) supported by the driver.
Other methods are self explanatory and well documented in
interface class file. API documentation can be generated
using phpDocumentor (http://phpdoc.org).
[1]: http://getcomposer.org
[2]: https://github.com/roundcube/roundcubemail/blob/master/program/lib/Roundcube/README.md)

File Metadata

Mime Type
text/plain
Expires
Mon, Jun 9, 2:37 PM (1 d, 10 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
196818
Default Alt Text
README.md (3 KB)

Event Timeline