summaryrefslogtreecommitdiffstats
path: root/python/README.md
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2019-01-04 13:00:38 -0800
committerBryan Newbold <bnewbold@robocracy.org>2019-01-04 13:00:38 -0800
commitbb6840ab32d39240442f32c89ac3c4d0722d8372 (patch)
treea6b6b347a71255f2e5ec320dce7faa37555b1f6d /python/README.md
parent00c0859a7df360380a479eb9dbc79057c0245969 (diff)
downloadfatcat-bb6840ab32d39240442f32c89ac3c4d0722d8372.tar.gz
fatcat-bb6840ab32d39240442f32c89ac3c4d0722d8372.zip
use .env for all config (and document it)
Diffstat (limited to 'python/README.md')
-rw-r--r--python/README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/python/README.md b/python/README.md
index d8812934..922499f3 100644
--- a/python/README.md
+++ b/python/README.md
@@ -34,6 +34,10 @@ server on the same machine by default), use:
# will listen on http://localhost:9810 by default
pipenv run fatcat_webface.py
+Almost all configuration is done via environment variables; see `env.example`
+for a list of settings. If you copy this file to `.env` it will be sourced by
+`pipenv` automatically; you can also load it in your shell like `source .env`.
+
## Running Tests
Many (though not all) python tests depend on access to a local running API