How to sync contacts and calendars between desktop and Android (without root)

[tomasz86]

This is a simple guide on how to synchronise contacts and calendars between a desktop operating system (Windows, macOS, Linux) and Android relying on a combination of Syncthing and Radicale. The main goal and idea is to have Radicale running on every system locally, so that you can connect with it even when there is no network connection available. This applies to both desktop operating systems and Android as well.

Desktop:

1. Install and run Radicale following instructions from https://radicale.org.

2. Use relative paths in the Radicale config file, so that everything is contained in the same folder.

3. For reference, my Radicale config looks somewhat like this:

   [auth]
   type = htpasswd
   htpasswd_filename = users
   htpasswd_encryption = plain
   
   [server]
   hosts = localhost:5232
   
   [storage]
   filesystem_folder = .
   type=multifilesystem_nolock
   

   The last line, i.e. type=multifilesystem_nolock, is required when running Radicale on some filesystems, e.g. FAT on Android.

4. Sync contacts via CardDAV and calendars via CalDAV between Radicale and a local client application, e.g. Thunderbird.

5. Add the whole local Radicale folder to Syncthing.

6. Add .Radicale.cache to the folder’s ignore patterns.

7. Share the Radicale folder from the desktop to the Android device.

Android:

1. Accept the shared Radicale folder, placing it somewhere on the internal storage, e.g. /sdcard/Syncthing/Radicale.

