From ed5bb6517dc5d60d52fa515bb18f057fce1877d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Hru=C5=A1ka?= Date: Sun, 10 May 2020 20:01:03 +0200 Subject: [PATCH] document the config file --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 64aa004..8ad3fd0 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,16 @@ other uses I didn't think of. The uploaded files have a lifetime of 10 minutes, which can be shortened or extended up to 1 hour (or more, as configured). +## Config file + +The server application reads a config file, called `postit.json` by default. +The file path can be set by a CLI argument (see `--help`). + +Call the binary with `--default-config` to dump the default JSON. See `src/config.rs` +for documentation of the format. + +The JSON file uses the JSON5 format - comments are allowed. + ## Uploading a file To upload a file, send a POST request to the running PostIt server.