From 7cf0c43020736d1ec4fa2efddad7d2fcd8fb5840 Mon Sep 17 00:00:00 2001
From: Frederick Muriuki Muriithi
Date: Thu, 23 Mar 2023 09:31:16 +0300
Subject: Docs: Add a note on how the configuration system works.

---
 README.md | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index aeb2db8..53fad3d 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,18 @@ A continuously deployed instance of genenetwork3 is available at
 redeployed on every commit provided that the [continuous integration
 tests](https://ci.genenetwork.org/jobs/genenetwork3) pass.
 
+## Configuration
+
+The system comes with some default configurations found in **"gn3/settings.py"**
+relative to the repository root.
+
+To overwrite these settings without changing the file, you can provide a path in
+the `GN3_CONF` environment variable, to a file containing those variables whose
+values you want to change.
+
+The `GN3_CONF` variable allows you to have your own environment-specific
+configurations rather than being forced to conform to the defaults.
+
 ## Installation
 
 #### GNU Guix packages
@@ -269,7 +281,7 @@ export FLASK_DEBUG=1
 export FLASK_APP="main.py"
 flask run --port=8080
 ```
-
+n
 And test with
 
 ```
-- 
cgit 1.4.1