From ec41207426242359f04109f3d11bf52e43644a3d Mon Sep 17 00:00:00 2001 From: TSR Berry <20988865+TSRBerry@users.noreply.github.com> Date: Fri, 9 Jun 2023 16:26:12 +0200 Subject: [PATCH] Add environment variables for configuration to README.md --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cf85058..8e28fa1 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,16 @@

-## Changelog +## Configuration -The complete list of changes is available [here](CHANGELOG.md) +This app can be configured using the following environment variables: + +| Name | Description | Default value | Notes | +| :---------- | ----------------------------------------------------------------------------------------- | :-----------: | ---------------------------------------------------------------------- | +| `NODE_ENV` | This should be set to `production` or `development` depending on the current environment. | `""` | | +| `HOST` | The address this server should be listening on. | `"127.0.0.1"` | | +| `PORT` | The port this server should be using. | `3000` | | +| `REDIS_URL` | The URL of the redis server. | `""` | Format: `redis[s]://[[username][:password]@][host][:port][/db-number]` | ## Contribute