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

Improve README: TLS, logging

Browse Source
This commit is contained in:
Conrad Hoffmann 2022-12-17 21:12:34 +01:00
parent 0a5e6946fb
commit bbb170aa68
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -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 -debug`
```
./tokidoki -addr ":8080" -auth.url imaps://imap.example.com:993 -storage.url file:///path/to/storage -log.debug
```
Tokidoki does not support HTTPS at this time, use a reverse TLS proxy if
needed.
Using the PAM authentication backend and TLS:
```
./tokidoki -addr ":8080" -auth.url pam:// -storage.url file:///path/to/storage -cert cert.pem -key key.pem
```
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