Nextcloud extension to support WebDAV-Push on calendars/address books

Find a file

Jonathan Treffler 6a863cb9c0 mark nc 30 as compatible		2024-08-25 19:26:28 +02:00
.github/workflows	[CI] Add Dependent Issues	2024-08-19 18:08:59 +02:00
.vscode	app init; implemented service detection	2024-04-05 20:26:15 +02:00
appinfo	mark nc 30 as compatible	2024-08-25 19:26:28 +02:00
lib	fix notify error handling	2024-08-18 17:43:20 +02:00
.gitignore	Initial commit	2024-01-30 17:57:12 +01:00
LICENSE	Initial commit	2024-01-30 17:57:12 +01:00
README.md	Update README (#13 )	2024-08-23 17:49:58 +02:00

README.md

Note: If you're coming from the Nextcloud Conf 2024 lightning talk, you can find the slides here.

Nextcloud extension for WebDAV-Push

nc_ext_dav_push is a Nextcloud extension to demonstrate WebDAV-Push support on calendars/address books.

It is the server part of our efforts to draft a WebDAV-Push standard and provide a working implementation (server + client) in order to demonstrate it.

This extension is in a very early stage of development. It is for demonstration and testing purposes only. Don't use it on production systems!

For instance, push subscriptions currently don't expire, can't be deleted by clients and won't be removed when they have become invalid. So the table will grow bigger and bigger and everything will become slow over time.

You can however install/enable the extension to test it and disable or remove it again at any time. When the extension is disabled, it doesn't influence your system.

About WebDAV-Push

In proprietary environments, changes in events and contacts are nowadays usually pushed to other clients so that they can update their views almost in real-time.

WebDAV however (and in this context, especially CalDAV and CardDAV) doesn't currently support push notifications of clients when a collection has changed. So clients have to periodically ask the server for changes. This causes unnecessary delays and battery usage.

WebDAV-Push, which is currently in development, wants to solve this problem with an open protocol, too. See the WebDAV-Push repository for more information.

Who is behind WebDAV-Push?

The current WebDAV-Push draft is provided by @bitfireAT.

This Nextcloud extension has been developed by @JonathanTreffler for @verdigado, who are also interested in WebDAV-Push.

Contact

If you have questions/suggestions or just want to show your interest about

WebDAV-Push in general, see WebDAV-Push: Contact for various options;
for discussion about this Nextcloud extension specifically, use the issues.

Installation instructions

App Store

...

Latest development version

From git ...

Usage with DAVx⁵

When you have installed the Nextcloud extension, you need a client that supports WebDAV-Push to make use of it.

Currently, only DAVx⁵ (≥ 4.4.2) supports WebDAV-Push. To get it working:

Install and enable nc_ext_dav_push on your server (see above).
Install DAVx⁵, add your server. If you already have DAVx⁵ configured with your server, choose Refresh collection list.
DAVx⁵ should now show Server advertises Push support in the details view for the calendars of this server.
Install a UnifiedPush distributor like ntfy.
Connect it with DAVx⁵ app settings / UnifiedPush (experimental). Now the subscription should show up in ntfy (if you're using ntfy).
Activate sync for one or more calendars. In the details view, DAVx⁵ should show Push support: Subscribed after a few seconds.
Whenever a new event is created or an existing event is updated by any client (for instance, in the Nextcloud Calendar), DAVx⁵ should receive a push notification and start a sync very soon (usually a few seconds).

See https://github.com/bitfireAT/davx5-ose/discussions/983 for screenshots.