From 21514ae6b0a136957c4b37c2f6c5a070c2b3a805 Mon Sep 17 00:00:00 2001 From: Conrad Hoffmann Date: Fri, 20 May 2022 09:45:17 +0200 Subject: [PATCH] Add usage notes to README Specifically, mention some of the current limitations. --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e5ae594..9481bf4 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,22 @@ Storage: ## Running Using the IMAP authentication backend and the filesystem storage backend -(directory must exist): +(directory must exist), listening on port 8080 on all interfaces: -* `./tokidoki -auth.url imaps://imap.example.com:993 -storage.url file:///path/to/storage -debug` +* `./tokidoki -addr ":8080" -auth.url imaps://imap.example.com:993 -storage.url file:///path/to/storage -debug` + +Tokidoki does not support HTTPS at this time, use a reverse TLS proxy if +needed. + +## Usage + +Only a single address book and calendar per user are supported at the moment, +this is currently a [limitation in go-webdav][2]. + +Tokidoki supports calendar and address book auto-discovery via +`/.well-known/caldav` and `/.well-known/carddav` respectively, as defined in +[RFC 6764, section 6][3]. Hence, most clients should be able to discover +resources by just pointing them at the server root. + +[2]: https://github.com/emersion/go-webdav/issues/26 +[3]: https://datatracker.ietf.org/doc/html/rfc6764#section-6