diff --git a/README.md b/README.md index 54847b1..290063f 100644 --- a/README.md +++ b/README.md @@ -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