site.rst 19 KB

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