~sircmpwn/tokidoki

bbb170aa6858a1f316764fba360c88b312df4de2 — Conrad Hoffmann 1 year, 6 months ago 0a5e694
Improve README: TLS, logging
1 files changed, 15 insertions(+), 4 deletions(-)

M README.md
M README.md => README.md +15 -4
@@ 28,13 28,24 @@ Storage:

## Running

Here are some examples to get you started:

Using the IMAP authentication backend and the filesystem storage backend
(directory must exist), listening on port 8080 on all interfaces:
(directory must exist), listening on port 8080 on all interfaces, with debug
logs enabled:

```
./tokidoki -addr ":8080" -auth.url imaps://imap.example.com:993 -storage.url file:///path/to/storage -log.debug
```

Using the PAM authentication backend and TLS:

* `./tokidoki -addr ":8080" -auth.url imaps://imap.example.com:993 -storage.url file:///path/to/storage -debug`
```
./tokidoki -addr ":8080" -auth.url pam:// -storage.url file:///path/to/storage -cert cert.pem -key key.pem
```

Tokidoki does not support HTTPS at this time, use a reverse TLS proxy if
needed.
Regular logs are sent to stderr, HTTP logs are sent to stdout. Structured
logging can be enabled for the regular logs with `-log.json`.

## Clients