From da5fc5a6ffa4ccf3a541635120db1707269689e8 Mon Sep 17 00:00:00 2001 From: 181192 Date: Fri, 26 Feb 2021 16:39:54 +0100 Subject: [PATCH] Update README.md with configuration options --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3aba47d..2662436 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ And here's the `application/json` respons: { "code": "404", "title": "Not Found", - "message": [ + "messages": [ "The page you're looking for could not be found." ], "details": { @@ -42,6 +42,16 @@ And here's the `application/json` respons: custom-error-pages supports 404, 500, 503 and 5xx error codes. +## Configurations + +| Flag | Evironment variable | Default | Description | +| ----------------------- | --------------------- | ------- | --------------------------------------------------- | +| `--debug` | `DEBUG` | `false` | enable debug log | +| `--error-files-path` | `ERROR_FILES_PATH` | `./www` | the location on disk of files served by the handler | +| `--hide-details` | `HIDE_DETAILS` | `false` | hide request details in response | +| `--http-listen-address` | `HTTP_LISTEN_ADDRESS` | `:8080` | http server address | +| `--log-color` | `LOG_COLOR` | `false` | sets log format to human-friendly, colorized output | + ## Getting started - Locally `go get` ```bash