From 3d66c508ff181cc5a80426fe166492afe2795de3 Mon Sep 17 00:00:00 2001 From: Dan Poirier Date: Fri, 3 Jun 2022 10:34:48 -0400 Subject: [PATCH] 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 --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) 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