aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@gmail.com>2016-07-04 11:29:10 -0400
committerJoseph Hunkeler <jhunkeler@gmail.com>2016-07-04 11:29:10 -0400
commit2b47dee38e042502dcd7a59b745b883b7213129f (patch)
tree4b0cd6dd8719349ef5f016d7b70cf46ab644b9ad /README.md
parentcb30392b30adad49b4fca75f12a29d226e12adff (diff)
downloadsteuermann-2b47dee38e042502dcd7a59b745b883b7213129f.tar.gz
Add configuration information to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 23 insertions, 1 deletions
diff --git a/README.md b/README.md
index 70bac9a..b2460f5 100644
--- a/README.md
+++ b/README.md
@@ -15,10 +15,32 @@ python setup.py install
Put the installed script, `steuermann_report.cgi`, on your web server.
+## To configure:
+
+```bash
+# Create default configuration directory
+mkdir ~/.steuermann/default
+
+# Copy default hosts.ini template
+cp steuermann/hosts.ini ~/.steuermann/default
+
+# Generate basic configuration file
+cat << EOF > ~/.steuermann/default/config.py
+db_creds = '/path/to/steuermann.db'
+logdir = '/path/to/logs'
+host_logs = '/path/to/host_logs'
+EOF
+```
+
+You can override the default configuration directory by setting `STEUERMANN_CONFIG`:
+
+```bash
+export STEUERMANN_CONFIG=/alternate/path/here
+```
+
## To run:
```
smc [ -a ] [ -r run_name ] file.sm
```
-