Add environment variables for configuration to README.md

This commit is contained in:
TSR Berry 2023-06-09 16:26:12 +02:00
parent 99d5a73e49
commit ec41207426
No known key found for this signature in database
GPG key ID: 52353C0A4CCA15E2

View file

@ -16,9 +16,16 @@
</a> </a>
</p> </p>
## 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 ## Contribute