diff --git a/config_example.toml b/config_example.toml index 53aed31..10fb1c9 100644 --- a/config_example.toml +++ b/config_example.toml @@ -1,3 +1,7 @@ +# This is the config file for Yanic written in "Tom's Obvious, Minimal Language." +# syntax: https://github.com/toml-lang/toml +# (if you need somethink multiple times, checkout out the [[table]] section) + # Send respondd request to update information [respondd] enable = true @@ -34,21 +38,55 @@ save_interval = "5s" offline_after = "10m" -## [[nodes.output.-]] -# every output: -# needs to be enabled just adding: -# enable = true -# could filter the nodes by using a there filter entry (see output meshviewer) -# [nodes.output.-.filter] -# could be used multiple times (suggested by the "[[...]]" instatt of "[...]") -# it is useful for e.g. filter by different array and use multiple meshviewers +## [[nodes.output.example]] +# Each output format has its own config block and needs to be enabled by adding: +#enable = true +# +# For each output format there can be set different filters +#[nodes.output.example.filter] +# +# Set to false, if you want the json files to contain the owner information +#no_owner = true +# +# List of nodeids of nodes that should be filtered out, so they won't appear in output +#blacklist = ["00112233445566", "1337f0badead"] +# +# set has_location to true if you want to include only nodes that have geo-coordinates set +# (setting this to false has no sensible effect, unless you'd want to hide nodes that have coordinates) +#has_location = true +#[nodes.output.example.filter.in_area] +# nodes outside this area are not shown on the map but are still listed as a node without coordinates +#latitude_min = 34.30 +#latitude_max = 71.85 +#longitude_min = -24.96 +#longitude_max = 39.72 + + +# definition for the new more compressed meshviewer.json +[[nodes.output.meshviewer-ffrgb]] +enable = true +path = "/var/www/html/meshviewer/data/meshviewer.json" + +#[nodes.output.meshviewer-ffrgb.filter] +#no_owner = false +#blacklist = ["00112233445566", "1337f0badead"] +#has_location = true + +#[nodes.output.meshviewer-ffrgb.filter.in_area] +#latitude_min = 34.30 +#latitude_max = 71.85 +#longitude_min = -24.96 +#longitude_max = 39.72 + + +# definition for nodes.json [[nodes.output.meshviewer]] -enable = true +enable = false # The structure version of the output which should be generated (i.e. nodes.json) # version 1 is accepted by the legacy meshviewer (which is the master branch) # i.e. https://github.com/ffnord/meshviewer/tree/master -# version 2 is accepted by the new versions of meshviewer (which are in legacy develop branch or newer) +# version 2 is accepted by the new versions of meshviewer (which are in the legacy develop branch or newer) # i.e. https://github.com/ffnord/meshviewer/tree/dev # https://github.com/ffrgb/meshviewer/tree/develop version = 2 @@ -57,25 +95,18 @@ nodes_path = "/var/www/html/meshviewer/data/nodes.json" # path where to store graph.json graph_path = "/var/www/html/meshviewer/data/graph.json" +#[nodes.output.meshviewer.filter] +#no_owner = false -[nodes.output.meshviewer.filter] -# no_owner = true -has_location = true -blacklist = ["vpnid"] - -[nodes.output.meshviewer.filter.in_area] -latitude_min = 34.30 -latitude_max = 71.85 -longitude_min = -24.96 -longitude_max = 39.72 +# definition for nodelist.json [[nodes.output.nodelist]] enable = true path = "/var/www/html/meshviewer/data/nodelist.json" -[[nodes.output.meshviewer-ffrgb]] -enable = true -path = "/var/www/html/meshviewer/data/meshviewer.json" +#[nodes.output.nodelist.filter] +#no_owner = false + [database] @@ -85,12 +116,9 @@ delete_after = "7d" # how often run the cleaning delete_interval = "1h" -## [[database.connection.-]] -# every output: -# needs to be enabled just adding: -# enable = true -# could be used multiple times (suggested by the "[[...]]" instatt of "[...]") -# it is useful for e.g. save into a database before and behind a firewall +## [[database.connection.example]] +# Each database-connection has its own config block and needs to be enabled by adding: +#enable = true # Save collected data to InfluxDB. # There are the following measurments: