docs:carddav

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
docs:carddav [11-04-2015 19:43]
cwacha [Setting up an iPhone running iOS 7]
docs:carddav [28-12-2017 13:15] (current)
cwacha
Line 1: Line 1:
  
-====== CardDAV Inerface Documentation ======+====== CardDAV/iCloud Interface Documentation ======
  
  
Line 7: Line 7:
 As of version 3.0 the iAddressBook comes with a CardDAV interface that As of version 3.0 the iAddressBook comes with a CardDAV interface that
 allows you to use the iAddressBook as your personal iCloud alternative. allows you to use the iAddressBook as your personal iCloud alternative.
-Just hook up your iPhone, Android phone or OSX Addressbook to your+Instead of using Apple's iCloud to sync your contacts you can sync your 
 +contacts into the iAddressBook and back. 
 +Just hook up your iPhone, Android phone or macOS Addressbook to your
 installation and the contacts will sync automatically between all the installation and the contacts will sync automatically between all the
 connected clients. Including Photo sync of course. connected clients. Including Photo sync of course.
- 
-===== Basics ===== 
- 
 The iAddressbook uses SabreDAV (http://sabre.io) as the backend interface. The iAddressbook uses SabreDAV (http://sabre.io) as the backend interface.
-Authentication and CardDAV support must be turned on. The client can then use the same user+//Authentication// and //CardDAV Support// must be turned on. The client can then use the same user
 credentials used for login as defined in ''conf/auth.php''. credentials used for login as defined in ''conf/auth.php''.
 You can test the settings by going to your iAddressbook installation and adding ''/carddav.php'' You can test the settings by going to your iAddressbook installation and adding ''/carddav.php''
Line 24: Line 23:
 http://demo.iaddressbook.org/carddav.php http://demo.iaddressbook.org/carddav.php
  
 +===== Setup Instructions =====
 +
 +  * Enable CardDAV support (HINT: ''$conf['carddav_enable'] = 1;'')
 +  * Enable and setup user authentication (HINT: ''$conf['auth_enabled'] = 1;'')
 +
 +**Apache Users:**
 +  * :!: Make sure PHP is running as Apache module (and not as FastCGI application). Otherwise HTTP Basic Auth will not work and the carddav interface cannot authenticate you
 +  * (optional) Copy ''htaccess.example'' to ''.htaccess'' and adjust RewriteBase to match your URI (i.e. if your URL is ''http://mydomain.com/something/iaddressbook'' set RewriteBase to ''/something/iaddressbook'')
 +
 +<note info>
 +The settings in .htaccess enable CardDAV clients to determine the correct URI for your account automatically. If the settings are not present you might have to specify your URL as\\ ''http://myserver.com/iaddressbook/carddav.php'' or even\\ ''http://myserver.com/iaddressbook/carddav.php/principals/your_username/''.
 +</note>
 ===== Specifying the Server URL ===== ===== Specifying the Server URL =====
 Clients will ask you to provide the URL to your CardDAV server. The exact syntax depends on the Clients will ask you to provide the URL to your CardDAV server. The exact syntax depends on the
-abilities of the client. If you have activated the .htaccess file that comes with the installation+abilities of the client. If you have activated the ''.htaccess'' file that comes with the installation
 you should be able to use a very simple form (i.e. such as ''myserver.com/iaddressbook''). you should be able to use a very simple form (i.e. such as ''myserver.com/iaddressbook'').
 Sometimes the simple format will not work and you have to be more specific. In order to get the Sometimes the simple format will not work and you have to be more specific. In order to get the
Line 38: Line 49:
   - Try: ''https://myserver.com/iaddressbook'' (Make sure that you use http or https depending on your SSL support)   - Try: ''https://myserver.com/iaddressbook'' (Make sure that you use http or https depending on your SSL support)
   - Try: ''https://myserver.com/iaddressbook/carddav.php''   - Try: ''https://myserver.com/iaddressbook/carddav.php''
-  - Try: ''https://myserver.com/iaddressbook/carddav.php/principals/<username>/''+  - Try: ''https://myserver.com/iaddressbook/carddav.php/principals/your_username/''
  
 ===== Setting up OSX Addressbook ===== ===== Setting up OSX Addressbook =====
Line 48: Line 59:
   - Select tab Accounts   - Select tab Accounts
   - Click the (+) symbol to add a new account   - Click the (+) symbol to add a new account
-  - Choose "Other account..." and click continue +  - Choose "Other contacts account..." and click Continue 
-  - Type in your use name and password +  - Type in your User Name and Password and Server Address 
-  - Type in the server address and click create+  - Click Create
  
 The settings for other OSX versions might change slightly. OSX can deal with the simple form (given you have activated the shipped .htaccess file). The settings for other OSX versions might change slightly. OSX can deal with the simple form (given you have activated the shipped .htaccess file).
  
-<note warning> +{{gallery>:docs:osx}}
-Apple seems to have introduced buggy code in OSX Mavericks 10.9 (up to 10.9.5) that suffers from race conditions. Some of the contact +
-photos are correct, others show up on the wrong contact yet others are distorted. If you remove the account and re-add it the situation +
-"shuffles" and other contact photos are wrong. I never got all the contacts to be correct again. The only workaround I found is to +
-extract all cards from the website using vCard extract, then importing them directly to the OSX Addressbook. It will complain that you +
-have duplicates but you can select "update all" and dismiss the message. +
-</note>+
  
 ===== Setting up an iPhone running iOS 6 ===== ===== Setting up an iPhone running iOS 6 =====
Line 74: Line 79:
   - In the "CONTACTS" section click "Add CardDAV Account"   - In the "CONTACTS" section click "Add CardDAV Account"
   - Specify Server, User Name and Password and optionally change the description   - Specify Server, User Name and Password and optionally change the description
-  - Click Next+  - Tap Next
  
-[[:docs:ios7]] +{{gallery>:docs:ios7}} 
-===== Setting up Android using CardDav-Sync ===== +===== Setting up Android using CardDAV-Sync =====
-short: it work too, but for some reason contact photos are not synced back when set on the phone +
-  - Go to the Play Store and get buy [[https://play.google.com/store/apps/details?id=org.dmfs.carddav.Sync|CardDAV-Sync]] +
-  - instructions follow+
  
 +  - Go to the Play Store and buy/install [[https://play.google.com/store/apps/details?id=org.dmfs.carddav.Sync|CardDAV-Sync]]
 +  - Check if you have to install this [[https://play.google.com/store/apps/details?id=org.dmfs.jb.workaround.carddavsync|"Workaround App"]] (required for Samsung devices to prevent removal of your account after phone restarts)
 +  - Once installed open the Settings Dialog
 +  - In Section ACCOUNTS select "Add Account"
 +  - Choose "CardDAV"
 +  - When asked what kind of CardDAV (i.e. Google, Yahoo etc.) select the first option "CardDAV"
 +  - Enter Server name, Username and Password then tap Next
 +  - Set the Account Name to something more descriptive than "default" and tap Finish
 +  - Close the "Congratulations" dialog by tapping Done
 +
 +{{gallery>:docs:android}}
 +
 +<note warning>
 +Contact photos from the iAddressbook are synced to the phone correctly. But for some unknown reason, contact photos set on the device are not synced back.
 +</note>
  
  • docs/carddav.1428774233.txt.gz
  • Last modified: 17-11-2016 12:33
  • (external edit)