site.rst 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384
  1. Site configuration
  2. ==================
  3. The ``site`` consists of the files ``site.conf`` and ``site.mk``.
  4. In the first community based values are defined, which both are processed
  5. during the build process and runtime.
  6. The last is directly included in the make process of Gluon.
  7. Configuration
  8. -------------
  9. The ``site.conf`` is a lua dictionary with the following defined keys.
  10. hostname_prefix
  11. A string which shall prefix the default hostname of a device.
  12. site_name
  13. The name of your community.
  14. site_code
  15. The code of your community. It is good practice to use the TLD of
  16. your community here.
  17. prefix4
  18. The IPv4 Subnet of your community mesh network in CIDR notation, e.g.
  19. ::
  20. prefix4 = '10.111.111.0/18'
  21. prefix6
  22. The IPv6 subnet of your community mesh network, e.g.
  23. ::
  24. prefix6 = 'fdca::ffee:babe:1::/64'
  25. timezone
  26. The timezone of your community live in, e.g.
  27. ::
  28. -- Europe/Berlin
  29. timezone = 'CET-1CEST,M3.5.0,M10.5.0/3'
  30. ntp_server
  31. List of NTP servers available in your community or used by your community, e.g.:
  32. ::
  33. ntp_servers = {'1.ntp.services.ffeh','2.tnp.services.ffeh'}
  34. opkg : optional
  35. ``opkg`` package manager configuration.
  36. There are two optional fields in the ``opkg`` section:
  37. - ``openwrt`` overrides the default OpenWrt repository URL
  38. - ``extra`` specifies a table of additional repositories (with arbitrary keys)
  39. ::
  40. opkg = {
  41. openwrt = 'http://opkg.services.ffeh/openwrt/%n/%v/%S/packages',
  42. extra = {
  43. modules = 'http://opkg.services.ffeh/modules/gluon-%GS-%GR/%S',
  44. },
  45. }
  46. There are various patterns which can be used in the URLs:
  47. - ``%n`` is replaced by the OpenWrt version codename (e.g. "chaos_calmer")
  48. - ``%v`` is replaced by the OpenWrt version number (e.g. "15.05")
  49. - ``%S`` is replaced by the target architecture (e.g. "ar71xx/generic")
  50. - ``%GS`` is replaced by the Gluon site code (as specified in ``site.conf``)
  51. - ``%GV`` is replaced by the Gluon version
  52. - ``%GR`` is replaced by the Gluon release (as specified in ``site.mk``)
  53. regdom : optional
  54. The wireless regulatory domain responsible for your area, e.g.:
  55. ::
  56. regdom = 'DE'
  57. Setting ``regdom`` in mandatory if ``wifi24`` or ``wifi5`` is defined.
  58. wifi24 : optional
  59. WLAN configuration for 2.4 GHz devices.
  60. ``channel`` must be set to a valid wireless channel for your radio.
  61. There are currently three interface types available. You many choose to
  62. configure any subset of them:
  63. - ``ap`` creates a master interface where clients may connect
  64. - ``mesh`` creates an 802.11s mesh interface with forwarding disabled
  65. - ``ibss`` creates an ad-hoc interface
  66. Each interface may be disabled by setting ``disabled`` to ``true``.
  67. This will only affect new installations.
  68. Upgrades will not changed the disabled state.
  69. ``ap`` requires a single parameter, a string, named ``ssid`` which sets the interface's ESSID.
  70. ``mesh`` requires a single parameter, a string, named ``id`` which sets the mesh id.
  71. ``ibss`` requires two parametersr: ``ssid`` (a string) and ``bssid`` (a MAC).
  72. An optional parameter ``vlan`` (integer) is supported.
  73. Both ``mesh`` and ``ibss`` accept an optional ``mcast_rate`` (kbit/s) parameter for setting the default multicast datarate.
  74. ::
  75. wifi24 = {
  76. channel = 11,
  77. ap = {
  78. ssid = 'entenhausen.freifunk.net',
  79. },
  80. mesh = {
  81. id = 'entenhausen-mesh',
  82. mcast_rate = 12000,
  83. },
  84. ibss = {
  85. ssid = 'ff:ff:ff:ee:ba:be',
  86. bssid = 'ff:ff:ff:ee:ba:be',
  87. mcast_rate = 12000,
  88. },
  89. },
  90. wifi5 : optional
  91. Same as `wifi24` but for the 5Ghz radio.
  92. next_node : package
  93. Configuration of the local node feature of Gluon
  94. ::
  95. next_node = {
  96. ip4 = '10.23.42.1',
  97. ip6 = 'fdca:ffee:babe:1::1',
  98. mac = 'ca:ff:ee:ba:be:00'
  99. }
  100. mesh : optional
  101. Options specific to routing protocols.
  102. At the moment, only the ``batman_adv`` routing protocol has such options:
  103. The optional value ``gw_sel_class`` sets the gateway selection class. The default
  104. class 20 is based on the link quality (TQ) only, class 1 is calculated from
  105. both the TQ and the announced bandwidth.
  106. ::
  107. mesh = {
  108. batman_adv = {
  109. gw_sel_class = 1,
  110. },
  111. }
  112. fastd_mesh_vpn
  113. Remote server setup for the fastd-based mesh VPN.
  114. The `enabled` option can be set to true to enable the VPN by default.
  115. If `configurable` is `false` or unset, the method list will be replaced on updates
  116. with the list in the site configuration. Setting `configurable` to `true` will allow the user to
  117. add the method ``null`` to the front of the method list or remove ``null`` from it,
  118. and make this change survive updates. Settings configurable is necessary for the
  119. package `gluon-luci-mesh-vpn-fastd`, which adds a UI for this configuration.
  120. In any case, the ``null`` method should always be the first method in the list
  121. if it is supported at all. You should only set `configurable` to `true` if the
  122. configured peers support both the ``null`` method and methods with encryption.
  123. ::
  124. fastd_mesh_vpn = {
  125. methods = {'salsa2012+umac'},
  126. -- enabled = true,
  127. -- configurable = true,
  128. mtu = 1280,
  129. groups = {
  130. backbone = {
  131. limit = 1,
  132. peers = {
  133. peer1 = {
  134. key = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
  135. remotes = {'ipv4 "vpn1.entenhausen.freifunk.net" port 10000'},
  136. },
  137. }
  138. }
  139. },
  140. bandwidth_limit = {
  141. -- The bandwidth limit can be enabled by default here.
  142. enabled = false,
  143. -- Default upload limit (kbit/s).
  144. egress = 200,
  145. -- Default download limit (kbit/s).
  146. ingress = 3000,
  147. },
  148. }
  149. mesh_on_wan : optional
  150. Enables the mesh on the WAN port (``true`` or ``false``).
  151. mesh_on_lan : optional
  152. Enables the mesh on the LAN port (``true`` or ``false``).
  153. autoupdater : package
  154. Configuration for the autoupdater feature of Gluon.
  155. ::
  156. autoupdater = {
  157. branch = 'experimental',
  158. branches = {
  159. stable = {
  160. name = 'stable',
  161. mirrors = {
  162. 'http://[fdca:ffee:babe:1::fec1]/firmware/stable/sysupgrade/',
  163. 'http://[fdca:ffee:babe:1::fec2]/firmware/stable/sysupgrade/',
  164. },
  165. good_signatures = 2,
  166. pubkeys = {
  167. 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', -- someguy
  168. 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', -- someother
  169. }
  170. }
  171. }
  172. }
  173. roles : optional
  174. Optional role definitions. With this nodes will announce their role inside the mesh.
  175. In the backend this adds the facility to distinguish between normal, backbone and
  176. service nodes or even gateways (if they advertise the role, also). It is up to
  177. the community which roles to define. See the section below as an example.
  178. ``default`` takes the default role which is set initially. This value should be
  179. part of ``list``. If you want node owners to change the role via config mode add
  180. the package ``gluon-luci-node-role`` to ``site.mk``.
  181. The strings to display in the LuCI interface can be configured per language in the
  182. ``i18n/en.po``, ``i18n/de.po``, etc. files of the site repository using message IDs like
  183. ``gluon-luci-node-role:role:node`` and ``gluon-luci-node-role:role:backbone``.
  184. ::
  185. roles = {
  186. default = 'node',
  187. list = {
  188. 'node',
  189. 'test',
  190. 'backbone',
  191. 'service',
  192. },
  193. },
  194. setup_mode : package
  195. Allows skipping setup mode (config mode) at first boot when attribute
  196. ``skip`` is set to ``true``. This is optional and may be left out.
  197. ::
  198. setup_mode = {
  199. skip = true,
  200. },
  201. legacy : package
  202. Configuration for the legacy upgrade path.
  203. This is only required in communities upgrading from Lübeck's LFF-0.3.x.
  204. ::
  205. legacy = {
  206. version_files = {'/etc/.freifunk_version_keep', '/etc/.eff_version_keep'},
  207. old_files = {'/etc/config/config_mode', '/etc/config/ffeh', '/etc/config/freifunk'},
  208. config_mode_configs = {'config_mode', 'ffeh', 'freifunk'},
  209. fastd_configs = {'ffeh_mesh_vpn', 'mesh_vpn'},
  210. mesh_ifname = 'freifunk',
  211. tc_configs = {'ffki', 'freifunk'},
  212. wifi_names = {'wifi_freifunk', 'wifi_freifunk5', 'wifi_mesh', 'wifi_mesh5'},
  213. }
  214. Packages
  215. --------
  216. The ``site.mk`` is a Makefile which should define constants
  217. involved in the build process of Gluon.
  218. GLUON_SITE_PACKAGES
  219. Defines a list of packages which should installed in addition
  220. to the ``gluon-core`` package.
  221. GLUON_RELEASE
  222. The current release version Gluon should use.
  223. GLUON_PRIORITY
  224. The default priority for the generated manifests (see the autoupdater documentation
  225. for more information).
  226. GLUON_LANGS
  227. List of languages (as two-letter-codes) to include for the web interface. Should always contain
  228. ``en``.
  229. .. _site-config-mode-texts:
  230. Config mode texts
  231. -----------------
  232. The community-defined texts in the config mode are configured in PO files in the ``i18n`` subdirectory
  233. of the site configuration. The message IDs currently defined are:
  234. gluon-config-mode:welcome
  235. Welcome text on the top of the config wizard page.
  236. gluon-config-mode:pubkey
  237. Information about the public VPN key on the reboot page.
  238. gluon-config-mode:reboot
  239. General information shown on the reboot page.
  240. There is a POT file in the site example directory which can be used to create templates
  241. for the language files. The command ``msginit -l en -i ../../docs/site-example/i18n/gluon-site.pot``
  242. can be used from the ``i18n`` directory to create an initial PO file called ``en.po`` if the ``gettext``
  243. utilities are installed.
  244. .. note::
  245. An empty ``msgstr``, as is the default after running ``msginit``, leads to
  246. the ``msgid`` being printed as-is. It does *not* hide the whole text, as
  247. might be expected.
  248. Depending on the context, you might be able to use comments like
  249. ``<!-- empty -->`` as translations to effectively hide the text.
  250. Examples
  251. --------
  252. site.mk
  253. ^^^^^^^
  254. .. literalinclude:: ../site-example/site.mk
  255. :language: makefile
  256. site.conf
  257. ^^^^^^^^^
  258. .. literalinclude:: ../site-example/site.conf
  259. :language: lua
  260. i18n/en.po
  261. ^^^^^^^^^^
  262. .. literalinclude:: ../site-example/i18n/en.po
  263. :language: po
  264. i18n/de.po
  265. ^^^^^^^^^^
  266. .. literalinclude:: ../site-example/i18n/de.po
  267. :language: po
  268. modules
  269. ^^^^^^^
  270. .. literalinclude:: ../site-example/modules
  271. :language: makefile
  272. site-repos in the wild
  273. ^^^^^^^^^^^^^^^^^^^^^^
  274. This is a non-exhaustive list of site-repos from various communities:
  275. * `site-ffa <https://github.com/tecff/site-ffa>`_ (Altdorf, Landshut & Umgebung)
  276. * `site-ffbs <https://github.com/ffbs/site-ffbs>`_ (Braunschweig)
  277. * `site-ffhb <https://github.com/FreifunkBremen/gluon-site-ffhb>`_ (Bremen)
  278. * `site-ffda <https://github.com/freifunk-darmstadt/site-ffda>`_ (Darmstadt)
  279. * `site-ffgoe <https://github.com/freifunk-goettingen/site-ffgoe>`_ (Göttingen)
  280. * `site-ffhh <https://github.com/freifunkhamburg/site-ffhh>`_ (Hamburg)
  281. * `site-ffhgw <https://github.com/lorenzo-greifswald/site-ffhgw>`_ (Greifswald)
  282. * `site-ffhl <https://github.com/freifunk-luebeck/site-ffhl>`_ (Lübeck)
  283. * `site-ffmd <https://github.com/FreifunkMD/site-ffmd>`_ (Magdeburg)
  284. * `site-ffmwu <https://github.com/freifunk-mwu/site-ffmwu>`_ (Mainz, Wiesbaden & Umgebung)
  285. * `site-ffmyk <https://github.com/FreifunkMYK/site-ffmyk>`_ (Mayen-Koblenz)
  286. * `site-ffm <https://github.com/freifunkMUC/site-ffm>`_ (München)
  287. * `site-ffms <https://github.com/FreiFunkMuenster/site-ffms>`_ (Münsterland)
  288. * `site-ffnw <https://git.nordwest.freifunk.net/ffnw/siteconf/tree/master>`_ (Nordwest)
  289. * `site-ffpb <https://git.c3pb.de/freifunk-pb/site-ffpb>`_ (Paderborn)
  290. * `site-ffka <https://github.com/ffka/site-ffka>`_ (Karlsruhe)
  291. * `site-ffrl <https://github.com/ffrl/sites-ffrl>`_ (Rheinland)
  292. * `site-ffrg <https://github.com/ffruhr/site-ffruhr>`_ (Ruhrgebiet)
  293. * `site-ffs <https://github.com/freifunk-stuttgart/site-ffs>`_ (Stuttgart)
  294. * `site-fftr <https://github.com/freifunktrier/site-fftr>`_ (Trier)