From 2b47dee38e042502dcd7a59b745b883b7213129f Mon Sep 17 00:00:00 2001 From: Joseph Hunkeler Date: Mon, 4 Jul 2016 11:29:10 -0400 Subject: Add configuration information to README --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) 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 ``` - -- cgit