How To Synchronize Google Calendar With KDE-PIM (Part 2)

This guide has been moved to the Tutorials section, but will remain here for historical reference. Please refer to the KDE-PIM-GCal Sync: GCalDaemon Tutorial for any future updates to this guide.

In my previous post, I detailed how to use OpenSync, MultiSync, and KitchenSync to synchronize Google Calendar with KDE-PIM.

The reason that I do not use this method to synchronize KDE-PIM with my Google Calendar is three-fold:

1. If you notice on the Google Calendar group member configuration dialogue, you will see the statement: Please note that currently the password is stored as plain text in the plugin configuration file. That means that your gmail password is stored in plain text. Granted, the configuration file is located in the home directory, which is protected; even still, I would prefer not to leave the password in clear text.
2. The plugin appears to be limited to a single calendar. I use at least four different calendars, and would like to synchronize all four.
3. The synchronization is would like to add an event to either KDE-PIM or Google Calendar, and have the synchronization take place without my intervention. (I know, I could set up a cron job and msynctool or something to automate it.)

Fortunately, GCalDaemon provides all the functionality that I need for Google Calendar synchronization.

Part 1: What is GCalDaemon?

From the GCalDaemon web site:

GCALDaemon is an OS-independent Java program that offers two-way synchronization between Google Calendar and various iCalendar compatible calendar applications. GCALDaemon is primarily designed as a calendar synchronizer but it can also be used as a Gmail notifier, Address Book importer, Gmail terminal and RSS feed converter.

Part 2: GCalDaemon Installation Prerequisites

The first two requirements for GCalDaemon should seem obvious:

• A Gmail account
• An iCal-compatible calendar application (KDE-PIM in our case)

The only package dependency is Java Runtime, version 1.5 or later. Install either of the following packages (but not both):

