Site

The site consists of the files site.conf and site.mk. In the first community based values are defined, which both are processed during the build process and runtime. The last is directly included in the make process of Gluon.

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.
site_name
The name of your community.
site_code
The code of your community. It is good practice to use the TLD of your community here.
prefix4

The IPv4 Subnet of your community mesh network in CIDR notation, e.g.

prefix4 = '10.111.111.0/18'
prefix6

The IPv6 subnet of your community mesh network, e.g.

prefix6 = 'fdca::ffee:babe:1::/64'
timezone

The timezone of your community live in, e.g.

-- Europe/Berlin
timezone = 'CET-1CEST,M3.5.0,M10.5.0/3'
ntp_server

List of NTP servers available in your community or used by your community, e.g.:

ntp_servers = {'1.ntp.services.ffeh','2.tnp.services.ffeh'}
opkg_repo : optional

Overwrite the default opkg repository server, e.g.:

opkg_repo = 'http://opkg.services.ffeh/attitude_adjustment/12.09/%S/packages'

The %S is a variable, which is replaced with the platform of an device during the build process.

regdom

The wireless regulatory domain responsible for your area, e.g.:

regdom = 'DE'
wifi24

WLAN Configuration of your community in the 2.4Ghz radio. Consisting of ssid of your client network, the channel your community is using, htmode, the adhoc ssid mesh_ssid used between devices, the adhoc bssid mesh_bssid and the adhoc multicast rate mesh_mcast_rate. Combined in an dictionary, e.g.:

wifi24 = {
  ssid = 'http://kiel.freifunk.net/',
  channel = 11,
  htmode = 'HT40-',
  mesh_ssid = 'ff:ff:ff:ee:ba:be',
  mesh_bssid = 'ff:ff:ff:ee:ba:be',
  mesh_mcast_rate = 12000,
},
wifi5
Same as wifi24 but for the 5Ghz radio.
next_node : package

Configuration of the local node feature of Gluon

next_node = {
  ip4 = '10.23.42.1',
  ip6 = 'fdca:ffee:babe:1::1',
  mac = 'ca:ff:ee:ba:be'
}
fastd_mesh_vpn

Remote server setup for vpn.

fastd_mesh_vpn = {
  methods = {'salsa2012+gmac'},
  mtu = 1426,
  backbone = {
    limit = 2,
    peers = {
      ffki_rz = {
        key = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
        remotes = {'ipv4 "vpn1.entenhausen.freifunk.net" port 10000'},
      },
    }
  }
}
mesh_on_wan : optional
Enables the mesh on the WAN port (true or false).
autoupdater : package

Configuration for the autoupdater feature of Gluon.

autoupdater = {
  enabled = 1,
  branch = 'experimental',
  branches = {
    stable = {
      name = 'stable',
      mirrors = {
        'http://{fdca:ffee:babe:1::fec1}/firmware/stable/sysupgrade/',
        'http://{fdca:ffee:babe:1::fec2}/firmware/stable/sysupgrade/',
      },
      probability = 0.08,
      good_signatures = 2,
      pubkeys = {
        'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', -- someguy
        'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', -- someother
      }
    }
  }
}
simple_tc : package

Uplink traffic control

simple_tc = {
  mesh_vpn = {
    ifname = 'mesh-vpn',
    enabled = false,
    limit_egress = 200,
    limit_ingress = 3000,
  },
},
config_mode : package
Configuration Mode text blocks
legacy : package

Configuration for the legacy upgrade path. This is only required in communities upgrading from Lübeck’s LFF-0.3.x.

legacy = {
       version_files = {'/etc/.freifunk_version_keep', '/etc/.eff_version_keep'},
       old_files = {'/etc/config/config_mode', '/etc/config/ffeh', '/etc/config/freifunk'},
       config_mode_configs = {'config_mode', 'ffeh', 'freifunk'},
       fastd_configs = {'ffeh_mesh_vpn', 'mesh_vpn'},
       mesh_ifname = 'freifunk',
       tc_configs = {'ffki', 'freifunk'},
       wifi_names = {'wifi_freifunk', 'wifi_freifunk5', 'wifi_mesh', 'wifi_mesh5'},
}

Packages

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 additional to the gluon_core package.
GLUON_RELEASE
The current release version Gluon should use.
GLUON_PRIORITY
The default priority for the generated manifests (see the autoupdater documentation for more information).

Examples

site.mk

##	gluon site.mk makefile example

##	GLUON_SITE_PACKAGES
#		specify gluon/openwrt packages to include here
#		The gluon-mesh-batman-adv-* package must come first because of the dependency resolution

