VNcBCbfG

1# This is the config file for Yanic written in "Tom's Obvious, Minimal Language."
2# syntax: https://github.com/toml-lang/toml
3# (if you need somethink multiple times, checkout out the [[array of table]] section)
4
5# Send respondd request to update information
6[respondd]
7enable           = true
8# Delay startup until a multiple of the period since zero time
9synchronize      = "1m"
10# how often request per multicast
11collect_interval = "1m"
12
13# table of a site to save stats for (not exists for global only)
14#[respondd.sites.example]
15## list of domains on this site to save stats for (empty for global only)
16#domains = []
17## example
18[respondd.sites.ffhb]
19domains            = ["city"]
20
21# interface that has an IP in your mesh network
22#[[respondd.interfaces]]
23# name of interface on which this collector is running
24[[respondd.interfaces]]
25ifname = "bat01"
26[[respondd.interfaces]]
27ifname = "bat02"
28[[respondd.interfaces]]
29ifname = "bat03"
30[[respondd.interfaces]]
31ifname = "bat04"
32
33# ip address which is used for sending
34# (optional - without definition used a address of ifname)
35#ip_address = "fd2f:5119:f2d::5"
36# disable sending multicast respondd request
37# (for receiving only respondd packages e.g. database respondd)
38#send_no_request = false
39# multicast address to destination of respondd
40# (optional - without definition used batman default ff02::2:1001)
41multicast_address = "ff05::2:1001"
42# define a port to listen
43# if not set or set to 0 the kernel will use a random free port at its own
44#port = 10001
45
46# A little build-in webserver, which statically serves a directory.
47# This is useful for testing purposes or for a little standalone installation.
48[webserver]
49enable  = false
50bind    = "127.0.0.1:8080"
51webroot = "/opt/meshviewer/build"
52
53
54[nodes]
55# Cache file
56# a json file to cache all data collected directly from respondd
57state_path    = "/opt/meshviewer/build/data/state.json"
58# prune data in RAM, cache-file and output json files (i.e. nodes.json)
59# that were inactive for longer than
60prune_after   = "7d"
61# Export nodes and graph periodically
62save_interval = "5s"
63# Set node to offline if not seen within this period
64offline_after = "10m"
65
66
67## [[nodes.output.example]]
68# Each output format has its own config block and needs to be enabled by adding:
69#enable = true
70#
71# For each output format there can be set different filters
72#[nodes.output.example.filter]
73#
74# WARNING: if it is not set, it will publish contact information of other persons
75# Set to true, if you did not want the json files to contain the owner information
76#no_owner = true
77#
78# List of nodeids of nodes that should be filtered out, so they won't appear in output
79#blacklist = ["00112233445566", "1337f0badead"]
80#
81# List of site_codes of nodes that should be included in the output
82#sites = ["ffhb"]
83#
84# replace the site_code with the domain_code in this output
85# e.g. site_code='ffhb',domain_code='city' => site_code='city', domain_code=''
86#domain_as_site = true
87#
88# append on the site_code the domain_code with a '.' in this output
89# e.g. site_code='ffhb',domain_code='city' => site_code='ffhb.city', domain_code=''
90#domain_append_site = true
91#
92# set has_location to true if you want to include only nodes that have geo-coordinates set
93# (setting this to false has no sensible effect, unless you'd want to hide nodes that have coordinates)
94#has_location = true
95
96#[nodes.output.example.filter.in_area]
97# nodes outside this area are not shown on the map but are still listed as a node without coordinates
98#latitude_min = 34.30
99#latitude_max = 71.85
100#longitude_min = -24.96
101#longitude_max = 39.72
102
103
104# definition for the new more compressed meshviewer.json
105[[nodes.output.meshviewer-ffrgb]]
106enable   = true
107path = "/opt/meshviewer/build/data/meshviewer.json"
108
109[nodes.output.meshviewer-ffrgb.filter]
110# WARNING: if it is not set, it will publish contact information of other persons
111no_owner = false
112#blacklist = ["00112233445566", "1337f0badead"]
113#sites = ["ffhb"]
114#has_location = true
115
116#[nodes.output.meshviewer-ffrgb.filter.in_area]
117#latitude_min = 34.30
118#latitude_max = 71.85
119#longitude_min = -24.96
120#longitude_max = 39.72
121
122
123# definition for nodes.json
124[[nodes.output.meshviewer]]
125enable = false
126# The structure version of the output which should be generated (i.e. nodes.json)
127# version 1 is accepted by the legacy meshviewer (which is the master branch)
128#   i.e. https://github.com/ffnord/meshviewer/tree/master
129# version 2 is accepted by the new versions of meshviewer (which are in the legacy develop branch or newer)
130#   i.e. https://github.com/ffnord/meshviewer/tree/dev
131#        https://github.com/ffrgb/meshviewer/tree/develop
132version    = 2
133# path where to store nodes.json
134nodes_path = "/opt/meshviewer/build/data/nodes.json"
135# path where to store graph.json
136graph_path = "/opt/meshviewer/build/data/graph.json"
137
138[nodes.output.meshviewer.filter]
139# WARNING: if it is not set, it will publish contact information of other persons
140no_owner = false
141
142
143# definition for nodelist.json
144[[nodes.output.nodelist]]
145enable   = true
146path = "/opt/meshviewer/build/data/nodelist.json"
147
148[nodes.output.nodelist.filter]
149# WARNING: if it is not set, it will publish contact information of other persons
150no_owner = false
151
152
153
154[database]
155# this will send delete commands to the database to prune data
156# which is older than:
157delete_after    = "7d"
158# how often run the cleaning
159delete_interval = "1h"
160
161## [[database.connection.example]]
162# Each database-connection has its own config block and needs to be enabled by adding:
163#enable = true
164
165# Save collected data to InfluxDB.
166# There are the following measurments:
167#   node: store node specific data i.e. clients memory, airtime
168#   global: store global data, i.e. count of clients and nodes
169#   firmware: store the count of nodes tagged with firmware
170#   model: store the count of nodes tagged with hardware model
171[[database.connection.influxdb]]
172enable   = false
173address  = "http://statistics.freifunk-lippe.de:8086"
174database = "fflip"
175username = ""
176password = ""
177
178# Tagging of the data (optional)
179[database.connection.influxdb.tags]
180# Tags used by Yanic would override the tags from this config
181# nodeid, hostname, owner, model, firmware_base, firmware_release,frequency11g and frequency11a are tags which are already used
182#tagname1 = "tagvalue 1"
183# some useful e.g.:
184#system   = "productive"
185#site     = "fflip"
186
187# Graphite settings
188[[database.connection.graphite]]
189enable   = false
190address  = "localhost:2003"
191# Graphite is replacing every "." in the metric name with a slash "/" and uses
192# that for the file system hierarchy it generates. it is recommended to at least
193# move the metrics out of the root namespace (that would be the empty prefix).
194# If you only intend to run one community and only freifunk on your graphite node
195# then the prefix can be set to anything (including the empty string) since you
196# probably wont care much about "polluting" the namespace.
197prefix   = "freifunk"
198
199# respondd (yanic)
200# forward collected respondd package to a address
201# (e.g. to another respondd collector like a central yanic instance or hopglass)
202[[database.connection.respondd]]
203enable   = false
204# type of network to create a connection
205type     = "udp6"
206# destination address to connect/send respondd package
207address  = "stats.bremen.freifunk.net:11001"
208
209# Logging
210[[database.connection.logging]]
211enable   = false
212path     = "/var/log/yanic.log"