Updating README.md to describe the use of a custom configuration

oduwsdl · Oct 12, 2018 · dc77d4da4713300cd2aea88bd66b04c35aacd224 · dc77d4d
1 parent b7d587b
commit dc77d4da4713300cd2aea88bd66b04c35aacd224
Unified Split

Showing with 11 additions and 0 deletions.

+11 −0 README.md
diff --git a/README.md b/README.md
@@ -66,6 +66,17 @@ $ export FLASK_APP=mementoembed
 $ flask run
 ```
+  
+### Loading a Desired Configuration
+  
+
+  
+The configuration options for MementoEmbed are documented in `sample_appconfig.cfg`.
+  
+
+  
+The defaults are stored in `config/default.py`.
+  
+
+  
+To use your own configuration file, copy `sample_appconfig.cfg`, make modifications, and place it in `/etc/mementoembed.cfg`. Then run the application locally as described above.
+  
+
+  
+To use your own configuration file stored at `/path/to/my/config.cfg` with a Docker image, use the `-v` Docker option:
+  
+`docker run -it --rm -v /path/to/my/config.cfg:/etc/mementoembed.cfg  -p 5550:5550 oduwsdl/mementoembed`
+  
+
 ## Directory Layout
 The following directory structure exists for organizing MementoEmbed: