Document needing to run 'stack build' after changing settings (#40)

* Document needing to run 'stack build' after changing settings

* update readme

Co-authored-by: Jon Schoning <jonschoning@gmail.com>
This commit is contained in:
Dan Poirier 2022-06-03 10:34:48 -04:00 committed by Yann Esposito (Yogsototh)
parent 1a3bbef162
commit 3d66c508ff
Signed by untrusted user who does not match committer: yogsototh
GPG key ID: 7B19A4C650D59646

View file

@ -63,11 +63,18 @@ see https://github.com/jonschoning/espial-docker
stack exec espial
```
see `config/settings.yml` for changing default run-time parameters / environment variables
### Configuration
default app http port: `3000`
See `config/settings.yml` for changing default run-time parameters & environment variables.
- `config/settings.yml` is embedded into the app executable when compiled, so after changing `config/settings.yml`, run `stack build` again to apply the new settings.
- `config/settings.yml` values formatted like `_env:ENV_VAR_NAME:default_value` can be
overridden by the specified environment variable.
- Example
- `_env:PORT:3000`
- environment variable `PORT`
- default app http port: `3000`
ssl: use reverse proxy
SSL: use reverse proxy
## Development