From bbb170aa6858a1f316764fba360c88b312df4de2 Mon Sep 17 00:00:00 2001 From: Conrad Hoffmann Date: Sat, 17 Dec 2022 21:12:34 +0100 Subject: [PATCH] Improve README: TLS, logging --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 81d705f..8a8b7b6 100644 --- a/README.md +++ b/README.md @@ -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