Add more details to README
This commit is contained in:
parent
c033c1dfcb
commit
d05d1d486e
21
README.md
21
README.md
@ -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`
|
||||||
|
Loading…
Reference in New Issue
Block a user