aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 0c2d313ebe45029e05dd84ef1979da0556e06b71 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# Steuermann

## How to pronounce the name:

http://www.forvo.com/word/steuer-/#de

http://www.forvo.com/word/mann/#de


## To install:

```
python setup.py install
```

Put the installed script, `steuermann_report.cgi`, on your web server.

## To configure:

```bash
# Create default configuration directory
mkdir -p ~/.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
```