site.rst 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496
  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 \: optional
  18. The IPv4 Subnet of your community mesh network in CIDR notation, e.g.
  19. ::
  20. prefix4 = '10.111.111.0/18'
  21. Required if ``next_node.ip4`` is set.
  22. prefix6
  23. The IPv6 subnet of your community mesh network, e.g.
  24. ::
  25. prefix6 = 'fdca::ffee:babe:1::/64'
  26. timezone
  27. The timezone of your community live in, e.g.
  28. ::
  29. -- Europe/Berlin
  30. timezone = 'CET-1CEST,M3.5.0,M10.5.0/3'
  31. ntp_server
  32. List of NTP servers available in your community or used by your community, e.g.:
  33. ::
  34. ntp_servers = {'1.ntp.services.ffac','2.ntp.services.ffac'}
  35. This NTP servers must be reachable via IPv6 from the nodes. If you don't want to set an IPv6 address
  36. explicitly, but use a hostname (which is recommended), see also the :ref:`FAQ <faq-dns>`.
  37. opkg \: optional
  38. ``opkg`` package manager configuration.
  39. There are two optional fields in the ``opkg`` section:
  40. - ``openwrt`` overrides the default OpenWrt repository URL
  41. - ``extra`` specifies a table of additional repositories (with arbitrary keys)
  42. ::
  43. opkg = {
  44. openwrt = 'http://opkg.services.ffac/openwrt/%n/%v/%S/packages',
  45. extra = {
  46. modules = 'http://opkg.services.ffac/modules/gluon-%GS-%GR/%S',
  47. },
  48. }
  49. There are various patterns which can be used in the URLs:
  50. - ``%n`` is replaced by the OpenWrt version codename (e.g. "chaos_calmer")
  51. - ``%v`` is replaced by the OpenWrt version number (e.g. "15.05")
  52. - ``%S`` is replaced by the target architecture (e.g. "ar71xx/generic")
  53. - ``%GS`` is replaced by the Gluon site code (as specified in ``site.conf``)
  54. - ``%GV`` is replaced by the Gluon version
  55. - ``%GR`` is replaced by the Gluon release (as specified in ``site.mk``)
  56. regdom \: optional
  57. The wireless regulatory domain responsible for your area, e.g.:
  58. ::
  59. regdom = 'DE'
  60. Setting ``regdom`` is mandatory if ``wifi24`` or ``wifi5`` is defined.
  61. wifi24 \: optional
  62. WLAN configuration for 2.4 GHz devices.
  63. ``channel`` must be set to a valid wireless channel for your radio.
  64. There are currently three interface types available. You many choose to
  65. configure any subset of them:
  66. - ``ap`` creates a master interface where clients may connect
  67. - ``mesh`` creates an 802.11s mesh interface with forwarding disabled
  68. - ``ibss`` creates an ad-hoc interface
  69. Each interface may be disabled by setting ``disabled`` to ``true``.
  70. This will only affect new installations.
  71. Upgrades will not change the disabled state.
  72. Additionally it is possible to configure the ``supported_rates`` and ``basic_rate``
  73. of each radio. Both are optional, by default hostapd/driver dictate the rates.
  74. If ``supported_rates`` is set, ``basic_rate`` is required, because ``basic_rate``
  75. has to be a subset of ``supported_rates``.
  76. The example below disables 802.11b rates.
  77. ``ap`` requires a single parameter, a string, named ``ssid`` which sets the
  78. interface's ESSID.
  79. ``mesh`` requires a single parameter, a string, named ``id`` which sets the mesh id.
  80. ``ibss`` requires two parametersr: ``ssid`` (a string) and ``bssid`` (a MAC).
  81. An optional parameter ``vlan`` (integer) is supported.
  82. Both ``mesh`` and ``ibss`` accept an optional ``mcast_rate`` (kbit/s) parameter for
  83. setting the multicast bitrate. Increasing the default value of 1000 to something
  84. like 12000 is recommended.
  85. ::
  86. wifi24 = {
  87. channel = 11,
  88. supported_rates = {6000, 9000, 12000, 18000, 24000, 36000, 48000, 54000},
  89. basic_rate = {6000, 9000, 18000, 36000, 54000},
  90. ap = {
  91. ssid = 'alpha-centauri.freifunk.net',
  92. },
  93. mesh = {
  94. id = 'alpha-centauri-mesh',
  95. mcast_rate = 12000,
  96. },
  97. ibss = {
  98. ssid = 'ff:ff:ff:ee:ba:be',
  99. bssid = 'ff:ff:ff:ee:ba:be',
  100. mcast_rate = 12000,
  101. },
  102. },
  103. wifi5 \: optional
  104. Same as `wifi24` but for the 5Ghz radio.
  105. next_node \: package
  106. Configuration of the local node feature of Gluon
  107. ::
  108. next_node = {
  109. ip4 = '10.23.42.1',
  110. ip6 = 'fdca:ffee:babe:1::1',
  111. mac = 'ca:ff:ee:ba:be:00'
  112. }
  113. The IPv4 next-node address is optional.
  114. mesh \: optional
  115. Options specific to routing protocols.
  116. At the moment, only the ``batman_adv`` routing protocol has such options:
  117. The optional value ``gw_sel_class`` sets the gateway selection class. The default
  118. class 20 is based on the link quality (TQ) only, class 1 is calculated from
  119. both the TQ and the announced bandwidth.
  120. ::
  121. mesh = {
  122. batman_adv = {
  123. gw_sel_class = 1,
  124. },
  125. }
  126. fastd_mesh_vpn
  127. Remote server setup for the fastd-based mesh VPN.
  128. The `enabled` option can be set to true to enable the VPN by default.
  129. If `configurable` is set to `false` or unset, the method list will be replaced on updates
  130. with the list from the site configuration. Setting `configurable` to `true` will allow the user to
  131. add the method ``null`` to the beginning of the method list or remove ``null`` from it,
  132. and make this change survive updates. Setting `configurable` is necessary for the
  133. package `gluon-luci-mesh-vpn-fastd`, which adds a UI for this configuration.
  134. In any case, the ``null`` method should always be the first method in the list
  135. if it is supported at all. You should only set `configurable` to `true` if the
  136. configured peers support both the ``null`` method and methods with encryption.
  137. You can set syslog_level from verbose (default) to warn to reduce syslog output.
  138. ::
  139. fastd_mesh_vpn = {
  140. methods = {'salsa2012+umac'},
  141. -- enabled = true,
  142. -- configurable = true,
  143. -- syslog_level = 'warn',
  144. mtu = 1280,
  145. groups = {
  146. backbone = {
  147. -- Limit number of connected peers from this group
  148. limit = 1,
  149. peers = {
  150. peer1 = {
  151. key = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
  152. -- Having multiple domains prevents SPOF in freifunk.net
  153. remotes = {
  154. 'ipv4 "vpn1.alpha-centauri.freifunk.net" port 10000',
  155. 'ipv4 "vpn1.alpha-centauri-freifunk.de" port 10000',
  156. },
  157. },
  158. peer2 = {
  159. key = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
  160. -- You can also omit the ipv4 to allow both connection via ipv4 and ipv6
  161. remotes = {'"vpn2.alpha-centauri.freifunk.net" port 10000'},
  162. },
  163. },
  164. -- Optional: nested peer groups
  165. -- groups = {
  166. -- lowend_backbone = {
  167. -- limit = 1,
  168. -- peers = ...
  169. -- },
  170. -- },
  171. },
  172. -- Optional: additional peer groups, possibly with other limits
  173. -- peertopeer = {
  174. -- limit = 10,
  175. -- peers = { ... },
  176. -- },
  177. },
  178. bandwidth_limit = {
  179. -- The bandwidth limit can be enabled by default here.
  180. enabled = false,
  181. -- Default upload limit (kbit/s).
  182. egress = 200,
  183. -- Default download limit (kbit/s).
  184. ingress = 3000,
  185. },
  186. }
  187. mesh_on_wan \: optional
  188. Enables the mesh on the WAN port (``true`` or ``false``).
  189. mesh_on_lan \: optional
  190. Enables the mesh on the LAN port (``true`` or ``false``).
  191. poe_passthrough \: optional
  192. Enable PoE passthrough by default on hardware with such a feature.
  193. autoupdater \: package
  194. Configuration for the autoupdater feature of Gluon.
  195. The mirrors are checked in random order until the manifest could be downloaded
  196. successfully or all mirrors have been tried.
  197. ::
  198. autoupdater = {
  199. branch = 'stable',
  200. branches = {
  201. stable = {
  202. name = 'stable',
  203. mirrors = {
  204. 'http://[fdca:ffee:babe:1::fec1]/firmware/stable/sysupgrade/',
  205. 'http://autoupdate.alpha-centauri.freifunk.net/firmware/stable/sysupgrade/',
  206. },
  207. -- Number of good signatures required
  208. good_signatures = 2,
  209. pubkeys = {
  210. 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', -- someguy
  211. 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', -- someother
  212. }
  213. }
  214. }
  215. }
  216. All configured mirrors must be reachable from the nodes via IPv6. If you don't want to set an IPv6 address
  217. explicitly, but use a hostname (which is recommended), see also the :ref:`FAQ <faq-dns>`.
  218. roles \: optional
  219. Optional role definitions. Nodes will announce their role inside the mesh.
  220. This will allow in the backend to distinguish between normal, backbone and
  221. service nodes or even gateways (if they advertise that role). It is up to
  222. the community which roles to define. See the section below as an example.
  223. ``default`` takes the default role which is set initially. This value should be
  224. part of ``list``. If you want node owners to change the role via config mode add
  225. the package ``gluon-luci-node-role`` to ``site.mk``.
  226. The strings to display in the LuCI interface are configured per language in the
  227. ``i18n/en.po``, ``i18n/de.po``, etc. files of the site repository using message IDs like
  228. ``gluon-luci-node-role:role:node`` and ``gluon-luci-node-role:role:backbone``.
  229. ::
  230. roles = {
  231. default = 'node',
  232. list = {
  233. 'node',
  234. 'test',
  235. 'backbone',
  236. 'service',
  237. },
  238. },
  239. setup_mode \: package
  240. Allows skipping setup mode (config mode) at first boot when attribute
  241. ``skip`` is set to ``true``. This is optional and may be left out.
  242. ::
  243. setup_mode = {
  244. skip = true,
  245. },
  246. legacy \: package
  247. Configuration for the legacy upgrade path.
  248. This is only required in communities upgrading from Lübeck's LFF-0.3.x.
  249. ::
  250. legacy = {
  251. version_files = {'/etc/.freifunk_version_keep', '/etc/.eff_version_keep'},
  252. old_files = {'/etc/config/config_mode', '/etc/config/ffac', '/etc/config/freifunk'},
  253. config_mode_configs = {'config_mode', 'ffac', 'freifunk'},
  254. fastd_configs = {'ffac_mesh_vpn', 'mesh_vpn'},
  255. mesh_ifname = 'freifunk',
  256. tc_configs = {'ffki', 'freifunk'},
  257. wifi_names = {'wifi_freifunk', 'wifi_freifunk5', 'wifi_mesh', 'wifi_mesh5'},
  258. }
  259. Packages
  260. --------
  261. The ``site.mk`` is a Makefile which should define constants
  262. involved in the build process of Gluon.
  263. GLUON_SITE_PACKAGES
  264. Defines a list of packages which should be installed additionally
  265. to the ``gluon-core`` package.
  266. GLUON_RELEASE
  267. The current release version Gluon should use.
  268. GLUON_PRIORITY
  269. The default priority for the generated manifests (see the autoupdater documentation
  270. for more information).
  271. GLUON_REGION
  272. Region code to build into images where necessary. Valid values are the empty string,
  273. ``us`` and ``eu``.
  274. GLUON_LANGS
  275. List of languages (as two-letter-codes) to be included in the web interface. Should always contain
  276. ``en``.
  277. .. _site-config-mode-texts:
  278. Config mode texts
  279. -----------------
  280. The community-defined texts in the config mode are configured in PO files in the ``i18n`` subdirectory
  281. of the site configuration. The message IDs currently defined are:
  282. gluon-config-mode:welcome
  283. Welcome text on the top of the config wizard page.
  284. gluon-config-mode:pubkey
  285. Information about the public VPN key on the reboot page.
  286. gluon-config-mode:altitude-label
  287. Label for the ``altitude`` field
  288. gluon-config-mode:altitude-help
  289. Description for the usage of the ``altitude`` field
  290. gluon-config-mode:reboot
  291. General information shown on the reboot page.
  292. There is a POT file in the site example directory which can be used to create templates
  293. for the language files. The command ``msginit -l en -i ../../docs/site-example/i18n/gluon-site.pot``
  294. can be used from the ``i18n`` directory to create an initial PO file called ``en.po`` if the ``gettext``
  295. utilities are installed.
  296. .. note::
  297. An empty ``msgstr``, as is the default after running ``msginit``, leads to
  298. the ``msgid`` being printed as-is. It does *not* hide the whole text, as
  299. might be expected.
  300. Depending on the context, you might be able to use comments like
  301. ``<!-- empty -->`` as translations to effectively hide the text.
  302. Site modules
  303. ------------
  304. The file ``modules`` in the site repository is completely optional and can be used
  305. to supply additional package feeds from which packages are built. The git repositories
  306. specified here are retrieved in addition to the default feeds when ``make update``
  307. it called.
  308. This file's format is very similar to the toplevel ``modules`` file of the Gluon
  309. tree, with the important different that the list of feeds must be assigned to
  310. the variable ``GLUON_SITE_FEEDS``. Multiple feed names must be separated by spaces,
  311. for example::
  312. GLUON_SITE_FEEDS='foo bar'
  313. The feed names may only contain alphanumerical characters, underscores and slashes.
  314. For each of the feeds, the following variables are used to specify how to update
  315. the feed:
  316. PACKAGES_${feed}_REPO
  317. The URL of the git repository to clone (usually ``git://`` or ``http(s)://``)
  318. PACKAGES_${feed}_COMMIT
  319. The commit ID of the repository to use
  320. PACKAGES_${feed}_BRANCH
  321. Optional: The branch of the repository the given commit ID can be found in.
  322. Defaults to the default branch of the repository (usually ``master``)
  323. These variables are always all uppercase, so for an entry ``foo`` in GLUON_SITE_FEEDS,
  324. the corresponding configuration variables would be ``PACKAGES_FOO_REPO``,
  325. ``PACKAGES_FOO_COMMIT`` and ``PACKAGES_FOO_BRANCH``. Slashes in feed names are
  326. replaced by underscores to get valid shell variable identifiers.
  327. Examples
  328. --------
  329. site.mk
  330. ^^^^^^^
  331. .. literalinclude:: ../site-example/site.mk
  332. :language: makefile
  333. site.conf
  334. ^^^^^^^^^
  335. .. literalinclude:: ../site-example/site.conf
  336. :language: lua
  337. i18n/en.po
  338. ^^^^^^^^^^
  339. .. literalinclude:: ../site-example/i18n/en.po
  340. :language: po
  341. i18n/de.po
  342. ^^^^^^^^^^
  343. .. literalinclude:: ../site-example/i18n/de.po
  344. :language: po
  345. modules
  346. ^^^^^^^
  347. .. literalinclude:: ../site-example/modules
  348. :language: makefile
  349. site-repos in the wild
  350. ^^^^^^^^^^^^^^^^^^^^^^
  351. This is a non-exhaustive list of site-repos from various communities:
  352. * `site-ffa <https://github.com/tecff/site-ffa>`_ (Altdorf, Landshut & Umgebung)
  353. * `site-ffac <https://github.com/ffac/site>`_ (Regio Aachen)
  354. * `site-ffbs <https://github.com/ffbs/site-ffbs>`_ (Braunschweig)
  355. * `site-ffhb <https://github.com/FreifunkBremen/gluon-site-ffhb>`_ (Bremen)
  356. * `site-ffda <https://github.com/freifunk-darmstadt/site-ffda>`_ (Darmstadt)
  357. * `site-ffeh <https://github.com/freifunk-ehingen/site-ffeh>`_ (Ehingen)
  358. * `site-fffl <https://github.com/freifunk-flensburg/site-fffl>`_ (Flensburg)
  359. * `site-ffgoe <https://github.com/freifunk-goettingen/site-ffgoe>`_ (Göttingen)
  360. * `site-ffgt-rhw <https://github.com/ffgtso/site-ffgt-rhw>`_ (Guetersloh)
  361. * `site-ffhh <https://github.com/freifunkhamburg/site-ffhh>`_ (Hamburg)
  362. * `site-ffho <https://git.c3pb.de/freifunk-pb/site-ffho>`_ (Hochstift)
  363. * `site-ffhgw <https://github.com/lorenzo-greifswald/site-ffhgw>`_ (Greifswald)
  364. * `site-ffka <https://github.com/ffka/site-ffka>`_ (Karlsruhe)
  365. * `site-ffki <http://git.freifunk.in-kiel.de/ffki-site/>`_ (Kiel)
  366. * `site-fflz <https://github.com/freifunk-lausitz/site-fflz>`_ (Lausitz)
  367. * `site-ffl <https://github.com/freifunk-leipzig/freifunk-gluon-leipzig>`_ (Leipzig)
  368. * `site-ffhl <https://github.com/freifunk-luebeck/site-ffhl>`_ (Lübeck)
  369. * `site-fflg <https://github.com/kartenkarsten/site-fflg>`_ (Lüneburg)
  370. * `site-ffmd <https://github.com/FreifunkMD/site-ffmd>`_ (Magdeburg)
  371. * `site-ffmwu <https://github.com/freifunk-mwu/sites-ffmwu>`_ (Mainz, Wiesbaden & Umgebung)
  372. * `site-ffmyk <https://github.com/FreifunkMYK/site-ffmyk>`_ (Mayen-Koblenz)
  373. * `site-ffmo <https://github.com/ffruhr/site-ffmo>`_ (Moers)
  374. * `site-ffmg <https://github.com/ffruhr/site-ffmg>`_ (Mönchengladbach)
  375. * `site-ffm <https://github.com/freifunkMUC/site-ffm>`_ (München)
  376. * `site-ffhmue <https://github.com/Freifunk-Muenden/site-conf>`_ (Münden)
  377. * `site-ffms <https://github.com/FreiFunkMuenster/site-ffms>`_ (Münsterland)
  378. * `site-neuss <https://github.com/ffne/site-neuss>`_ (Neuss)
  379. * `site-ffniers <https://github.com/ffruhr/site-ffniers>`_ (Niersufer)
  380. * `site-ffnw <https://git.nordwest.freifunk.net/ffnw-firmware/siteconf/tree/master>`_ (Nordwest)
  381. * `site-ffrgb <https://github.com/ffrgb/site-ffrgb>`_ (Regensburg)
  382. * `site-ffrn <https://github.com/Freifunk-Rhein-Neckar/site-ffrn>`_ (Rhein-Neckar)
  383. * `site-ffruhr <https://github.com/ffruhr?utf8=✓&query=site>`_ (Ruhrgebiet, Multi-Communities)
  384. * `site-ffs <https://github.com/freifunk-stuttgart/site-ffs>`_ (Stuttgart)
  385. * `site-fftr <https://github.com/freifunktrier/site-fftr>`_ (Trier)