Skip to content

Commit d98d43c

Browse files
rubo77jplitza
authored andcommitted
README: cleanup whitespaces
1 parent bc9f44c commit d98d43c

File tree

1 file changed

+33
-36
lines changed

1 file changed

+33
-36
lines changed

README.md

Lines changed: 33 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,7 @@ Run `backend.py --help` for a quick overview of all available options.
1414

1515
For the script's regular execution add the following to the crontab:
1616

17-
<pre>
18-
* * * * * backend.py -d /path/to/output -a /path/to/aliases.json --vpn ae:7f:58:7d:6c:2a d2:d0:93:63:f7:da
19-
</pre>
17+
* * * * * backend.py -d /path/to/output -a /path/to/aliases.json --vpn ae:7f:58:7d:6c:2a d2:d0:93:63:f7:da
2018

2119
# Dependencies
2220

@@ -87,12 +85,11 @@ If you want to still use the old [ffmap-d3](https://github.com/ffnord/ffmap-d3)
8785
front end, you can use the file `ffmap-d3.jq` to convert the new output to the
8886
old one:
8987

90-
```
91-
jq -n -f ffmap-d3.jq \
92-
--argfile nodes nodedb/nodes.json \
93-
--argfile graph nodedb/graph.json \
94-
> nodedb/ffmap-d3.json
95-
```
88+
jq -n -f ffmap-d3.jq \
89+
--argfile nodes nodedb/nodes.json \
90+
--argfile graph nodedb/graph.json \
91+
> nodedb/ffmap-d3.json
92+
9693

9794
Then point your ffmap-d3 instance to the `ffmap-d3.json` file.
9895

@@ -110,8 +107,8 @@ database.
110107
After running ffmap-backend, copy `graph.json` to your webserver. Then,
111108
filter `nodes.json` using `jq` like this:
112109

113-
jq '.nodes = (.nodes | map(del(.nodeinfo.owner)))' \
114-
< /ffmap-data/nodes.json > /var/www/data/nodes.json
110+
jq '.nodes = (.nodes | map(del(.nodeinfo.owner)))' \
111+
< /ffmap-data/nodes.json > /var/www/data/nodes.json
115112

116113
This will remove owner information from nodes.json before copying the data
117114
to your webserver.
@@ -122,7 +119,7 @@ to your webserver.
122119
# Convert from nodes.json version 1 to version 2
123120

124121
jq '.nodes = (.nodes | to_entries | map(.value)) | .version = 2' \
125-
< nodes.json > nodes.json.new
122+
< nodes.json > nodes.json.new
126123
mv nodes.json.new nodes.json
127124

128125

@@ -131,36 +128,36 @@ to your webserver.
131128
## Comand line arguments
132129
Running `backend.py` with `--with-graphite` will enable graphite support for storing statistical data.
133130

134-
graphite integration:
135-
--with-graphite Send statistical data to graphite backend
136-
--graphite-host GRAPHITE_HOST
137-
Hostname of the machine running graphite
138-
--graphite-port GRAPHITE_PORT
139-
Port of the carbon daemon
140-
--graphite-prefix GRAPHITE_PREFIX
141-
Storage prefix (default value: 'freifunk.nodes.')
142-
--graphite-metrics GRAPHITE_METRICS
143-
Comma separated list of metrics to store (default
144-
value: 'clients,loadavg,uptime')
131+
graphite integration:
132+
--with-graphite Send statistical data to graphite backend
133+
--graphite-host GRAPHITE_HOST
134+
Hostname of the machine running graphite
135+
--graphite-port GRAPHITE_PORT
136+
Port of the carbon daemon
137+
--graphite-prefix GRAPHITE_PREFIX
138+
Storage prefix (default value: 'freifunk.nodes.')
139+
--graphite-metrics GRAPHITE_METRICS
140+
Comma separated list of metrics to store (default
141+
value: 'clients,loadavg,uptime')
145142

146143
## Graphite configuration
147144

148145
### storage-schemas.conf
149146

150-
[freifunk_node_stats]
151-
pattern = ^freifunk\.nodes\.
152-
retentions = 60s:1d,5min:7d,1h:30d,1d:4y
153-
147+
[freifunk_node_stats]
148+
pattern = ^freifunk\.nodes\.
149+
retentions = 60s:1d,5min:7d,1h:30d,1d:4y
150+
154151
### storage-aggregation.conf
155152

156-
[freifunk_node_stats_loadavg]
157-
pattern = ^freifunk\.nodes\..*\.loadavg$
158-
aggregationMethod = avg
153+
[freifunk_node_stats_loadavg]
154+
pattern = ^freifunk\.nodes\..*\.loadavg$
155+
aggregationMethod = avg
159156

160-
[freifunk_node_stats_clients]
161-
pattern = ^freifunk\.nodes\..*\.clients$
162-
aggregationMethod = max
157+
[freifunk_node_stats_clients]
158+
pattern = ^freifunk\.nodes\..*\.clients$
159+
aggregationMethod = max
163160

164-
[freifunk_node_stats_uptime]
165-
pattern = ^freifunk\.nodes\..*\.uptime$
166-
aggregationMethod = last
161+
[freifunk_node_stats_uptime]
162+
pattern = ^freifunk\.nodes\..*\.uptime$
163+
aggregationMethod = last

0 commit comments

Comments
 (0)