Skip to content

Latest commit

 

History

History
76 lines (45 loc) · 4.34 KB

README.md

File metadata and controls

76 lines (45 loc) · 4.34 KB
Raw

Development stage: alpha Software License

Note

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

Watch the video (YouTube):
Watch the video

Nextcloud extension for WebDAV-Push

nc_ext_dav_push is a Nextcloud extension to demonstrate WebDAV-Push support on calendars (address books are not supported yet).

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.

Warning

This extension is in an 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 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

  • Open App Store of your Nextcloud instance
  • Search for "DAV Push"
  • Click install button

For more details see the apps management section of the nextcloud docs

Latest development version

  • Clone this repository into your apps directory (currently no build step is required, this may change in the future)
  • Open App Store of your Nextcloud instance
  • Search for "DAV Push"
  • Click enable button

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:

  1. Install and enable nc_ext_dav_push on your server (see above).
  2. Install DAVx⁵, add your server. If you already have DAVx⁵ configured with your server, choose Refresh collection list.
  3. DAVx⁵ should now show Server advertises Push support in the details view for the calendars of this server.
  4. Install a UnifiedPush distributor like ntfy.
  5. Connect it with DAVx⁵ app settings / UnifiedPush (experimental). Now the subscription should show up in ntfy (if you're using ntfy).
  6. Activate sync for one or more calendars. In the details view, DAVx⁵ should show Push support: Subscribed after a few seconds.
  7. 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 bitfireAT/davx5-ose#983 for screenshots.