• sun-java6
  (Sun's Java Runtime)
• openJDE-6-jre
  (open-source Java runtime)

Part 3: GCalDaemon Installation

These instructions are generally based on the GCalDaemon web site's installation instructions. They do require use of the command line, but aren't anything too painful.

Begin by downloading the latest Linux installation ZIP file.

Unzip this archive under the '/usr/local/sbin' directory. Assuming you downloaded the ZIP file into ~/downloads/, then:

cd /usr/local/sbin

unzip ~/downloads/gcaldaemon-linux*.zip

chmod -R g+w /usr/local/sbin/GCALDaemon

chmod 755 /usr/local/sbin/GCALDaemon/bin/*.sh

Test your setup by trying to run the password-encoding script:

/usr/local/sbin/GCALDaemon/bin/password-encoder.sh

If you see something like the following, then GCalDaemon is successfully installed:

Your Google password: _

We will run the password encoder script later, during configuration; so for now, hit ENTER to exit the script.

Part 4: iCalendar File Setup

We will use the file-based synchronization scheme, explained by the following diagram (provided by the GCalDaemon web site):

The key to this synchronization scheme is to have an iCal calendar file that is read/written by both GCalDaemon and KDE-PIM.

First, create the iCal file using KDE-PIM:

1. In Kalendar view, select "Add Calendar".
2. In the dialogue that appears, choose "Calendar in Local File".
3. In the Resource Configuration dialogue:
   • Under "General Settings" give the calendar file a name (for this guide, we will assume the file is named "test")
   • In "Location" browse to the location you wish to store the file (this guide will assume "~/calendars/")
   • Under "Calendar Format" ensure "iCalendar" is selected

You will now see your new calendar appear in KDE-PIM. If you want, add a sample event in your calendar.

Now that the calendar file is created, we can configure GCalDaemon to synchronize this file with Google Calendar. To do so, you have two options: editing the configuration file directly, or using the Configuration Editor application.

If you are only synchronizing one calendar file, either method is equally easy. I did find, however, that configuring multiple calendar files to synchronize (I have four) was much easier using the Configuration Editor.

This guide will first explain how to edit the configuration file directly, and then how to run the Configuration Editor.

Part 5a: GCalDaemon Configuration (Editing the Configuration File)

Using the command-line instructions above, run the Password Encoder script:

/usr/local/sbin/GCALDaemon/bin/password-encoder.sh

At the prompt, enter your gmail password. The script will return the result of encoding the password. Take note of this result; you will need it shortly.

Go to Google Calendar, and copy the iCal URL for your calendar's Private Address on the Calendar Settings page.

Now you are ready to edit the configuration file. Using the editor of your choice (e.g. Kate), open the /usr/local/sbin/conf/gcal-daemon.cfg file. Edit as follows:

1. Set the 'file.enabled' property to 'true'
2. Set the 'file.google.username' property to your Gmail address
3. Set the 'file.google.password' property to your encoded password
4. Set the 'file.private.ical.url' property to iCal URL, without protocol and hostname

The following screenshot details the above instructions:

Save and close the file. Everything should now be configured.

Part 5b: GCalDaemon Configuration (Configuration Editor)

GCalDaemon doesn't provide a KMenu shortcut for the Configuration Editor. (You can create one, but doing so it outside the scope of this guide.) To launch the Configuration Editor, use the command-line to run the Config Editor script:

/usr/local/sbin/GCALDaemon/bin/config-editor.sh

This script will run the Configuration Editor, which looks something like the following:

The GCalDaemon website has a nice guide for how to configure using the Configuration Editor (note: the method I describe uses the Offline-Enabled mode). Please see the GCalDaemon guide for screenshots. Also, This guide by MakeTechEasier does a nice job of explaining how to use the Configuration Editor.

To configure:

1. Select the second tab (HTTP Synchronizer) and disable the HTTP-based synchronizer.
2. Select the third tab (File Synchronizer) and enable the file-based synchronizer.
3. Enable the 'dial-up connection' mode (second checkbox on this page)
4. Click on the 'Google Accounts' button.
5. Register your Google Account (note: if you have already configured using the previous method, you will already see your Google account listed): Click on 'New Account', type in your Gmail address and password (twice), then click on 'Verify' button.
6. After the verification, click on the 'OK' button in the "Verify" dialogue.
7. Back in the File Synchronization tab, ensure the tab (at the bottom) that corresponds to your Gmail account is selected, and click on the 'New' button (bottom left). The Google Calendar Synchronization dialogue will appear. Configure as follows:
   • Google Account: Your Gmail account should be selected; if not, select it from the drop-down menu
   • Google Calendar: paste in the Private URL for your Google Calendar (which you noted previously, in Part 5a)
   • iCal File: paste in the file location for your local iCal file, used by KDE-PIM (which you created previously, in Part 4)
8. Click "OK" to be returned to the File Synchronization tab. You will now see the file-synchronization information for your Google Calendar and local iCal file.
9. (Note: if you want to set up multiple calendar-file synchronizations, simply repeat the above steps iin the File Synchronization tab for each calendar to by synchronized. In my case, I have four separate file synchronizations defined here.)
10. Close the Configuration Editor.

GCalDaemon is now fully configured.

Part 6: Running GCalDaemon

Start GCALDaemon by running the "standalone-start.sh" script:

/usr/local/sbin/GCALDaemon/bin/standalone-start.sh

GCalDaemon is now running. You should now see your Google Calendar events in KDE-PIM. Verify the two-way synchronization by adding an event to your calendar in KDE-PIM. Depending on the polling frequency in gcal-daemon.cfg, it may take a few minutes for your new event to appear in your Google Calendar.

It would probably be a good idea to set this script to be started at session startup. (Again, doing so is outside the scope of this guide.) If this script is running, GCalDaemon will continuously poll both your Google Calendar and your local iCal file, and keep both in synch.

If, however, you don't want to leave the script running, you can use the one-time synchronize script whenever you want to synchronize your calendars. This script will run the synchronization and then exit:

/usr/local/sbin/GCALDaemon/bin/sync-now.sh

That's it! Your calendars will stay perpetually synchronized (if you use the always-running script) or will synchronize on command (if you use the one-time synchronization script). Again, the setuip is more involved than using OpenSync, but in the end, maintaining synchronized calendars is easier and more secure using GCalDaemon.

Permalink | 2 comments | Filed Under: Linux | Tagged As: Google Calendar, KDE-PIM, Kubuntu, Synchronization
cb.blog © 2000-2008 | All content licensed under a Creative Commons Attribution-Noncommercial-No Derivative Works 3.0 United States license.