GLUON_SITE_PACKAGES := \
	gluon-mesh-batman-adv-14 \
	gluon-alfred \
	gluon-announced \
	gluon-autoupdater \
	gluon-config-mode-hostname \
	gluon-config-mode-autoupdater \
	gluon-config-mode-mesh-vpn \
	gluon-config-mode-geo-location \
	gluon-config-mode-contact-info \
	gluon-ebtables-filter-multicast \
	gluon-ebtables-filter-ra-dhcp \
	gluon-luci-admin \
	gluon-luci-autoupdater \
	gluon-luci-portconfig \
	gluon-next-node \
	gluon-mesh-vpn-fastd \
	gluon-radvd \
	gluon-status-page \
	iwinfo \
	iptables \
	haveged

##	DEFAULT_GLUON_RELEASE
#		version string to use for images
#		gluon relies on
#			opkg compare-versions "$1" '>>' "$2"
#		to decide if a version is newer or not.

DEFAULT_GLUON_RELEASE := 0.4+0-exp$(shell date '+%Y%m%d')


##	GLUON_RELEASE
#		call make with custom GLUON_RELEASE flag, to use your own release version scheme.
#		e.g.:
#			$ make images GLUON_RELEASE=23.42+5
#		would generate images named like this:
#			gluon-ff%site_code%-23.42+5-%router_model%.bin

# Allow overriding the release number from the command line
GLUON_RELEASE ?= $(DEFAULT_GLUON_RELEASE)

# Default priority for updates.
GLUON_PRIORITY ?= 0

site.conf

