All Articles

Using EteSync with Kontact - GSoC 2020 with KDE and EteSync [Part 6]

Hey everyone!

Over the past few months, I have been working on enabling EteSync users to sync their calendars, contacts and tasks to Kontact. Recently, the resource has been beta-tested, and it is becoming better with every feedback we’re getting. This is a guide on how to add your EteSync account to Kontact and use it to manage your EteSync contacts, calendars and tasks.

Installing the resource

The resource is currently not released with KDE software - we are aiming to have it in the next release. So, it needs to be compiled separately. Follow this guide to install the resource, and head over to the community chat in case of any problems, or even for general help.

Adding your EteSync account to Kontact

Note: The below steps assume that you already have an EteSync account. If not, head over to the EteSync website to create one, and you’re good to go!

  1. Open the calendar app in Kontact (called Korganizer).
  2. On the left, you’ll see a list of all your calendars. Right click and select “Add Calendar”.
  3. A dialog box will pop up, asking you to select the service you want. Select “EteSync Groupware Resource”.
  4. A configuration dialog will appear:

    If you’ve already setup an EteSync encryption password:

    • Enter your EteSync username/email and password and click “Next”.
    • Enter your EteSync encryption password and click “Finish”.

    If you have a new EteSync account:

    • Enter your EteSync username/email and password and click “Next”.
    • In the page that opens, you have to set your EteSync encryption password. This is used to encrypt/decrypt all your data, so make sure you double check it, as it cannot be changed if wrong.
    • Enter your EteSync encryption password and click “Finish”.
    • Your account will be initialized with three default journals - “My Calendar”, “My Contacts” and “My Tasks”. Feel free to add more journals as you wish!

Advanced: If you have a self-hosted EteSync server

EteSync is completely open-source and so, you can host your own EteSync server if you prefer to do so. Thanks to the way EteSync is designed, there is very little benefit in running your own instance, however, if you still wish to do so, please follow the instructions.

After you have sucessfully set up your own instance, and verified it works by connecting to it from the browser, click on the “Advanced Settings” checkbox in the configuration dialog while setting up the resource. Enter the server URL of your self-hosted instance in the text-box that appears. Click on “Next” and follow the remaining steps as mentioned above.

For example, here’s how to use a self-hosted server listening on http://localhost:8000:

Using EteSync with Kontact

You can now use the Kontact calendar and address book applications (KOrganizer and KAddressBook) to manage your EteSync calendars, tasks and contacts as you normally would.

Using these applications should be quite straight-forward, but KDE has a handbook on KOrganizer and KAddressBook if you wish to have a look.

Example usage:

That’s it! If you have any more questions, or any changes to propose to this guide, do head over to the community chat and let us know. :)