Skip to content

Commit

Permalink
Update README.md with configuration options
Browse files Browse the repository at this point in the history
  • Loading branch information
181192 committed Feb 26, 2021
1 parent 505e64e commit da5fc5a
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -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
Expand Down

0 comments on commit da5fc5a

Please sign in to comment.