-- This is an example site configuration for Gluon v2014.4
--
-- Take a look at the documentation located at
-- http://gluon.readthedocs.org/ for details.
--
-- This configuration will not work as it. You're required to make
-- community specific changes to it!
{
  -- Used for generated hostnames, e.g. freifunk-abcdef123456.
  hostname_prefix = 'freifunk',

  -- Name of the community.
  site_name = 'Freifunk Lübeck',

  -- Shorthand of the community.
  site_code = 'ffhl',

  -- Prefixes used within the mesh. Both are required.
  prefix4 = '10.130.0.0/20',
  prefix6 = 'fdef:ffc0:3dd7::/64',

  -- Timezone of your community.
  -- See http://wiki.openwrt.org/doc/uci/system#time_zones
  timezone = 'CET-1CEST,M3.5.0,M10.5.0/3',

  -- List of NTP servers in your community.
  -- Must be reachable using IPv6!
  ntp_servers = {'1.ntp.services.ffhl'},

  -- Wireless regulatory domain of your community.
  regdom = 'DE',

  -- Wireless configuratoin for 2.4 GHz interfaces.
  wifi24 = {
    -- Wireless channel.
    channel = 1,

    -- ESSID used for client network.
    ssid = 'luebeck.freifunk.net',

    -- Specifies the channel width in 802.11n and 802.11ac mode.
    -- Possible values are:
    -- HT20 (single 20MHz channel),
    -- HT40- (2x 20MHz channels, secondary below)
    -- HT40+ (2x 20MHz channels, secondary above)
    htmode = 'HT20',

    -- Adjust these values!
    mesh_ssid = 'XX:XX:XX:XX:XX:XX',  -- ESSID used for mesh
    mesh_bssid = 'XX:XX:XX:XX:XX:XX', -- BSSID used for mesh

    -- Bitrate used for multicast/broadcast packets.
    mesh_mcast_rate = 12000,
  },

  -- Wireless configuration for 5 GHz interfaces.
  -- This should be equal to the 2.4 GHz variant, except
  -- for channel and htmode.
  wifi5 = {
    ssid = 'luebeck.freifunk.net',
    channel = 44,
    htmode = 'HT20',
    mesh_ssid = 'XX:XX:XX:XX:XX:XX',
    mesh_bssid = 'XX:XX:XX:XX:XX:XX',
    mesh_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.130.0.1',
    ip6 = 'fdef:ffc0:3dd7::1',

    -- anycast MAC of all nodes
    mac = '16:41:95:40:f7:dc',
  },

  -- Refer to http://fastd.readthedocs.org/en/latest/ to better understand
  -- what these options do.
  fastd_mesh_vpn = {
    -- List of crypto-methods to use.
    methods = {'salsa2012+gmac'},
    mtu = 1426,
    backbone = {
      -- Limit number of connected peers to reduce bandwidth.
      limit = 2,

      -- List of peers.
      peers = {
        burgtor = {
          key = '657af03e36ff1b8bbe5a5134982a4f110c8523a9a63293870caf548916a95a03',

          -- This is a list, so you might add multiple entries.
          remotes = {'ipv4 "burgtor.mesh.ffhl.chaotikum.org" port 10000'},
        },
        holstentor = {
          key = '8c660f7511bf101ea1b599fe53af20e1146cd923c9e9d2a3a0d534ee75af9067',
          remotes = {'ipv4 "holstentor.mesh.ffhl.chaotikum.org" port 10000'},
        },
      },
    },
  },

  autoupdater = {
    -- Default branch. Don't forget to set GLUON_BRANCH when building!
    branch = 'stable',

    -- List of branches. You may define multiple branches.
    branches = {
      stable = {
        name = 'stable',

        -- List of mirrors to fetch images from. IPv6 required!
        mirrors = {'http://1.updates.services.ffhl/stable/sysupgrade'},

        -- Number of good signatures required.
        -- Have multiple maintainers sign your build and only
        -- accept it when a sufficient number of them have
        -- signed it.
        good_signatures = 2,

        -- List of public keys of maintainers.
        pubkeys = {
                'daa19b44bbd7033965e02088127bad9516ba0fea8f34267a777144a23ec8900c', -- Linus
                'a8dd60765b07330a4bbfdf8406102befca132881a4b65f3efda32cf2d5b362d9', -- Nils
                '323bd3285c4e5547a89cd6da1f2aef67f1654b0928bbd5b104efc9dab2156d0b', -- NeoRaider
        },
      },
    },
  },

  -- Bandwidth limiting
  simple_tc = {
    mesh_vpn = {
      ifname = 'mesh-vpn',

      -- You may enable it by default here.
      enabled = false,

      -- Default upload limit (kbit/s).
      limit_egress = 200,

      -- Default download limit (kbit/s).
      limit_ingress = 3000,
    },
  },

  -- These strings are shown in config mode. Some HTML is permissible.
  --
  -- msg_welcome: shown at startup
  -- msg_pubkey:  shown when VPN is enabled
  -- msg_reboot:  shown during reboot (after finishing configuration)
  --
  -- You may use some variables, e.g.:
  --
  -- <%=hostname%>               - the node's hostname
  -- <%=pubkey%>                - the fastd public key
  -- <%=sysconfig.primary_mac%> - the node's primary MAC
  config_mode = {
    msg_welcome = [[
Willkommen zum Einrichtungsassistenten für deinen neuen Lübecker
Freifunk-Knoten. Fülle das folgende Formular deinen Vorstellungen
entsprechend aus und sende es ab.
]],
    msg_pubkey = [[
Dies ist der öffentliche Schlüssel deines Freifunk-Knotens. Erst nachdem
er auf den Servern des Lübecker Freifunk-Projektes eingetragen wurde,
kann sich dein Knoten mit dem Lübecker Mesh-VPN zu verbinden. Bitte
schicke dazu diesen Schlüssel und den Namen deines Knotens
(<em><%=hostname%></em>) an
<a href="mailto:keys@luebeck.freifunk.net">keys@luebeck.freifunk.net</a>.
]],
    msg_reboot = [[
<p>
Dein Knoten startet gerade neu und wird anschließend versuchen,
sich anschließend mit anderen Freifunk-Knoten in seiner Nähe zu
verbinden. Weitere Informationen zur
Lübecker Freifunk-Community findest du auf
<a href="https://luebeck.freifunk.net/">unserer Webseite</a>.
</p>
<p>
Viel Spaß mit deinem Knoten und der Erkundung von Freifunk!
</p>
]],
  },
}

modules

# This file allows specifying additional repositories to use
# when building gluon.
#
# In most cases, it is not required so don't add it.

##	GLUON_SITE_FEEDS
#		for each feed name given, add the corresponding PACKAGES_* lines
#		documented below
#GLUON_SITE_FEEDS='my_own_packages'

##	PACKAGES_$feedname_REPO
#		the  git repository from where to clone the package feed
#PACKAGES_MY_OWN_PACKAGES_REPO=https://github.com/.../my-own-packages.git


##	PACKAGES_$feedname_COMMIT
#		the version/commit of the git repository to clone
#PACKAGES_MY_OWN_PACKAGES_COMMIT=123456789aabcda1a69b04278e4d38f2a3f57e49

##  PACKAGES_$feedname_BRANCH
#   the branch to check out
#PACKAGES_MY_OWN_PACKAGES_BRANCH=my_branch

site-repos in the wild

This is a non-exhaustive list of site-repos from various communities: