aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrederick Muriuki Muriithi2023-03-23 09:31:16 +0300
committerFrederick Muriuki Muriithi2023-03-23 09:31:16 +0300
commit7cf0c43020736d1ec4fa2efddad7d2fcd8fb5840 (patch)
treef4d85bd065e154fed0857fc6fe3b42586270b042
parentd4b48aef6cca3182559f7479cace3bd77cc1fb40 (diff)
downloadgenenetwork3-7cf0c43020736d1ec4fa2efddad7d2fcd8fb5840.tar.gz
Docs: Add a note on how the configuration system works.
-rw-r--r--README.md14
1 files changed, 13 insertions, 1 deletions
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
```