summaryrefslogtreecommitdiff
path: root/webmail/plugins/carddav/README
diff options
context:
space:
mode:
Diffstat (limited to 'webmail/plugins/carddav/README')
-rw-r--r--webmail/plugins/carddav/README61
1 files changed, 61 insertions, 0 deletions
diff --git a/webmail/plugins/carddav/README b/webmail/plugins/carddav/README
new file mode 100644
index 0000000..467fa5e
--- /dev/null
+++ b/webmail/plugins/carddav/README
@@ -0,0 +1,61 @@
+Description
+-----------
+This is a CardDAV-Implementation for roundcube 0.6 or higher.
+
+
+Features
+--------
+* Add multiple CardDAV server for each user
+* CardDAV contacts are stored in the local database which provides great performance
+* Tested CardDAV servers: DAViCal, Apple Addressbook Server, meetoo, SabreDAV, ownCloud, SOGo
+* You can read / add / delete / edit CardDAV contacts (vCards)
+* Autocomplete all CardDAV contacts within the compose email view
+* Search for all CardDAV contacts within the addressbook
+* Automaticly synchronized CardDAV contacts (just execute /plugins/carddav/cronjob/synchronize.php within the crontab)
+
+
+Planned features
+----------------
+* Improved search for CardDAV contacts within the addressbook
+
+
+Requirements
+------------
+* MySQL or PostgreSQL
+* CURL
+
+
+Installation
+------------
+* Execute SQL statements from /plugins/carddav/SQL/yourDatabase.sql
+* Add 'carddav' to the plugins array in /config/main.inc.php
+* Copy /plugins/carddav/config.inc.php.dist to /plugins/carddav/config.inc.php
+* Login into your roundcube webmail and add your CardDAV server in the settings
+
+
+Update
+------
+* Execute new SQL statements from /plugins/carddav/SQL/yourDatabase.update.sql
+
+
+Special thanks
+--------------
+* B5r1oJ0A9G for the PostgreSQL statements!
+
+
+CardDAV server list
+-------------------
+* DAViCal: https://example.com/{resource|principal|username}/{collection}/
+* Apple Addressbook Server: https://example.com/addressbooks/users/{resource|principal|username}/{collection}/
+* memotoo: https://sync.memotoo.com/cardDAV/
+* SabreDAV: https://example.com/addressbooks/{resource|principal|username}/{collection}/
+* ownCloud: https://example.com/apps/contacts/carddav.php/addressbooks/{resource|principal|username}/{collection}/
+* SOGo: https://example.com/SOGo/dav/{resource|principal|username}/Contacts/{collection}/
+
+
+Contact
+-------
+* Author: Christian Putzke <christian.putzke@graviox.de>
+* Report feature requests and bugs here: https://github.com/graviox/Roundcube-CardDAV/issues
+* Visit Graviox Studios: http://www.graviox.de/
+* Follow me on Twitter: https://twitter.com/graviox/ \ No newline at end of file