From d6ff3b39d27b7f4a31f19b6761faf13a40f006c7 Mon Sep 17 00:00:00 2001
From: Thomas Dupont <thomas.dupont@ugent.be>
Date: Wed, 6 Jul 2022 15:00:57 +0200
Subject: [PATCH] docs: Update readme with config as env var update

docs: simplify readme section
---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README.md b/README.md
index 5a5a1bce5..4c7268f6f 100644
--- a/README.md
+++ b/README.md
@@ -81,6 +81,8 @@ docker run --rm -v ~/Solid:/data -p 3000:3000 -it solidproject/community-server:
 docker run --rm -p 3000:3000 -it solidproject/community-server -c config/default.json
 # Or use your own configuration mapped to the right directory
 docker run --rm -v ~/solid-config:/config -p 3000:3000 -it solidproject/community-server -c /config/my-config.json
+# Or use environment variables to configure your css instance
+docker run --rm -v ~/Solid:/data -p 3000:3000 -it -e CSS_CONFIG=config/file-no-setup.json -e CSS_LOGGING_LEVEL=debug solidproject/community-server
 ```
 
 ### 🗃️ Helm Chart
@@ -119,6 +121,15 @@ to some commonly used settings:
 | `--seededPodConfigJson` |                           | Path to the file that keeps track of seeded Pod configurations. |
 | `--mainModulePath, -m` |                            | Path from where Components.js will start its lookup when initializing configurations.                                                |
 
+### 🖥️ Environment variables
+Parameters can also be passed through environment variables. 
+
+They are prefixed with `CSS_` and converted from `camelCase` to `CAMEL_CASE`
+
+> eg. `--showStackTrace` => `CSS_SHOW_STACK_TRACE`
+
+**Note: command-line arguments will always override environment variables!**
+
 ### 🧶 Custom configurations
 More substantial changes to server behavior can be achieved
 by writing new configuration files in JSON-LD.