ToxicMushroom/tokidoki
1
0
Fork 0
mirror of https://git.sr.ht/~sircmpwn/tokidoki synced 2025-12-12 06:07:22 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add more details to README

Browse source
This commit is contained in:
Conrad Hoffmann 2022-05-19 12:22:41 +02:00
parent c033c1dfcb
commit d05d1d486e
1 changed files with 20 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -2,12 +2,31 @@
Tokidoki is a (WIP) carddav and caldav server. Tokidoki is a (WIP) carddav and caldav server.
## Architecture
Tokidoki relies on [go-webdav][1] for the protocol implementation. It provides
the storage backend and authentication, both of which are easily pluggable.
It currently provides:
Authentication:
* IMAP (working)
Storage:
* Filesystem (working)
* PostgreSQL (planned)
[1]: https://github.com/emersion/go-webdav "go-webdav project page on Github"
## Building ## Building
* `cd cmd/tokidoki && go build` * `cd cmd/tokidoki && go build`
## Running ## Running
Using the IMAP authentication backend and the filesystem storage backend: Using the IMAP authentication backend and the filesystem storage backend
(directory must exist):
* `./tokidoki -auth.url imaps://imap.example.com:993 -storage.url file:///path/to/storage -debug` * `./tokidoki -auth.url imaps://imap.example.com:993 -storage.url file:///path/to/storage -debug`