melon/tokidoki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add usage notes to README

Browse Source 
Specifically, mention some of the current limitations.
This commit is contained in:
Conrad Hoffmann 2022-05-20 09:45:17 +02:00
parent d05d1d486e
commit 21514ae6b0
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -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