From d597a02046ca9b961746b7ceb546a74d7c3444ad Mon Sep 17 00:00:00 2001 From: ruben Date: Fri, 4 Dec 2015 09:51:51 +0100 Subject: [PATCH 1/5] docs: grammar and formatting enhanced in site.conf --- docs/user/site.rst | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/user/site.rst b/docs/user/site.rst index d16b6c3b..a98c6ff3 100644 --- a/docs/user/site.rst +++ b/docs/user/site.rst @@ -95,14 +95,16 @@ wifi24 : optional This will only affect new installations. Upgrades will not changed the disabled state. - ``ap`` requires a single parameter, a string, named ``ssid`` which sets the interface's ESSID. + ``ap`` requires a single parameter, a string, named ``ssid`` which sets the + interface's ESSID. ``mesh`` requires a single parameter, a string, named ``id`` which sets the mesh id. ``ibss`` requires two parametersr: ``ssid`` (a string) and ``bssid`` (a MAC). An optional parameter ``vlan`` (integer) is supported. - Both ``mesh`` and ``ibss`` accept an optional ``mcast_rate`` (kbit/s) parameter for setting the default multicast datarate. + Both ``mesh`` and ``ibss`` accept an optional ``mcast_rate`` (kbit/s) parameter for + setting the default multicast datarate. :: wifi24 = { @@ -156,10 +158,10 @@ fastd_mesh_vpn The `enabled` option can be set to true to enable the VPN by default. - If `configurable` is `false` or unset, the method list will be replaced on updates - with the list in the site configuration. Setting `configurable` to `true` will allow the user to - add the method ``null`` to the front of the method list or remove ``null`` from it, - and make this change survive updates. Settings configurable is necessary for the + If `configurable` is set to `false` or unset, the method list will be replaced on updates + with the list from the site configuration. Setting `configurable` to `true` will allow the user to + add the method ``null`` to the beginning of the method list or remove ``null`` from it, + and make this change survive updates. The settings `configurable` is necessary for the package `gluon-luci-mesh-vpn-fastd`, which adds a UI for this configuration. In any case, the ``null`` method should always be the first method in the list @@ -169,8 +171,8 @@ fastd_mesh_vpn fastd_mesh_vpn = { methods = {'salsa2012+umac'}, - -- enabled = true, - -- configurable = true, + -- enabled = true, + -- configurable = true, mtu = 1280, groups = { backbone = { @@ -225,9 +227,9 @@ autoupdater : package } roles : optional - Optional role definitions. With this nodes will announce their role inside the mesh. - In the backend this adds the facility to distinguish between normal, backbone and - service nodes or even gateways (if they advertise the role, also). It is up to + Optional role definitions. Nodes will announce their role inside the mesh. + This will allow in the backend to distinguish between normal, backbone and + service nodes or even gateways (if they advertise that role). It is up to the community which roles to define. See the section below as an example. ``default`` takes the default role which is set initially. This value should be part of ``list``. If you want node owners to change the role via config mode add @@ -279,7 +281,7 @@ The ``site.mk`` is a Makefile which should define constants involved in the build process of Gluon. GLUON_SITE_PACKAGES - Defines a list of packages which should installed in addition + Defines a list of packages which should be installed additionally to the ``gluon-core`` package. GLUON_RELEASE @@ -290,7 +292,7 @@ GLUON_PRIORITY for more information). GLUON_LANGS - List of languages (as two-letter-codes) to include for the web interface. Should always contain + List of languages (as two-letter-codes) to be included in the web interface. Should always contain ``en``. .. _site-config-mode-texts: From edad24fafebc9200fa6a61a3d3206cbec304ceb0 Mon Sep 17 00:00:00 2001 From: ruben Date: Fri, 4 Dec 2015 10:01:47 +0100 Subject: [PATCH 2/5] docs: enhanced site.conf wording --- docs/user/site.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/user/site.rst b/docs/user/site.rst index a98c6ff3..77cafbd2 100644 --- a/docs/user/site.rst +++ b/docs/user/site.rst @@ -12,7 +12,9 @@ Configuration The ``site.conf`` is a lua dictionary with the following defined keys. hostname_prefix - A string which shall prefix the default hostname of a device. + An optional string which would prefix the generated default hostname of a device. + If you want to force the user to think about a unique name enter an invalid prefix + with spaces like 'Enter a name for your node' site_name The name of your community. @@ -252,7 +254,8 @@ roles : optional setup_mode : package Allows skipping setup mode (config mode) at first boot when attribute - ``skip`` is set to ``true``. This is optional and may be left out. + ``skip`` is set to ``true``. This is optional and may be left out. If set to `true`, + make sure that you enter a valid `hostname_prefix`. :: setup_mode = { From d8a4111ae0a4140532427ca1521c9b05f8b87f1e Mon Sep 17 00:00:00 2001 From: ruben Date: Fri, 4 Dec 2015 10:10:43 +0100 Subject: [PATCH 3/5] docs: enhanced site.conf replaced gerrman entenhausen with english gothamcity --- docs/user/site.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/user/site.rst b/docs/user/site.rst index 77cafbd2..88f17d1a 100644 --- a/docs/user/site.rst +++ b/docs/user/site.rst @@ -112,10 +112,10 @@ wifi24 : optional wifi24 = { channel = 11, ap = { - ssid = 'entenhausen.freifunk.net', + ssid = 'gothamcity.freifunk.net', }, mesh = { - id = 'entenhausen-mesh', + id = 'gothamcity-mesh', mcast_rate = 12000, }, ibss = { @@ -182,7 +182,7 @@ fastd_mesh_vpn peers = { peer1 = { key = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', - remotes = {'ipv4 "vpn1.entenhausen.freifunk.net" port 10000'}, + remotes = {'ipv4 "gw0.gothamcity.freifunk.net" port 10000'}, }, } } From 4245baa74296ee5de21a69047dd47263c7b55988 Mon Sep 17 00:00:00 2001 From: ruben Date: Fri, 4 Dec 2015 10:18:21 +0100 Subject: [PATCH 4/5] docs: enhanced site.conf: example stable and added comments how to use certain config values. Thanks to https://github.com/ffmus/site-ffwaf/blob/master/site.conf --- docs/user/site.rst | 45 ++++++++++++++++++++++++++++++++++++++------- 1 file changed, 38 insertions(+), 7 deletions(-) diff --git a/docs/user/site.rst b/docs/user/site.rst index 88f17d1a..063cd12a 100644 --- a/docs/user/site.rst +++ b/docs/user/site.rst @@ -178,16 +178,34 @@ fastd_mesh_vpn mtu = 1280, groups = { backbone = { + -- Limit number of connected peers to reduce bandwidth. limit = 1, peers = { peer1 = { key = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', - remotes = {'ipv4 "gw0.gothamcity.freifunk.net" port 10000'}, + -- you might add multiple entries. + remotes = { + 'ipv4 "gw0.gothamcity.freifunk.net" port 10000', + 'ipv6 "gw0.gothamcity.freifunk.net" port 10000', + }, }, - } + peer2 = { + key = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', + -- You can also omit the ipv4 to allow both connection via ipv4 and ipv6 + remotes = { + '"gw1.gothamcity.freifunk.net" port 10000', + }, + }, + }, } - }, - + -- Optional: nested peer groups + -- groups = { + -- backbone_sub = { + -- ... + -- }, + -- ... + -- }, + bandwidth_limit = { -- The bandwidth limit can be enabled by default here. enabled = false, @@ -198,6 +216,10 @@ fastd_mesh_vpn -- Default download limit (kbit/s). ingress = 3000, }, + -- Optional: additional peer groups, possibly with other limits + -- backbone2 = { + -- ... + -- }, } mesh_on_wan : optional @@ -211,15 +233,24 @@ autoupdater : package :: autoupdater = { - branch = 'experimental', + branch = 'stable', branches = { stable = { name = 'stable', + + -- List of mirrors to fetch images from. IPv6 required! mirrors = { 'http://[fdca:ffee:babe:1::fec1]/firmware/stable/sysupgrade/', - 'http://[fdca:ffee:babe:1::fec2]/firmware/stable/sysupgrade/', + 'http://services.gothamcity.freifunk.net/firmware/stable/sysupgrade/', }, - good_signatures = 2, + + -- Number of good signatures required. + -- Have multiple maintainers sign your build and only + -- accept it when a sufficient number of them have + -- signed it, for ex. 3 for stable and 1 for experimental + good_signatures = 3, + + -- List of public keys of maintainers. pubkeys = { 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', -- someguy 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', -- someother From 48b597c28aec50aaebd9190d3bab684b0a748b39 Mon Sep 17 00:00:00 2001 From: ruben Date: Fri, 4 Dec 2015 10:20:27 +0100 Subject: [PATCH 5/5] docs: enhanced site.conf better ingress and egress default values --- docs/user/site.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user/site.rst b/docs/user/site.rst index 063cd12a..2168416a 100644 --- a/docs/user/site.rst +++ b/docs/user/site.rst @@ -211,10 +211,10 @@ fastd_mesh_vpn enabled = false, -- Default upload limit (kbit/s). - egress = 200, + egress = 800, -- Default download limit (kbit/s). - ingress = 3000, + ingress = 4000, }, -- Optional: additional peer groups, possibly with other limits -- backbone2 = {