oss/Radicale
oss/Radicale
1
0
Fork 0
mirror of https://github.com/Kozea/Radicale.git synced 2025-07-05 17:08:29 +00:00
Code Wiki Activity

Merge branch 'add_apple_contacts_documentation' of git://github.com/cimm/Radicale into cimm-add_apple_contacts_documentation

Browse source 
Conflicts:
	pages/user_documentation.rst
This commit is contained in:
Guillaume Ayoub 2014-08-13 13:19:50 +02:00
commit 08d85378e6
1 changed files with 46 additions and 52 deletions
Download patch file Download diff file Expand all files Collapse all files

98
pages/user_documentation.rst
View file

@ -326,7 +326,7 @@ that are critical for proper operation.
1. From the Home screen, open ``Settings`` 1. From the Home screen, open ``Settings``
2. Select ``Mail, Contacts, Calendars`` 2. Select ``Mail, Contacts, Calendars``
3. Select ``Add Account`` → ``Other`` → ``Add CalDAV Account`` 3. Select ``Add Account…`` → ``Other`` → ``Add CalDAV Account``
4. Enter the server URL here, including ``https``, the port, and the user/calendar 4. Enter the server URL here, including ``https``, the port, and the user/calendar
path, ex: ``https://myserver.domain.com:3000/bob/birthdays.ics/`` (please note path, ex: ``https://myserver.domain.com:3000/bob/birthdays.ics/`` (please note
that **the trailing slash is important**) that **the trailing slash is important**)
@ -351,11 +351,29 @@ that are critical for proper operation.
Contacts Contacts
++++++++ ++++++++
**Contacts do not work yet with Radicale and Apple's clients.** If you are In Contacts on iOS 6:
interested in this feature, please check this `bug report
<https://github.com/Kozea/Radicale/issues/32>`_.
iCal 1. From the Home screen, open ``Settings``
2. Select ``Mail, Contacts, Calendars``
3. Select ``Add Account...`` → ``Other`` → ``Add CardDAV Account``
4. As ``Server`` use the Radicale server URL with port, for example ``localhost:5232``
5. Add any ``User name`` you like (if you didn't configure authentication)
6. Add any ``Password`` you like (again, if you didn't configure authentication)
7. Change the ``Description`` to something more readable (optional)
8. Tap ``Next``
9. An alert showing `Cannot Connect Using SSL` will pop up as we haven't configured
SSL yet, ``Continue`` for now
10. Back on the ``Mail, Contacts, Calendars`` screen you scroll to the ``Contacts`` section,
select the Radicale server as ``Default Account`` when you want to save new contacts to
the Radicale server
11. Exit to the Home screen and open ``Contacts``, tap ``Groups``, you should see the
Radicale server
.. note::
You'll need version 0.8.1 or up for this to work. Earlier versions will forget your new
settings after a reboot.
OS X
~~~~ ~~~~
.. note:: .. note::
@ -375,12 +393,12 @@ In iCal 4.0 or iCal 5.0:
5. The ``Password`` field can be left empty (we did not configure 5. The ``Password`` field can be left empty (we did not configure
authentication) authentication)
6. As ``Server address`` use ``domain:port``, for example ``localhost:5232`` 6. As ``Server address`` use ``domain:port``, for example ``localhost:5232``
(this would be the case if you start an unconfigured radicale on your local (this would be the case if you start an unconfigured Radicale on your local
machine) machine)
Click ``Create``. The wizard will now tell you, that no encryption is in place Click ``Create``. The wizard will now tell you, that no encryption is in place
(``Unsecured Connection``). This is expected and will change if you configure (``Unsecured Connection``). This is expected and will change if you configure
radicale to use SSL. Click ``Continue``. Radicale to use SSL. Click ``Continue``.
.. warning:: .. warning::
In iCal 5.x, please check twice that the ``Sync all entries`` option is In iCal 5.x, please check twice that the ``Sync all entries`` option is
@ -401,53 +419,30 @@ now set-up. You can close the ``Preferences`` window.
Contacts Contacts
++++++++ ++++++++
To get Apple Contacts running, you'll need to get your hands dirty: In Contacts 7 (previously known as AddressBook):
0. If you use a self-signed ssl certificate, add the root certificate to your 1. Open the ``Preferences`` dialog and select the ``Accounts`` tab.
keychain and grant full trust. 2. Click the ``+`` button at the lower left to open the account creation wizard.
1. Open ``Preferences`` dialog of ``Contacts.app`` and click the ``+`` to 3. As ``Account type`` select ``CardDAV``.
create a new account. 4. Add any ``User name`` you like.
2. Select `Other contacts account`` and pick ``Card DAV``. 5. The ``Password`` field can be left empty (if we didn't configure
3. Enter the your credentials and the full server address authentication).
(``https://radicale.example.com:443/user1/addressbook.vcf/``). Then click 6. As ``Server address`` use ``domain:port``, for example ``localhost:5232``
``Create``. (this would be the case if you start an unconfigured Radicale server on your local
The ``Contacts.app`` will now try to connect, but fail. Close the machine).
application. 7. Click ``Create``. Contacts will complain about an `Unsecured Connection` if you
4. Go to ``~/Library/Application Support/AddressBook/Sources/``. don't have SSL enabled. Click ``Create`` again.
5. You should now see one or more directories named with UUIDs. 8. You might want to change the ``Description`` of the newly added account to
Open the one with the latest creation date. In there you should find a something more readable. (optional)
``Configuration.plist``. Open it in a text editor of your choice. 9. Switch to the ``General`` tab in the preferences and select the Radicale server
6. Make sure your ``Configuration.plist`` looks as follows (replace the as ``Default Account`` at the bottom of the screen. It probably shows up as
settings with the ones that apply to your environment). ```domain:port`` or the name you choose if you changed the description. Newly
added contacts are added to the default account and by default this will be the
.. code-block:: Configuration.plist local `On My Mac` account.
[...]
<key>searchable</key>
<false/>
<key>serverName</key>
<string>radicale.example.com</string>
<key>serverPort</key>
<integer>443</integer>
<key>serverRootPath</key>
<string>/user1/addressbook.vcf/</string>
<key>servername</key>
<string>https://radicale.example.com:443/user1/addressbook.vcf/</string>
<key>useSSL</key>
<true/>
<key>userName</key>
<string>user1</string>
<key>username</key>
<string>user1</string>
[...]
.. note:: .. note::
You'll need to change values in the following keys: ``serverPort``, You'll need version 0.8.1 or up for this to work. Earlier versions can read CardDAV
``serverRootPath`` and ``servername``. contacts but can't add new contacts.
The port numbers in the ``serverPort`` and ``servername`` keys and the
trailing slashes seem to be important.
7. Open the ``Contacts`` application.
syncEvolution syncEvolution
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
@ -456,7 +451,6 @@ You can find more information about syncEvolution and Radicale on the
`syncEvolution wiki page `syncEvolution wiki page
<https://syncevolution.org/wiki/synchronizing-radicale>`_. <https://syncevolution.org/wiki/synchronizing-radicale>`_.
Complex Configuration Complex Configuration
===================== =====================