From 509cc8d7a18a03fdd77f4822f8d35d823f90fd66 Mon Sep 17 00:00:00 2001 From: Lennart <18233294+lennart-k@users.noreply.github.com> Date: Sat, 5 Jul 2025 10:22:32 +0200 Subject: [PATCH] docs: Add documentation to setup some clients (more to follow) --- docs/setup/client.md | 60 ++++++++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 61 insertions(+) create mode 100644 docs/setup/client.md diff --git a/docs/setup/client.md b/docs/setup/client.md new file mode 100644 index 0000000..64b308c --- /dev/null +++ b/docs/setup/client.md @@ -0,0 +1,60 @@ +# Client Setup + +## Common + +Following resources are available. + +``` +/.well-known/caldav +# CalDAV root +/caldav +# Principal home +/caldav/principal/ +# Calendar home +/caldav/principal// +/caldav/principal//_birthdays_ +``` + +``` +/.well-known/carddav +# CardDAV root +/carddav +# Principal home +/carddav/principal/ +# Addressbook home +/carddav/principal// +``` + +### Authentication + +Authenticate with HTTP Basic authentication using your user id and a generated app token. + +## DAVx5 + +You can set up DAVx5 through the Nextcloud login flow. Collections including group collections will automatically be discovered. + +## Apple Calendar + +You can download a configuration profile from the frontend in the app token section. + +**Limitation**: Group collections are not automatically discovered, for these you need to set up separate CalDAV configurations using the corresponding principal homes (but your own user id). + +## Evolution + +Set up a collection account in the account settings. + +**Limitation**: Group collections are not discovered. It seems as if currently you have to add each group collection manually. + +## Home Assistant CalDAV integration + +As URL specify + +``` +https:///.well-known/caldav +``` + +For goup collections explicitly specify + +``` +https:///caldav/principal/ +``` diff --git a/mkdocs.yml b/mkdocs.yml index b20681e..86cdb0a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -68,6 +68,7 @@ nav: - Installation: - installation/index.md - Configuration: installation/configuration.md + - Client Setup: setup/client.md - OpenID Connect: setup/oidc.md - Developers: - developers/index.md