docs/site-example: add minimal domain config

This commit is contained in:
kb-light 2017-11-01 12:03:12 +01:00
parent c4e3cca1d3
commit d2aaa5e980
2 changed files with 99 additions and 43 deletions

View File

@ -0,0 +1,96 @@
-- This is a minimal example domain configuration for Gluon v2018.1+
--
-- Take a look at the documentation located at
-- http://gluon.readthedocs.org/ for details.
--
-- This configuration will not work as is. You're required to make
-- community specific changes to it!
{
-- Name of the domain.
domain_names = {
def = 'Default Domain',
-- dom1 = 'Alias Domain',
--- ...
}
-- 32 bytes of random data, encoded in hexacimal
-- Must be the same of all nodes in one mesh domain
-- Can be generated using: echo $(hexdump -v -n 32 -e '1/1 "%02x"' </dev/urandom)
domain_seed = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
-- Prefixes used within the mesh.
-- prefix6 is required, prefix4 can be omitted if next_node.ip4
-- is not set.
prefix4 = '10.xxx.0.0/20',
prefix6 = 'fdxx:xxxx:xxxx::/64',
-- Wireless configuration for 2.4 GHz interfaces.
wifi24 = {
ap = {
-- ESSID used for client network.
ssid = 'alpha-centauri.freifunk.net',
-- disabled = true, -- (optional)
},
mesh = {
-- Adjust these values!
id = 'ueH3uXjdp', -- usually you don't want users to connect to this mesh-SSID, so use a cryptic id that no one will accidentally mistake for the client WiFi
},
},
-- Wireless configuration for 5 GHz interfaces.
-- This should be equal to the 2.4 GHz variant, except
-- for channel.
wifi5 = {
ap = {
ssid = 'alpha-centauri.freifunk.net',
},
mesh = {
-- Adjust these values!
id = 'ueH3uXjdp',
},
},
-- The next node feature allows clients to always reach the node it is
-- connected to using a known IP address.
next_node = {
-- anycast IPs of all nodes
ip4 = '10.xxx.0.xxx',
ip6 = 'fdxx:xxxx:xxxx::xxxx',
},
mesh_vpn = {
fastd = {
groups = {
backbone = {
-- List of peers.
peers = {
peer1 = {
key = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
-- This is a list, so you might add multiple entries.
remotes = {'ipv4 "xxx.somehost.invalid" port xxxxxx'},
},
peer2 = {
key = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
-- You can also omit the ipv4 to allow both connection via ipv4 and ipv6
remotes = {'"xxx.somehost2.invalid" port xxxxx'},
},
},
-- Optional: nested peer groups
-- groups = {
-- backbone_sub = {
-- ...
-- },
-- ...
-- },
},
-- Optional: additional peer groups
-- backbone2 = {
-- ...
-- },
},
},
},
}

View File

@ -1,4 +1,4 @@
-- This is an example site configuration for Gluon v2017.1+
-- This is an example site configuration for Gluon v2018.1+
--
-- Take a look at the documentation located at
-- http://gluon.readthedocs.org/ for details.
@ -15,16 +15,8 @@
-- Shorthand of the community.
site_code = 'ffxx',
-- 32 bytes of random data, encoded in hexadecimal
-- Must be the same for all nodes in one mesh domain
-- Can be generated using: echo $(hexdump -v -n 32 -e '1/1 "%02x"' </dev/urandom)
domain_seed = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
-- Prefixes used within the mesh.
-- prefix6 is required, prefix4 can be omitted if next_node.ip4
-- is not set.
prefix4 = '10.xxx.0.0/20',
prefix6 = 'fdxx:xxxx:xxxx::/64',
-- Shorthand of default domain
default_domain = 'def',
-- Timezone of your community.
-- See http://wiki.openwrt.org/doc/uci/system#time_zones
@ -50,15 +42,11 @@
-- Example removes 802.11b compatibility for better performance
basic_rate = {6000, 9000, 18000, 36000, 54000},
-- ESSID used for client network.
ap = {
ssid = 'alpha-centauri.freifunk.net',
-- disabled = true, -- (optional)
},
mesh = {
-- Adjust these values!
id = 'ueH3uXjdp', -- usually you don't want users to connect to this mesh-SSID, so use a cryptic id that no one will accidentally mistake for the client WiFi
mcast_rate = 12000,
-- disabled = true, -- (optional)
},
@ -69,24 +57,11 @@
-- for channel.
wifi5 = {
channel = 44,
ap = {
ssid = 'alpha-centauri.freifunk.net',
},
mesh = {
-- Adjust these values!
id = 'ueH3uXjdp',
mcast_rate = 12000,
},
},
-- The next node feature allows clients to always reach the node it is
-- connected to using a known IP address.
next_node = {
-- anycast IPs of all nodes
ip4 = '10.xxx.0.xxx',
ip6 = 'fdxx:xxxx:xxxx::xxxx',
},
-- Options specific to routing protocols (optional)
-- mesh = {
-- Options specific to the batman-adv routing protocol (optional)
@ -116,21 +91,6 @@
-- Limit number of connected peers to reduce bandwidth.
limit = 1,
-- List of peers.
peers = {
peer1 = {
key = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
-- This is a list, so you might add multiple entries.
remotes = {'ipv4 "xxx.somehost.invalid" port xxxxxx'},
},
peer2 = {
key = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
-- You can also omit the ipv4 to allow both connection via ipv4 and ipv6
remotes = {'"xxx.somehost2.invalid" port xxxxx'},
},
},
-- Optional: nested peer groups
-- groups = {
-- backbone_sub = {