1f0b42b040fc03fd3d008e873135ec1535bdf9d6
[roundcube-nextcloud_sql_addressbook.git] / README.rst
1 ***********************************************
2 NextCloud SQL address book plugin for Roundcube
3 ***********************************************
4
5 Roundcube__ plugin that allows access to NextCloud__ address books.
6 Uses direct database access (SQL), which is much faster than accessing the
7 address book entries via CardDAV__.
8
9 __ https://roundcube.net/
10 __ https://nextcloud.com/
11 __ https://plugins.roundcube.net/packages/roundcube/carddav
12
13
14 Features
15 ========
16 - List all user's NextCloud address books
17 - Search
18 - Autocomplete
19
20 Missing features
21 ----------------
22 - Access to address books shared by other people in NextCloud
23 - Access to more fields than "email" and "name" (full name)
24 - Updating/adding address book entries (not planned)
25
26
27 Prerequisites
28 =============
29 - Read-only SQL database access from Roundcube to the NextCloud database
30 - Roundcube user login e-mail addresses must equal the username in NextCloud
31   (Users log in with `alice@example.org` in both Roundcube and NextCloud)
32
33
34 Debugging
35 =========
36 If you do not see any address books:
37 The address books are only found if the ``principaluri`` in the ``oc_addressbooks``
38 table equals ``principals/users/`` + ``$useremailaddress``.