2. Install Termux (https://wiki.termux.com/wiki/Installation).

3. Install Termux:Boot (https://wiki.termux.com/wiki/Termux:Boot).

4. In Android settings, give Termux permission to access files and also exclude the app from battery optimisation. The first is required for Radicale to access the Syncthing folder, and the second for DAVx⁵ to trigger Radicale sync when in background.

5. Inside Termux, update repositories first:

   pkg up
   

6. Install Python:

   pkg install python
   

7. Install Radicale:

   pip install radicale
   

8. Install Vim:

   pkg install vim
   

   Of course, you can use another text editor of choice instead.

9. Create a new text file called radicale.sh at ~/.termux/boot:

   mkdir ~/.termux/boot
   touch ~/.termux/boot/radicale.sh
   

10. Edit the newly created file with Vim:

    vim ~/.termux/boot/radicale.sh
    

11. Inside the file, write:

    #!/data/data/com.termux/files/usr/bin/sh
    cd "/sdcard/Syncthing/Radicale"
    python -m radicale --config="radicale.ini"
    

    Note: This assumes that your Radicale config file is called radicale.ini.

12. From now on, Radicale should start automatically on boot, and you can connect to it via a Web browser the same way as you would on the desktop.

13. Install DAVx⁵ (https://f-droid.org/packages/at.bitfire.davdroid) and use it to sync contacts and calendars between Radicale and Android.

    Note: if Data Saver is enabled in the OS, you need to exclude DAVx⁵ from it, or otherwise nothing will happen when trying to run the sync (despite the fact that it happens fully offline ).

While this method may sound complicated at first, I have been using it for years now with zero issues. I had also tried using DecSync (https://github.com/39aldo39/DecSync) before, however it proved to be very buggy for me, hence I switched to this method instead. The main advantage is that Radicale runs locally both on the desktop and Android, which makes it possible to add, edit, and delete items offline, and Syncthing will sync the changes once connected. Of course, as with any other type of sync, simultaneous modifications on multiple devices will lead to conflicts, so you mustn’t edit the same events or contacts without syncing the previous changes first.

I also understand that this short guide assumes the user has already got some basic knowledge on how to install software and operate the command line. I may try to make the guide more beginner-friendly later on, but unfortunately I’m very limited on time right now, so I’ve only wanted to lay out the basic steps to follow along.

I hope someone will find this guide useful .

PS Inside Termux, you can test the script simply by executing it manually first, e.g. sh ~/.termux/boot/radicale.sh in order to verify that it actually works while watching the output live before trying to start in on boot (and possibly debug any errors there).

[JohnVeness]

Nice tutorial!

I was wondering what problems you were having with DecSync, though? It seems to work fine for me…

[tomasz86]

@JohnVeness

Nice tutorial!

Thank you .

@JohnVeness

I was wondering what problems you were having with DecSync, though? It seems to work fine for me…

I wasn’t able to import my existing contacts and calendars into it (see https://github.com/39aldo39/Radicale-DecSync/issues/6, the issue is still open), and also DecSync has a problem of creating a vast and always growing number of tiny files (see https://github.com/39aldo39/DecSync/issues/2), which is a problem for Syncthing specifically, because it slows down synchronisation, especially on Android (11 and newer), where dealing with thousands of files is very slow due to FUSE.

On the other hand, Radicale by itself only stores and syncs actual calendar event .ics files and contact .vcf files without any additional metadata attached to them separately (as long as you ignore the cache files as recommended in the instructions).

Of course, if DecSync works for you, then I’m not saying that there’s anything wrong with using it, especially considering that it’s much easier to set up on Android.

[onetimecontributor]

Thank you again for the guide. It works (with a+x for .sh and pwd file creation)! )

What do you do to encrypt content of collections so other apps can’t access it? I couldn’t easilty spot any config or plugin that enables it.

Reasoning

“All files” permission on Android is somewhat more widespread than Contacts. In my case, it’s: Contacts is only 6 of 50 apps allowed “Files and media”: 44 apps allowed out of 77 “All files”: 7 apps (termux+tasker+syncthing+“file manager”…) And that’s not counting “systems” apps like all those “nearby share” etc that has “all files” access.

[tomasz86]

@onetimecontributor

What do you do to encrypt content of collections so other apps can’t access it? I couldn’t easilty spot any config or plugin that enables it.

I don’t think you can protect the data like that and still make it accessible to other applications. This is because the folder in question needs to be in a location that both Syncthing and Termux can read and write to.

Personally, I’m not really worried about other apps that much. I always try to use free and open source applications whenever possible, and if not, I stick to using the big names, avoiding unknown, closed source ones. I do use full disk encryption on all my devices to protect them from unauthorised physical access.

[Wank]

Lots of good work, and not easy.

Will set this aside in case it’s needed. Right now I have contacts and calendar synchronizing through Gmail because I’m an Android user.

Thunderbird works with Gmail natively so I can’t see a need for it at the moment but thank you.

[onetimecontributor]

@tomasz86

I don’t think you can protect the data like that

I would like to thank you again for the guide, I’m piloting it for several users though still having troubles with how to avoid “allow all of them to use battery without any limits”.

Re encryption - it looks like one can create needed “Storage plugin” for Radicale similarly t what was done for ?esty. I’m not talking here about secure vault invisible to anyone, but at least not storing them in plain text in plain sight - similarly to what is done in KeePassDX where pwd DB is kept in encrypted manner in “publicly accessible” space.

[PK-4 (pk)]

Hi @tomasz86, very nice work. This is essentially what I was looking for, for a long time and is well presented for my level of knowledge.

However I am struggling to set up the android version. At the point, where your “radicale.ini” config comes into play, I dont know what to do. I cant find this file anywhere neither do I know how to create it. And if I just run it without a specification I cant get it to run the desired Syncthing Folder as its storage without crashing. Could you go a little bit into detail on the android installation? I would really love to make this work, since everything else is very smoothly running.

[tomasz86]

The question seems to be more about how to configure Radicale itself than related to Syncthing, however my radicale.ini basically looks like this:

[auth]
type = htpasswd
htpasswd_filename = users
htpasswd_encryption = plain

[server]
hosts = localhost:5232

[storage]
filesystem_folder = .
type=multifilesystem_nolock

and then the users file in the same folder:

user1:password1
user2:password2

Obviously, you should use your preferred usernames and passwords here.

filesystem_folder = . makes Radicale store all files inside the collection-root folder in the same path as radicale.ini is located.

This is basically it, but if you still have problems, please share screenshots of your configuration, including the exact path and structure of your Radicale folder that you sync with Syncthing.

[artifact]

This is a really great idea, thanks so much for the guide. Unfortunately, termux can only be run from the primary user account. The bootstrap binaries have a hardcoded $PREFIX path that can not be installed to any other path than /data/data/com.termux/files/usr. I run multiple profiles on my phone, and leave the primary as bare as possible. As such, I can’t run termux in that profile. There does seem to be ways to bypass this restriction via binary patching, but that also requires root. Does anyone know of alternative methods for running radicale on android?