docs/releases/v2022.1.rst

+Gluon 2022.1
+============
+
+Important notes
+---------------
+
+Upgrades to v2022.1 and later releases are only supported from releases v2020.1 and later. This is due to migrations that have been removed to simplify maintenance.
+
+
+Added hardware support
+----------------------
+
+ath79-generic
+~~~~~~~~~~~~~
+
+- D-Link
+
+  - DAP-2660 A1
+
+- Enterasys
+
+  - WS-AP3705i
+
+- Siemens
+
+  - WS-AP3610
+
+- TP-Link
+
+  - Archer A7 v5
+  - CPE510 v2
+  - CPE510 v3
+  - CPE710 v1
+  - EAP225-Outdoor v1
+  - WBS210 v2
+
+ath79-mikrotik
+~~~~~~~~~~~~~~
+
+- Mikrotik
+
+  - RB951Ui-2nD
+
+ipq40xx-generic
+~~~~~~~~~~~~~~~
+
+- Aruba Networks
+
+  - AP-303H
+  - AP-365
+  - InstantOn AP11D
+  - InstantOn AP17
+
+ipq40xx-mikrotik
+~~~~~~~~~~~~~~~~
+
+- Mikrotik
+
+  - SXTsq-5-AC
+
+ramips-mt7620
+~~~~~~~~~~~~~
+
+- Xiaomi
+
+  - Mi Router 3G (v2)
+
+ramips-mt7621
+~~~~~~~~~~~~~
+
+- Cudy
+
+  - WR2100
+
+- Netgear
+
+  - R6260
+  - WAC104
+  - WAX202
+
+- TP-Link
+
+  - RE500
+  - RE650 v1
+
+- Ubiquiti
+
+  - UniFi 6 Lite
+
+- Xiaomi
+
+  - Mi Router 4A (Gigabit Edition)
+
+ramips-mt7622
+~~~~~~~~~~~~~
+
+- Linksys
+
+  - E8450
+
+- Xiaomi
+
+  - AX3200
+
+- Ubiquiti
+
+  - UniFi 6 LR
+
+ramips-mt76x8
+~~~~~~~~~~~~~
+
+- GL.iNet
+
+  - microuter-N300
+
+- Netgear
+
+  - R6020
+
+- RAVPower
+
+  - RP-WD009
+
+- TP-Link
+
+  - Archer C20 v4
+  - Archer C20 v5
+  - RE200 v2
+  - RE305 v1
+
+- Xiaomi
+
+  - Mi Router 4C
+  - Mi Router 4A (100M Edition)
+
+rockchip-armv8
+~~~~~~~~~~~~~~
+
+- FriendlyElec
+
+  - NanoPi R2S
+
+mpc85xx-p1010
+~~~~~~~~~~~~~
+
+- Sophos
+
+  - RED 15w rev. 1
+
+mpc85xx-p1020
+~~~~~~~~~~~~~
+
+- Extreme Networks
+
+  - WS-AP3825i
+
+Removed Devices
+---------------
+
+This list contains devices which do not have enough memory or flash to
+be operated with this Gluon release.
+
+- D-Link
+
+  - DIR-615 (C1, D1, D2, D3, D4, H1)
+
+- Linksys
+
+  - WRT160NL
+
+- TP-Link
+
+  - TL-MR13U (v1)
+  - TL-MR3020 (v1)
+  - TL-MR3040 (v1, v2)
+  - TL-MR3220 (v1, v2)
+  - TL-MR3420 (v1, v2)
+  - TL-WA701N/ND (v1, v2)
+  - TL-WA730RE (v1)
+  - TL-WA750RE (v1)
+  - TL-WA801N/ND (v1, v2, v3)
+  - TL-WA830RE (v1, v2)
+  - TL-WA850RE (v1)
+  - TL-WA860RE (v1)
+  - TL-WA901N/ND (v1, v2, v3, v4, v5)
+  - TL-WA7210N (v2)
+  - TL-WA7510N (v1)
+  - TL-WR703N (v1)
+  - TL-WR710N (v1, v2)
+  - TL-WR740N (v1, v3, v4, v5)
+  - TL-WR741N/ND (v1, v2, v4, v5)
+  - TL-WR743N/ND (v1, v2)
+  - TL-WR840N (v2)
+  - TL-WR841N/ND (v3, v5, v7, v8, v9, v10, v11, v12)
+  - TL-WR841N/ND (v1, v2)
+  - TL-WR843N/ND (v1)
+  - TL-WR940N (v1, v2, v3, v4, v5, v6)
+  - TL-WR941ND (v2, v3, v4, v5, v6)
+  - TL-WR1043N/ND (v1)
+  - WDR4900
+
+- Ubiquiti
+
+  - AirGateway
+  - AirGateway Pro
+  - AirRouter
+  - Bullet
+  - LS-SR71
+  - Nanostation XM
+  - Nanostation Loco XM
+  - Picostation
+
+- Unknown
+
+  - A5-V11
+
+- VoCore
+
+  - VoCore (8M, 16M)
+
+Atheros target migration
+------------------------
+
+All Atheros MIPS devices built with the ``ar71xx-generic``,
+``ar71xx-nand`` as well as ``ar71xx-tiny`` were deprecated upstream and
+are therefore not available with Gluon anymore.
+
+Many devices previously built with ``ar71xx-generic`` and
+``ar71xx-nand`` are now available with the ``ath79-generic`` as well as
+``ath79-nand`` target respectively.
+
+Missing devices
+~~~~~~~~~~~~~~~
+
+The following devices have not yet been integrated into Gluons ath79
+targets.
+
+- 8Devices
+
+  - Carambola 2
+
+- Aerohive
+
+  - HiveAP 121
+
+- Allnet
+
+  - ALL0315
+
+- Buffalo
+
+  - WZR-HP-G300NH2
+  - WZR-HP-G450H
+
+- GL.iNet
+
+  - 6408A v1
+
+- NETGEAR
+
+  - WNDR4300
+  - WNDRMAC
+  -  WNDRMAC v2
+
+- TP-Link
+
+  - WR2543
+
+- Ubiquiti
+
+  - Rocket
+
+- WD
+
+  - MyNet N600
+  - MyNet N750
+
+- ZyXEL
+
+  - NB6616
+  - NB6716
+
+Features
+--------
+
+WireGuard
+~~~~~~~~~
+
+Gluon got WireGuard support. This allows offloading **encrypted**
+connections into kernel space, increasing performance by forwarding
+packets without the need for context switches between user and kernel
+space.
+
+In order to reuse existing (already verified) fastd-keypairs for
+WireGuard, a key derivation procedure is `currently being
+developed <https://github.com/freifunk-gluon/gluon/pull/2601>`__. This
+should ease migration from fastd to WireGuard in case whitelisting VPN
+keys is desired.
+
+fastd L2TP
+~~~~~~~~~~
+
+fastd can now act as a connection broker for unencrypted L2TP-based
+tunneling within Gluons mesh-vpn framework. This new ``null@l2tp``
+connection method allows for increased performance within existing
+fastd setups.
+
+In addition to a sufficiently
+:ref:`configured fastd-based VPN server<vpn-gateway-configuration>`,
+this requires further modifications to a sites :ref:`VPN fastd methods<VPN fastd methods>`.
+
+Major changes
+-------------
+
+OpenWrt
+~~~~~~~
+
+This release is based on the newest OpenWrt 22.03 release branch.
+It ships with Linux kernel 5.10 as well as wireless-backports 5.15.
+
+
+Network changes (DSA / Upgrade-Behavior)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The ``ramips-mt7621`` and ``lantiq-xrx200`` targets now use the upstream DSA
+subsystem instead of OpenWrt swconfig for managing ethernet switches.
+
+Gluon detects the existing user-intent and automatically applies it over
+to DSA syntax. See the section about network reconfiguration for more
+details.
+
+System reconfiguration
+~~~~~~~~~~~~~~~~~~~~~~
+
+The network and system-LED configurations are now re-generated after
+each update / invocation of ``gluon-reconfigure``.
+
+The user-intent is preserved within Gluon’s implemented functionality
+(Wired-Mesh / Client access / WAN).
+
+As an additional feature, Gluon now supports assigning roles to
+interfaces. This behavior is explained
+:ref:`here<wired-mesh-commandline>`.
+
+Site changes
+------------
+
+VPN provider MTU
+~~~~~~~~~~~~~~~~
+
+To account for multiple VPN methods available for a site, the MTU used
+for the VPN tunnel connection is now moved to the specific VPN provider
+configuration. For fastd this means that ``mesh_vpn.mtu`` needs to be
+moved to ``mesh_vpn.fastd.mtu``. (`#2352 <https://github.com/freifunk-gluon/gluon/pull/2352>`__)
+
+Preconfigured Interfaces Roles
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Instead of ``mesh_on_wan`` and ``mesh_on_lan`` there is now an
+``interfaces`` block to configure the default behavior of network
+interfaces. Details can be found in the 
+:ref:`documentation<user-site-interfaces>`.
+
+Minor changes
+-------------
+
+- The ``brcm2708-bcm2708`` ``brcm2708-bcm2709`` ``brcm2708-bcm2710``
+  targets were renamed to ``bcm27xx-bcm2708`` ``bcm27xx-bcm2709`` and
+  ``bcm27xx-bcm2710``
+- The GL.iNet GL-AR750S was moved to the ``ath79-nand`` subtarget
+- Gluon now ships the ath10k-ct firmware derivation for
+  QCA9886 / QCA9888 / QCA9896 / QCA9898 / QCA9984 /
+  QCA9994 / IPQ4018 / IPQ4028 / IPQ4019 / IPQ4029
+  radios (`#2541 <https://github.com/freifunk-gluon/gluon/pull/2541>`__)
+- WolfSSL instead of OpenSSL is now used when built with WPA3 support
+- The option to configure the wireless-channel independent from the
+  site-selected channel was moved from
+  ``gluon-core.wireless.preserve_channels`` to
+  ``gluon.wireless.preserve_channels``
+- ``gluon-info`` is a new command that provides information about the
+  current node
+- ``GLUON_DEPRECATED`` is now set to 0 by default
+- To reboot a running gluon-node into setup-mode, Gluon now offers the
+  ``gluon-enter-setup-mode`` command
+- Devices without WLAN do not show the private-wifi configuration
+  anymore
+- The Autoupdater now uses the site default branch in case it is
+  configured to use a non-existent / invalid branch
+
+Known issues
+------------
+
+* A workaround for Android devices not waking up to their MLD subscriptions was removed,
+  potentially breaking IPv6 connectivity for these devices after extended sleep periods.
+  (`#2672 <https://github.com/freifunk-gluon/gluon/issues/2672>`_)
+
+* Upgrading EdgeRouter-X from versions before v2020.1.x may lead to a soft-bricked state due to bad blocks on the NAND flash which the NAND driver before this release does not handle well.
+  (`#1937 <https://github.com/freifunk-gluon/gluon/issues/1937>`_)
+
+* The integration of the BATMAN_V routing algorithm is incomplete.
+
+  - Mesh neighbors don't appear on the status page. (`#1726 <https://github.com/freifunk-gluon/gluon/issues/1726>`_)
+    Many tools have the BATMAN_IV metric hardcoded, these need to be updated to account for the new throughput
+    metric.
+  - Throughput values are not correctly acquired for different interface types.
+    (`#1728 <https://github.com/freifunk-gluon/gluon/issues/1728>`_)
+    This affects virtual interface types like bridges and VXLAN.
+
+* Default TX power on many Ubiquiti devices is too high, correct offsets are unknown
+  (`#94 <https://github.com/freifunk-gluon/gluon/issues/94>`_)
+
+  Reducing the TX power in the Advanced Settings is recommended.
+
+* In configurations without VXLAN, the MAC address of the WAN interface is modified even when Mesh-on-WAN is disabled
+  (`#496 <https://github.com/freifunk-gluon/gluon/issues/496>`_)
+
+  This may lead to issues in environments where a fixed MAC address is expected (like VMware when promiscuous mode is disallowed).

docs/releases/v2023.1.1.rst

+Gluon 2023.1.1
+==============
+
+This is the first service release for the Gluon 2023.1.x line, fixing regressions reported by
+the community.
+
+Important notes
+---------------
+
+Upgrades to this version are only supported from releases v2021.1 and later.
+
+**Note:**
+This release was found to be soft-bricking AVM Fritz!Box 7520 and 7530.
+We advice to not offer the release for these two devices until this gets fixed.
+Affected devices can be recovered to Fritz!OS and then reinstalled by using the (`AVM Recovery Tool <https://download.avm.de/fritzbox/fritzbox-7530/other/recover/>`_)
+
+Bugfixes
+--------
+
+- x86: fix config loss during direct upgrades from v2021.1.x to v2023.1.x (`#2972 <https://github.com/freifunk-gluon/gluon/pull/2972>`_)
+
+- tunneldigger: fix regression in v2023.1 caused by an always failing watchdog script resulting in endless restarts (`#2987 <https://github.com/freifunk-gluon/gluon/pull/2987>`_)
+
+- tunneldigger: fix regression in v2023.1 with DNS lookups not using the wan-dnsmasq (`#3001 <https://github.com/freifunk-gluon/gluon/pull/3001>`_)
+
+- gluon-wan-dnsmasq: fix regression in v2023.1 with restart handling and disable DNS caching on the WAN side (`#2991 <https://github.com/freifunk-gluon/gluon/pull/2991>`_)
+
+- D-Link DIR-860L B1: fix regression in v2023.1 that prevented direct upgrades from v2021.1.x to v2023.1.x (`#2990 <https://github.com/freifunk-gluon/gluon/pull/2990>`_)
+
+- Fix build issues with groff 1.23.0+ on the build host (`#3001 <https://github.com/freifunk-gluon/gluon/pull/3001>`_)
+
+
+Known issues
+------------
+
+* The integration of the BATMAN_V routing algorithm is incomplete.
+
+  - Mesh neighbors don't appear on the status page. (`#1726 <https://github.com/freifunk-gluon/gluon/issues/1726>`_)
+    Many tools have the BATMAN_IV metric hardcoded, these need to be updated to account for the new throughput
+    metric.
+  - Throughput values are not correctly acquired for different interface types.
+    (`#1728 <https://github.com/freifunk-gluon/gluon/issues/1728>`_)
+    This affects virtual interface types like bridges and VXLAN.
+
+* Default TX power on many Ubiquiti devices is too high, correct offsets are unknown
+  (`#94 <https://github.com/freifunk-gluon/gluon/issues/94>`_)
+
+  Reducing the TX power in the Advanced Settings is recommended.
+
+* In configurations without VXLAN, the MAC address of the WAN interface is modified even when Mesh-on-WAN is disabled
+  (`#496 <https://github.com/freifunk-gluon/gluon/issues/496>`_)
+
+  This may lead to issues in environments where a fixed MAC address is expected (like VMware when promiscuous mode is disallowed).
+
+* EFI only systems won't boot due to removed EFI support (introduced in v2023.1). This was necessary to work around a bug that
+  causes a config loss during direct upgrades from v2021.1.x to v2023.1.x with the *x86-64*, *x86-generic* and *x86-legacy* targets
+  (`#2967 <https://github.com/freifunk-gluon/gluon/issues/2967>`_).
+
+  It is planned that the next major release will reintroduce EFI support.
+
+* AVM Fritz!Box 7520 and 7530 get soft-bricked by this release. The issue was introduced by a kernel bump.
+  (`#3023 <https://github.com/freifunk-gluon/gluon/issues/3023>`_)

docs/releases/v2023.1.2.rst

+Gluon 2023.1.2
+==============
+
+Minor changes
+-------------
+
+- Update latest OpenWRT 22.03 version and the corresponding modules
+
+- Always prefer Gluon feeds over upstream feeds while building (`#3026 <https://github.com/freifunk-gluon/gluon/pull/3026>`_)
+
+
+Bugfixes
+--------
+
+- Fixed Raspberry Pi 3 and 4 naming (`#3099 <https://github.com/freifunk-gluon/gluon/issues/3099>`_)
+
+- Fixed inconsistent usage of env variable BROKEN (`#3103 <https://github.com/freifunk-gluon/gluon/issues/3103>`_)
+
+- Fixed gluon-reconfigure failures when no interface role was selected for an interface (`#3095 <https://github.com/freifunk-gluon/gluon/issues/3095>`_)
+
+- Fixed unexpected WiFi shutdowns on TP-Link Archer C7 (`#3049 <https://github.com/freifunk-gluon/gluon/issues/3049>`_)
+
+- Fixed unintentional CPU downclocks of ipq40xx devices (`#3049 <https://github.com/freifunk-gluon/gluon/issues/3049>`_)
+
+- Fixed bandwidth downstream (ingress) limit (`#3017 <https://github.com/freifunk-gluon/gluon/issues/3017>`_)
+
+- Fixed occasional reboot issues on some TP-Link WDR3600 and WDR4300 devices
+  (`Upstream <https://github.com/openwrt/openwrt/issues/13043>`_)
+  (`#2904 <https://github.com/freifunk-gluon/gluon/issues/2904>`_)
+
+
+Known issues
+------------
+
+* The integration of the BATMAN_V routing algorithm is incomplete.
+
+  - Mesh neighbors don't appear on the status page. (`#1726 <https://github.com/freifunk-gluon/gluon/issues/1726>`_)
+    Many tools have the BATMAN_IV metric hardcoded, these need to be updated to account for the new throughput
+    metric.
+  - Throughput values are not correctly acquired for different interface types.
+    (`#1728 <https://github.com/freifunk-gluon/gluon/issues/1728>`_)
+    This affects virtual interface types like bridges and VXLAN.
+
+* Default TX power on many Ubiquiti devices is too high, correct offsets are unknown
+  (`#94 <https://github.com/freifunk-gluon/gluon/issues/94>`_)
+
+  Reducing the TX power in the Advanced Settings is recommended.
+
+* In configurations without VXLAN, the MAC address of the WAN interface is modified even when Mesh-on-WAN is disabled
+  (`#496 <https://github.com/freifunk-gluon/gluon/issues/496>`_)
+
+  This may lead to issues in environments where a fixed MAC address is expected (like VMware when promiscuous mode is disallowed).
+
+* EFI only systems won't boot due to removed EFI support (introduced in v2023.1). This was necessary to work around a bug that
+  causes a config loss during direct upgrades from v2021.1.x to v2023.1.x with the *x86-64*, *x86-generic* and *x86-legacy* targets
+  (`#2967 <https://github.com/freifunk-gluon/gluon/issues/2967>`_).
+
+  Gluon v2023.2 reintroduced EFI support.

docs/releases/v2023.1.rst

+Gluon 2023.1
+============
+
+Important notes
+---------------
+
+Upgrades to v2023.1 and later releases are only supported from releases v2021.1 and later.
+This is due to migrations that have been removed to simplify maintenance.
+
+**Note:**
+Due to a bug, configuration is lost on upgrades from Gluon v2021.1.x on the *x86-64*,
+*x86-generic* and *x86-legacy* targets, returning nodes to config mode. If your
+network is still running a Gluon version older than v2022.1, it is recommended to
+skip v2023.1 and wait for the v2023.1.1 release.
+
+Added hardware support
+----------------------
+
+ath79-generic
+~~~~~~~~~~~~~
+
+- Extreme Networks
+
+  - WS-AP3805i
+
+ath79-nand
+~~~~~~~~~~
+
+- GL.iNet
+
+  - GL-XE300
+
+ramips-mt7621
+~~~~~~~~~~~~~
+
+- TP-Link
+
+  - EAP615-Wall
+
+- Wavlink
+
+  - WS-WN572HP3 4G
+
+ramips-mt76x8
+~~~~~~~~~~~~~
+
+- TP-Link
+
+  - TL-MR6400 (v5)
+
+
+Features
+--------
+
+DNS Caching
+~~~~~~~~~~~
+
+DNS caching using the dnsmasq resolver is reintroduced.
+
+See the :ref:`DNS caching documentation <dns-caching>` section for
+details on how to enable this feature.
+
+Cellular Modem Support
+~~~~~~~~~~~~~~~~~~~~~~
+
+Support for using cellular data connections as the primary uplink connection has been added
+to Gluon. This is supported for hardware that comes with a built-in cellular modem. The required user
+configuration for the APN and SIM-PIN can be performed in the Advanced Settings in Config Mode.
+
+To use this feature in config-mode, the ``web-cellular`` needs to be enabled in ``site.mk``.
+
+Interface Role UI
+~~~~~~~~~~~~~~~~~
+
+Interface Roles can now be assigned from the Network page of the Advanced Settings
+in Config Mode. This configuration is preserved on Gluon upgrades.
+
+WireGuard Key Translation
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This release adds a new mechanism for seamlessly translating existing fastd private keys on the nodes into
+equivalent WireGuard keys. The corresponding public keys can be translated **separately** on the servers.
+This mitigates the need to re-exchange public keys for communities when migrating to WireGuard-based VPN.
+
+See the :ref:`gluon-mesh-vpn-key-translate <gluon-mesh-vpn-key-translate>` section for details.
+
+
+Bugfixes
+--------
+
+- Custom channel lists using a radios ``channels`` UCI option are now preserved on upgrade
+  in case ``gluon.wireless.preserve_channels`` is set.
+- Custom HT modes for radios are now preserved when ``gluon.wireless.preserve_channels``
+  is set.
+- Broken mesh links between MediaTek 11ax and Qualcomm 11ac hardware are worked around. (`#2905 <https://github.com/freifunk-gluon/gluon/pull/2905>`_)
+- Fixed a bug in the MediaTek MT7621 NAND driver that caused devices to end in a bootlooping state
+  after the initial installation.
+
+
+Minor changes
+-------------
+
+- .. rst-class:: strike
+
+  Images built for the ``x86`` targets are now natively bootable on
+  EFI systems without CSM or BIOS support modes.
+
+  EFI support was found to break upgrades from Gluon v2021.1.x. It will be removed from
+  v2023.1.x to be reintroduced in a later release.
+
+Known issues
+------------
+
+* The integration of the BATMAN_V routing algorithm is incomplete.
+
+  - Mesh neighbors don't appear on the status page. (`#1726 <https://github.com/freifunk-gluon/gluon/issues/1726>`_)
+    Many tools have the BATMAN_IV metric hardcoded, these need to be updated to account for the new throughput
+    metric.
+  - Throughput values are not correctly acquired for different interface types.
+    (`#1728 <https://github.com/freifunk-gluon/gluon/issues/1728>`_)
+    This affects virtual interface types like bridges and VXLAN.
+
+* Default TX power on many Ubiquiti devices is too high, correct offsets are unknown
+  (`#94 <https://github.com/freifunk-gluon/gluon/issues/94>`_)
+
+  Reducing the TX power in the Advanced Settings is recommended.
+
+* In configurations without VXLAN, the MAC address of the WAN interface is modified even when Mesh-on-WAN is disabled
+  (`#496 <https://github.com/freifunk-gluon/gluon/issues/496>`_)
+
+  This may lead to issues in environments where a fixed MAC address is expected (like VMware when promiscuous mode is disallowed).
+
+* Configuration is lost on upgrades from Gluon v2021.1.x on the *x86-64*, *x86-generic* and *x86-legacy* targets,
+  returning nodes to config mode
+  (`#2967 <https://github.com/freifunk-gluon/gluon/issues/2967>`_)

docs/releases/v2023.2.1.rst

+Gluon 2023.2.1
+==============
+
+Added hardware support
+----------------------
+
+ath79-generic
+~~~~~~~~~~~~~
+
+- Ubiquiti
+
+  - UniFi Swiss Army Knife Ultra
+
+
+ramips-mt7621
+~~~~~~~~~~~~~
+
+- D-Link
+
+  - COVR-X1860 (A1)
+
+
+Minor changes
+-------------
+
+* Nodes using a fastd VPN connection now report the negotiated method on the status page
+  (`#2465 <https://github.com/freifunk-gluon/gluon/issues/2465>`_)
+
+
+Bugfixes
+--------
+
+* Fixed hostapd being unable to start an AP when selecting channel 116/120 with HT40
+  (`#3165 <https://github.com/freifunk-gluon/gluon/issues/3165>`_)
+
+* Fixed occasional reboot issues on some TP-Link WDR3600 and WDR4300 devices
+  (`Upstream <https://github.com/openwrt/openwrt/issues/13043>`_)
+  (`#2904 <https://github.com/freifunk-gluon/gluon/issues/2904>`_)
+  
+
+
+Known issues
+------------
+
+* Unstable wireless with certain MediaTek devices (`#3154 <https://github.com/freifunk-gluon/gluon/issues/3154>`_)
+
+* The integration of the BATMAN_V routing algorithm is incomplete.
+
+  - Mesh neighbors don't appear on the status page. (`#1726 <https://github.com/freifunk-gluon/gluon/issues/1726>`_)
+    Many tools have the BATMAN_IV metric hardcoded, these need to be updated to account for the new throughput
+    metric.
+  - Throughput values are not correctly acquired for different interface types.
+    (`#1728 <https://github.com/freifunk-gluon/gluon/issues/1728>`_)
+    This affects virtual interface types like bridges and VXLAN.
+
+* Default TX power on many Ubiquiti devices is too high, correct offsets are unknown
+  (`#94 <https://github.com/freifunk-gluon/gluon/issues/94>`_)
+
+  Reducing the TX power in the Advanced Settings is recommended.
+
+* In configurations without VXLAN, the MAC address of the WAN interface is modified even when Mesh-on-WAN is disabled
+  (`#496 <https://github.com/freifunk-gluon/gluon/issues/496>`_)
+
+  This may lead to issues in environments where a fixed MAC address is expected (like VMware when promiscuous mode is disallowed).

docs/releases/v2023.2.2.rst

+Gluon 2023.2.2
+==============
+
+Bugfixes
+--------
+
+* Fixed a bug where nodes connected using VXLAN would lose connectivity to all but one neighbor 
+  (`#3191 <https://github.com/freifunk-gluon/gluon/issues/3191>`_)  
+
+* fastd-l2tp VPN did not re-generate the flow-label for the inner-tunnel traffic,
+  breaking QoS mechanisms 
+  (`#3203 <https://github.com/freifunk-gluon/gluon/issues/3203>`_)  
+
+* Fixed silent-failures when image-customization files were not valid
+  (`#3218 <https://github.com/freifunk-gluon/gluon/issues/3218>`_)
+
+* Multicast-snooping did stop working after extended uptime periods
+  (`#3176 <https://github.com/freifunk-gluon/gluon/issues/3176>`_)
+
+
+Known issues
+------------
+
+* Unstable wireless with certain MediaTek devices (`#3154 <https://github.com/freifunk-gluon/gluon/issues/3154>`_)
+
+* The integration of the BATMAN_V routing algorithm is incomplete.
+
+  - Mesh neighbors don't appear on the status page. (`#1726 <https://github.com/freifunk-gluon/gluon/issues/1726>`_)
+    Many tools have the BATMAN_IV metric hardcoded, these need to be updated to account for the new throughput
+    metric.
+  - Throughput values are not correctly acquired for different interface types.
+    (`#1728 <https://github.com/freifunk-gluon/gluon/issues/1728>`_)
+    This affects virtual interface types like bridges and VXLAN.
+
+* Default TX power on many Ubiquiti devices is too high, correct offsets are unknown
+  (`#94 <https://github.com/freifunk-gluon/gluon/issues/94>`_)
+
+  Reducing the TX power in the Advanced Settings is recommended.
+
+* In configurations without VXLAN, the MAC address of the WAN interface is modified even when Mesh-on-WAN is disabled
+  (`#496 <https://github.com/freifunk-gluon/gluon/issues/496>`_)
+
+  This may lead to issues in environments where a fixed MAC address is expected (like VMware when promiscuous mode is disallowed).

docs/releases/v2023.2.3.rst

+Gluon 2023.2.3
+==============
+
+Added hardware support
+----------------------
+
+ath79-generic
+~~~~~~~~~~~~~
+
+- NETGEAR
+
+  - WNDRMAC v2
+
+
+mpc85xx-p1020
+~~~~~~~~~~~~~
+
+- Hewlett-Packard
+
+  - MSM460
+
+
+Bugfixes
+--------
+
+* Factory images for TP-Link Archer C7 v2 now contain the correct region code
+  (`#3260 <https://github.com/freifunk-gluon/gluon/issues/3260>`_)
+
+* Fixed an issue where some bootloader versions of the NETGEAR EX6150 v2 failed
+  to boot Gluon images in rare cases
+  (`Upstream <https://github.com/openwrt/openwrt/commit/de59fc45402ff03e320264c8204f6928090534ad>`_)  
+
+* Fixed boot procedure becoming stuck on Enterasys WS-AP3710i devices
+  (`#3248 <https://github.com/freifunk-gluon/gluon/issues/3248>`_)
+
+
+Known issues
+------------
+
+* Unstable wireless with certain MediaTek devices (`#3154 <https://github.com/freifunk-gluon/gluon/issues/3154>`_)
+
+* The integration of the BATMAN_V routing algorithm is incomplete.
+
+  - Mesh neighbors don't appear on the status page. (`#1726 <https://github.com/freifunk-gluon/gluon/issues/1726>`_)
+    Many tools have the BATMAN_IV metric hardcoded, these need to be updated to account for the new throughput
+    metric.
+  - Throughput values are not correctly acquired for different interface types.
+    (`#1728 <https://github.com/freifunk-gluon/gluon/issues/1728>`_)
+    This affects virtual interface types like bridges and VXLAN.
+
+* Default TX power on many Ubiquiti devices is too high, correct offsets are unknown
+  (`#94 <https://github.com/freifunk-gluon/gluon/issues/94>`_)
+
+  Reducing the TX power in the Advanced Settings is recommended.
+
+* In configurations without VXLAN, the MAC address of the WAN interface is modified even when Mesh-on-WAN is disabled
+  (`#496 <https://github.com/freifunk-gluon/gluon/issues/496>`_)
+
+  This may lead to issues in environments where a fixed MAC address is expected (like VMware when promiscuous mode is disallowed).

docs/releases/v2023.2.4.rst

+Gluon 2023.2.4
+==============
+
+Added hardware support
+----------------------
+
+ramips-mt7620
+~~~~~~~~~~~~~
+
+- NETGEAR
+
+  - EX6130
+
+
+ramips-mt7621
+~~~~~~~~~~~~~
+
+- Xiaomi
+
+  - Mi Router 4A (Gigabit Edition v2)
+
+
+ramips-mt76x8
+~~~~~~~~~~~~~
+
+- TP-Link
+
+  - RE200 (v4)
+
+
+Bugfixes
+--------
+
+* Fixed an issue where Enterasys WS-AP3710i devices regularly boot with all-zero MAC-addresses in previous releases
+
+* Detection of `swconfig` based switch architecture has been fixed (`#3309 <https://github.com/freifunk-gluon/gluon/pull/3309>`_)
+
+* Fixed an issue where the AVM FRITZ!Box 4040 used an incorrect primary MAC address
+  (`Upstream <https://github.com/openwrt/openwrt/commit/87fbb5085d7e290b0ba536ad7d0876c4224723a6>`_)
+
+
+Known issues
+------------
+
+* Unstable wireless with certain MediaTek devices (`#3154 <https://github.com/freifunk-gluon/gluon/issues/3154>`_)
+
+* The integration of the BATMAN_V routing algorithm is incomplete.
+
+  - Mesh neighbors don't appear on the status page. (`#1726 <https://github.com/freifunk-gluon/gluon/issues/1726>`_)
+    Many tools have the BATMAN_IV metric hardcoded, these need to be updated to account for the new throughput
+    metric.
+  - Throughput values are not correctly acquired for different interface types.
+    (`#1728 <https://github.com/freifunk-gluon/gluon/issues/1728>`_)
+    This affects virtual interface types like bridges and VXLAN.
+
+* Default TX power on many Ubiquiti devices is too high, correct offsets are unknown
+  (`#94 <https://github.com/freifunk-gluon/gluon/issues/94>`_)
+
+  Reducing the TX power in the Advanced Settings is recommended.
+
+* In configurations without VXLAN, the MAC address of the WAN interface is modified even when Mesh-on-WAN is disabled
+  (`#496 <https://github.com/freifunk-gluon/gluon/issues/496>`_)
+
+  This may lead to issues in environments where a fixed MAC address is expected (like VMware when promiscuous mode is disallowed).

docs/releases/v2023.2.5.rst

+Gluon 2023.2.5
+==============
+
+Added hardware support
+----------------------
+
+ath79-generic
+~~~~~~~~~~~~~
+
+- Sophos
+
+  - AP15C
+
+ramips-mt7621
+~~~~~~~~~~~~~
+
+- Genexis
+
+  - Pulse EX400
+
+
+Bugfixes
+--------
+
+* VXLAN encapsulated mesh traffic arriving at a client interface is now filtered and not forwarded to the mesh
+
+* Fixed a missing import in `libgluonutil` which led to undefined behavior on 64 bit architectures
+
+
+Known issues
+------------
+
+* Unstable wireless with certain MediaTek devices (`#3154 <https://github.com/freifunk-gluon/gluon/issues/3154>`_)
+
+* The integration of the BATMAN_V routing algorithm is incomplete.
+
+  - Mesh neighbors don't appear on the status page. (`#1726 <https://github.com/freifunk-gluon/gluon/issues/1726>`_)
+    Many tools have the BATMAN_IV metric hardcoded, these need to be updated to account for the new throughput
+    metric.
+  - Throughput values are not correctly acquired for different interface types.
+    (`#1728 <https://github.com/freifunk-gluon/gluon/issues/1728>`_)
+    This affects virtual interface types like bridges and VXLAN.
+
+* Default TX power on many Ubiquiti devices is too high, correct offsets are unknown
+  (`#94 <https://github.com/freifunk-gluon/gluon/issues/94>`_)
+
+  Reducing the TX power in the Advanced Settings is recommended.
+
+* In configurations without VXLAN, the MAC address of the WAN interface is modified even when Mesh-on-WAN is disabled
+  (`#496 <https://github.com/freifunk-gluon/gluon/issues/496>`_)
+
+  This may lead to issues in environments where a fixed MAC address is expected (like VMware when promiscuous mode is disallowed).

docs/releases/v2023.2.rst

+Gluon 2023.2
+============
+
+Important notes
+---------------
+
+Upgrades to v2023.2 and later releases are only supported from releases v2022.1 and later.
+This is due to migrations that have been removed to simplify maintenance.
+
+
+Deprecation of Tunneldigger VPN
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Tunneldigger is set to be removed from the Gluon base repository in the next major Gluon release. It is recommended
+to migrate to fastd or WireGuard. Tunneldigger will be moved to the
+community-packages repository and can be installed from there as an alternative.
+
+
+Site changes
+------------
+
+Image customization
+~~~~~~~~~~~~~~~~~~~
+
+``GLUON_FEATURES`` and ``GLUON_SITE_PACKAGES`` have been replaced by a more flexible customization framework
+based on Lua. Feature and Package selection can be specified more granularly at both target and device level.
+
+All site configs need to be updated. Configuration like the following
+must be removed from ``site.mk``:
+
+.. code-block:: make
+
+    GLUON_FEATURES := \
+        autoupdater \
+        mesh-batman-adv-15 \
+        mesh-vpn-fastd \
+        respondd \
+        status-page \
+        web-advanced \
+        web-wizard
+
+    GLUON_FEATURES_standard := \
+        wireless-encryption-wpa3
+
+    GLUON_SITE_PACKAGES := iwinfo
+
+It is replaced by a new file ``image-customization.lua`` with content
+like the following:
+
+.. code-block:: lua
+
+    features({
+        'autoupdater',
+        'mesh-batman-adv-15',
+        'mesh-vpn-fastd',
+        'respondd',
+        'status-page',
+        'web-advanced',
+        'web-wizard',
+    })
+
+    if not device_class('tiny') then
+        features({
+            'wireless-encryption-wpa3',
+        })
+    end
+
+    packages({'iwinfo'})
+
+
+Additionally, this framework also allows communities to specify which devices should or should not be built.
+For more information, see the :ref:`image customization documentation <site-image-customization>`.
+
+
+Added hardware support
+----------------------
+
+armsr-armv7
+~~~~~~~~~~~
+
+- Arm
+
+  - Arm SystemReady 32-bit (EFI) [#virt]_
+
+
+armsr-armv8
+~~~~~~~~~~~
+
+- Arm
+
+  - Arm SystemReady 64-bit (EFI) [#virt]_
+
+
+.. [#virt]
+  The ArmSR targets can be used for running Gluon as a Virtual Machine on
+  Arm systems.
+
+
+ath79-generic
+~~~~~~~~~~~~~
+
+- AVM
+
+  - FRITZ!Repeater 1750E
+
+- Sophos
+
+  - AP100
+  - AP100c
+  - AP55
+  - AP55c
+
+- TP-Link
+
+  - Archer C60 (v1)
+  - EAP225-Outdoor v3
+  - TL-WR2543N/ND (v1)
+
+
+ath79-mikrotik
+~~~~~~~~~~~~~~
+
+- MikroTik
+
+  - wAPR-2nD (wAP R)
+
+
+ipq40xx-generic
+~~~~~~~~~~~~~~~
+
+- ZTE
+
+  - MF289F
+
+
+mediatek-filogic
+~~~~~~~~~~~~~~~~
+
+- ASUS
+
+  - TUF-AX4200
+
+- Cudy
+
+  - WR3000 (v1)
+
+- GL.iNet
+
+  - GL-MT3000
+
+- NETGEAR
+
+  - WAX220
+
+- Ubiquiti
+
+  - Unifi 6 Plus
+
+- ZyXEL
+
+  - NWA50AX Pro
+
+
+mpc85xx-p1010
+~~~~~~~~~~~~~
+
+- Enterasys
+
+  - WS-AP3715i
+
+
+ramips-mt7621
+~~~~~~~~~~~~~
+
+- TP-Link
+
+  - EAP615-Wall
+
+- Wavlink
+
+  - WS-WN572HP3 4G
+
+
+ramips-mt76x8
+~~~~~~~~~~~~~
+
+- ASUS
+
+  - RT-AX53U
+
+- ZyXEL
+
+  - WSM20
+
+
+Removed hardware support
+------------------------
+
+ath79-generic
+~~~~~~~~~~~~~
+
+- TP-Link
+
+  - Archer C60 (v1)
+  - RE355
+  - RE450 (v1)
+
+- Ubiquiti
+
+  - NanoBeam 5AC 19 (XC) [#airmax]_
+  - NanoBeam M5 (XW) [#airmax]_
+  - NanoStation Loco M2/M5 (XW) [#airmax]_
+  - NanoStation M2/M5 (XW) [#airmax]_
+
+.. [#airmax]
+  Ubiquiti airMax devices have been removed temporarily due to an unsolved issue with the flash write-protect.
+  They will eventually be re-added once the issue has been fixed upstream.
+  (`#2939 <https://github.com/freifunk-gluon/gluon/issues/2939>`_)
+
+ramips-mt7621
+~~~~~~~~~~~~~
+
+- TP-Link
+
+  - RE305
+
+
+Features
+--------
+
+TLS support
+~~~~~~~~~~~
+
+Gluon now provides HTTPS client support when the `tls` feature is included in the site
+configuration, allowing nodes to establish encrypted connections to autoupdater mirrors,
+opkg repositories and other HTTPS servers.
+
+Existing site configurations that add libustream TLS packages should switch to the `tls`
+feature instead, which will always include the recommended TLS implementation as well
+as common CA certificates (`ca-bundle`).
+
+
+EFI images
+~~~~~~~~~~
+
+Gluon x86-64 images now support systems using EFI boot. The same images are still compatible
+with legacy MBR boot methods.
+
+
+Support for CAKE with fastd
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Gluon now supports CAKE as a QoS mechanism with fastd. It is automatically enabled with devices
+offering at least 200MB of system memory. CAKE is enabled when throughput limits are configured
+for the mesh-VPN.
+
+For more information about the technical details, see the
+(`OpenWrt wiki <https://openwrt.org/docs/guide-user/network/traffic-shaping/sqm>`_).
+
+Support can be activated by including the `mesh-vpn-sqm` feature in the site configuration.
+
+
+Docker container
+~~~~~~~~~~~~~~~~
+
+The Gluon build-container is now published to the GitHub container registry.
+The container contains all the tools required to build Gluon images from source.
+
+See the (`container registry <https://github.com/freifunk-gluon/gluon/pkgs/container/gluon-build>`_) for more information.
+
+
+GitHub actions
+~~~~~~~~~~~~~~
+
+Gluon build tests now run inside a Docker container built from the gluon-build Dockerfile of the same version.
+
+
+Bugfixes
+--------
+
+- Fixed script failure when reconfiguring interface groups without an assigned role.
+- Host tools used to be built twice on first compilation.
+
+
+Major changes
+-------------
+
+This release is based on the newest OpenWrt 23.05 release branch.
+It ships with Linux kernel 5.15.y, wireless-backports 6.1.24 and batman-adv 2023.1.
+
+.. _releases-v2023.2-minor-changes:
+
+Minor changes
+-------------
+
+- D-Link DIR-825 B1 factory images are no longer built due to size constraints.
+  Please use a recent OpenWrt 23.05 image for factory installation and install Gluon
+  using sysupgrade.
+- The robots.txt now prohibits crawling the status page.
+- Changed the order in which Gluon installs packages into the OpenWrt build system
+  to favor Gluon and site packages over upstream OpenWrt packages.
+- If enough nodes are updated, the batman-adv multicast optimizations originally introduced in Gluon 2021.1 for link-local IPv6 multicast addresses
+  will be applied within the domain to routable IPv6 multicast addresses.
+- Gluon now uses mbedtls instead of WolfSSL for hostapd and wpa-supplicant.
+
+
+Known issues
+------------
+
+* The integration of the BATMAN_V routing algorithm is incomplete.
+
+  - Mesh neighbors don't appear on the status page. (`#1726 <https://github.com/freifunk-gluon/gluon/issues/1726>`_)
+    Many tools have the BATMAN_IV metric hardcoded, these need to be updated to account for the new throughput
+    metric.
+  - Throughput values are not correctly acquired for different interface types.
+    (`#1728 <https://github.com/freifunk-gluon/gluon/issues/1728>`_)
+    This affects virtual interface types like bridges and VXLAN.
+
+* Default TX power on many Ubiquiti devices is too high, correct offsets are unknown
+  (`#94 <https://github.com/freifunk-gluon/gluon/issues/94>`_)
+
+  Reducing the TX power in the Advanced Settings is recommended.
+
+* In configurations without VXLAN, the MAC address of the WAN interface is modified even when Mesh-on-WAN is disabled
+  (`#496 <https://github.com/freifunk-gluon/gluon/issues/496>`_)
+
+  This may lead to issues in environments where a fixed MAC address is expected (like VMware when promiscuous mode is disallowed).

docs/requirements.txt

+Sphinx==8.2.3
+sphinx-rtd-theme==3.0.2

docs/site-example/i18n/de.po

@@ -12,27 +12,97 @@ msgstr ""
 
 msgid "gluon-config-mode:welcome"
 msgstr ""
-"Willkommen zum Einrichtungsassistenten für deinen neuen Entenhausener "
+"Willkommen zum Einrichtungsassistenten für deinen neuen Alpha Centauri "
 "Freifunk-Knoten. Fülle das folgende Formular deinen Vorstellungen "
 "entsprechend aus und sende es ab."
 
+msgid "gluon-config-mode:domain"
+msgstr "Domäne"
+
+msgid "gluon-config-mode:domain-select"
+msgstr ""
+"Hier hast du die Möglichkeit, die Mesh-Domäne, in der sich dein Knoten "
+"befindet, auszuwählen. Bitte denke daran, dass sich dein Knoten nur mit den "
+"Knoten der ausgewählten Domäne verbinden kann."
+
 msgid "gluon-config-mode:pubkey"
 msgstr ""
-"Dies ist der öffentliche Schlüssel deines Freifunk-Knotens. Erst nachdem "
-"er auf den Servern des Entenhausener Freifunk-Projektes eingetragen wurde, "
-"kann sich dein Knoten mit dem Entenhausener Mesh-VPN zu verbinden. Bitte "
-"schicke dazu diesen Schlüssel und den Namen deines Knotens "
-"(<em><%=hostname%></em>) an "
-"<a href=\"mailto:keys@entenhausen.freifunk.net\">keys@entenhausen.freifunk.net</a>."
+"<p>Dies ist der öffentliche Schlüssel deines Freifunk-Knotens. Erst nachdem "
+"er auf den Servern des Freifunk-Projektes auf Alpha Centauri eingetragen "
+"wurde, kann sich dein Knoten mit dem Mesh-VPN dort verbinden. Bitte schicke "
+"dazu diesen Schlüssel und den Namen deines Knotens "
+"(<em><%=pcdata(hostname)%></em>) an "
+"<a href=\"mailto:keys@alpha-centauri.freifunk.net?subject="
+"<%= urlencode('Anmeldung: ' .. hostname) %>&amp;body="
+"<%= urlencode('# ' .. hostname .. '\n# ' .. sysconfig.primary_mac .. '\nkey ') %>"
+"%22<%= pubkey %>%22;"
+"<%= urlencode('\n\nIch habe zur Kenntnis genommen, dass der im ') %>"
+"<%= urlencode('Knoten von mir eingetragene Kontakt im Meshnetz ') %>"
+"<%= urlencode('öffentlich abfragbar ist und von beliebigen Diensten ') %>"
+"<%= urlencode('(z.B. der Freifunk-Karte) veröffentlicht werden kann.') %>"
+"<%= urlencode('\n\nGruß, \n\n') %>"
+"\">keys@alpha-centauri.freifunk.net</a>. Deine E-Mail Adresse wird "
+"selbstverständlich vertraulich behandelt und nicht weitergegeben."
+"</p>"
+"<div class=\"the-key\">"
+"# <%= pcdata(hostname) %><br>"
+"<%= pubkey %>"
+"</div>"
+"<p>Dein Knoten startet gerade neu und wird anschließend versuchen, sich mit "
+"anderen Freifunkknoten in seiner Nähe über WLAN sowie über deine "
+"Internetverbindung über das VPN-Gateway zu verbinden.</p>"
+"<p>Vergiss nicht das Netzwerkkabel vom LAN Port in den WAN Port "
+"umzustecken.</p>"
+
+msgid "gluon-config-mode:novpn"
+msgstr ""
+"<p><strong>Du hast ausgewählt die Internetverbindung (Mesh-VPN) nicht zu "
+"nutzen</strong>. Dein Knoten kann also nur dann eine Verbindung zum "
+"Freifunk-Netz aufbauen, wenn andere Freifunk-Knoten in WLAN-Reichweite sind.</p>"
+"<p>Bitte schicke uns eine E-Mail mit dem Namen deines Knotens "
+"(<em><%= pcdata(hostname) %></em>) und ein paar Informationen an <a href="
+"\"mailto:kontakt@alpha-centauri.freifunk.net?"
+"subject=<%= urlencode('Anmeldung: ' .. hostname) %>&amp;"
+"body=<%= urlencode('# ' .. hostname .. '\n# ' .. sysconfig.primary_mac .. '\n# kein mesh-VPN') %>"
+"<%= urlencode('\n\nIch habe zur Kenntnis genommen, dass der im ') %>"
+"<%= urlencode('Knoten von mir eingetragene Kontakt im Meshnetz ') %>"
+"<%= urlencode('öffentlich abfragbar ist und von beliebigen Diensten ') %>"
+"<%= urlencode('(z.B. der Freifunk-Karte) veröffentlicht werden kann.') %>"
+"<%= urlencode('\n\nGruß, \n\n') %>"
+"\">kontakt@alpha-centauri.freifunk.net</a>. Deine E-Mail Adresse wird "
+"selbstverständlich vertraulich behandelt und nicht weitergegeben.</p>"
+"<p>Dein Knoten <em><%= pcdata(hostname) %></em> startet gerade neu und wird "
+"anschließend versuchen, sich mit anderen Freifunkknoten in seiner Nähe über "
+"WLAN zu verbinden.</p>"
 
 msgid "gluon-config-mode:reboot"
 msgstr ""
-"<p>Dein Knoten startet gerade neu und wird anschließend versuchen, "
-"sich mit anderen Freifunkknoten in seiner Nähe zu "
-"verbinden. Weitere Informationen zur "
-"Entenhausener Freifunk-Community findest du auf "
-"<a href=\"https://entenhausen.freifunk.net/\">unserer Webseite</a>.</p>"
+"<p>Weitere Informationen zur "
+"Alpha Centauri Freifunk-Community findest du auf "
+"<a href=\"https://alpha-centauri.freifunk.net/\" target=\"_blank\">unserer "
+"Webseite</a>.</p>"
 "<p>Um zu dieser Konfigurationsseite zurückzugelangen, drücke im normalen "
-"Betrieb für drei Sekunden den Reset-Button. Das Gerät wird dann im Config "
+"Betrieb für ca. 10 Sekunden den Reset-Button. Das Gerät wird dann im Config "
 "Mode neustarten.</p>"
 "<p>Viel Spaß mit deinem Knoten und der Erkundung von Freifunk!</p>"
+
+# Leave empty to use the default text, which can be found in:
+# package/gluon-config-mode-hostname/i18n/
+msgid "gluon-config-mode:hostname-help"
+msgstr ""
+
+# Leave empty to use the default text, which can be found in:
+# package/gluon-config-mode-geo-location/i18n/
+msgid "gluon-config-mode:geo-location-help"
+msgstr ""
+
+msgid "gluon-config-mode:altitude-label"
+msgstr ""
+
+# Leave empty to use the default text, which can be found in:
+# package/gluon-config-mode-contact-info/i18n/
+msgid "gluon-config-mode:contact-help"
+msgstr ""
+
+msgid "gluon-config-mode:contact-note"
+msgstr ""

docs/site-example/i18n/en.po

@@ -2,8 +2,8 @@ msgid ""
 msgstr ""
 "Content-Type: text/plain; charset=UTF-8\n"
 "Project-Id-Version: PACKAGE VERSION\n"
-"PO-Revision-Date: 2015-03-19 20:28+0100\n"
-"Last-Translator: Matthias Schiffer <mschiffer@universe-factory.net>\n"
+"PO-Revision-Date: 2016-02-04 14:28+0100\n"
+"Last-Translator: David Lutz <kpanic@hirnduenger.de>\n"
 "Language-Team: English\n"
 "Language: en\n"
 "MIME-Version: 1.0\n"
@@ -12,25 +12,91 @@ msgstr ""
 
 msgid "gluon-config-mode:welcome"
 msgstr ""
-"Welcome the the setup wizard of your new Freifunk Duckburg node. "
-"Please fill out the following form and transmit it."
+"Welcome to the setup wizard of your new Freifunk Alpha Centauri node. Please "
+"fill out the following form and submit it."
+
+msgid "gluon-config-mode:domain"
+msgstr "Domain"
+
+msgid "gluon-config-mode:domain-select"
+msgstr ""
+"Here you have the possibility of selecting the mesh domain in which your node "
+"is placed. Please keep in mind that your router only connects with the nodes "
+"of the selected domain."
 
 msgid "gluon-config-mode:pubkey"
 msgstr ""
-"This is your Freifunk node's public key. The node won't be able to "
+"<p>This is your Freifunk node's public key. The node won't be able to "
 "connect to the mesh VPN until the key has been registered on the Freifunk "
-"Duckburg servers. "
-"To register the key send it together with your node's name (<em><%=hostname%></em>) to "
-"<a href=\"mailto:keys@entenhausen.freifunk.net\">keys@entenhausen.freifunk.net</a>."
+"servers. To register, send the key together with your node's name "
+"(<em><%=pcdata(hostname)%></em>) to "
+"<a href=\"mailto:keys@alpha-centauri.freifunk.net?subject="
+"<%= urlencode('Registration: ' .. hostname) %>&amp;body="
+"<%= urlencode('# ' .. hostname .. '\n# ' .. sysconfig.primary_mac .. '\nkey ') %>"
+"%22<%= pubkey %>%22;"
+"<%= urlencode('\n\nI have taken note that the contact I entered in the ') %>"
+"<%= urlencode('node is publicly available on the Internet and can be ') %>"
+"<%= urlencode('used by any services (e.g. the meshviewer map).') %>"
+"<%= urlencode('\n\nThanks, \n\n') %>"
+"\">keys@alpha-centauri.freifunk.net</a>. Of course, your e-mail address will "
+"be treated confidentially and will not be passed on.</p>"
+"<div class=\"the-key\">"
+" # <%= pcdata(hostname) %><br>"
+"<%= pubkey %>"
+"</div>"
+"<p>Your node <em><%= pcdata(hostname) %></em> is currently rebooting and will "
+"try to connect to other nearby Freifunk nodes via WLAN and to a VPN-gateway "
+"via your internet connection after the reboot is finished.</p>"
+"<p>Don't forget to plug the network cable from the LAN port to the WAN port."
+"</p>"
 
+msgid "gluon-config-mode:novpn"
+msgstr ""
+"<p>You have selected <strong>not</strong> to use the mesh VPN. "
+"Your node will only be able to connect to the Freifunk network if other nodes "
+"in reach already have a connection.</p>"
+"<p>Please send an e-mail with the name of your node "
+"(<em><%=pcdata(hostname)%></em>) and some additional information to "
+"<a href=\"mailto:kontakt@alpha-centauri.freifunk.net?subject="
+"<%= urlencode('Registration: ' .. hostname) %>&amp;body="
+"<%= urlencode('# ' .. hostname .. '\n# ' .. sysconfig.primary_mac .. '\nkey ') %>"
+"%22<%= pubkey %>%22;"
+"<%= urlencode('\n\nI have taken note that the contact I entered in the ') %>"
+"<%= urlencode('node is publicly available on the Internet and can be ') %>"
+"<%= urlencode('used by any services (e.g. the meshviewer map).') %>"
+"<%= urlencode('\n\nThanks, \n\n') %>"
+"\">kontakt@alpha-centauri.freifunk.net</a>. Of course, your e-mail address will "
+"be treated confidentially and will not be passed on.</p>"
+"<p>Your node <em><%= pcdata(hostname) %></em> is currently rebooting and will "
+"try to connect to other nearby Freifunk nodes after that.</p>"
 
 msgid "gluon-config-mode:reboot"
 msgstr ""
-"<p>The node is currently rebooting and will try to connect to other "
-"nearby Freifunk nodes  after that. "
-"Your can find lots of information on the Freifunk Duckburg community on "
-"<a href=\"https://entenhausen.freifunk.net/\">our homepage</a>.</p>"
+"<p>For more information about the Freifunk community on Alpha Centauri, have a "
+"look at <a href=\"https://alpha-centauri.freifunk.net/\" target=\"_blank\">our "
+"homepage</a>.</p>"
 "<p>To get back to this configuration interface, press the reset button for "
-"3 seconds during normal operation. The device will then reboot into config "
-"mode.</p>"
-"<p>Have fun with your node and exploring the Freifunk network!</p>"
+"about 10 seconds during normal operation. The device will then reboot into "
+"config mode.</p>"
+"<p>Have fun with your node and exploring of the Freifunk network!</p>"
+
+# Leave empty to use the default text, which can be found in:
+# package/gluon-config-mode-hostname/i18n/
+msgid "gluon-config-mode:hostname-help"
+msgstr ""
+
+# Leave empty to use the default text, which can be found in:
+# package/gluon-config-mode-geo-location/i18n/
+msgid "gluon-config-mode:geo-location-help"
+msgstr ""
+
+msgid "gluon-config-mode:altitude-label"
+msgstr ""
+
+# Leave empty to use the default text, which can be found in:
+# package/gluon-config-mode-contact-info/i18n/
+msgid "gluon-config-mode:contact-help"
+msgstr ""
+
+msgid "gluon-config-mode:contact-note"
+msgstr ""

docs/site-example/i18n/fr.po

+msgid ""
+msgstr ""
+"Content-Type: text/plain; charset=UTF-8\n"
+"Project-Id-Version: PACKAGE VERSION\n"
+"PO-Revision-Date: 2015-08-06 20:28+0100\n"
+"Last-Translator: Tobias Bernot <tqbs@airmail.cc>\n"
+"Language-Team: French\n"
+"Language: fr\n"
+"MIME-Version: 1.0\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+msgid "gluon-config-mode:welcome"
+msgstr ""
+"Bienvenue dans l'assistant de configuration pour votre nouveau nœud "
+"Freifunk. Remplissez le formulaire suivant en fonction de vos besoins "
+"et enregistrez le."
+
+msgid "gluon-config-mode:domain"
+msgstr "Domaine"
+
+msgid "gluon-config-mode:domain-select"
+msgstr "Ici, vous avez la possibilité de sélectionner le domaine dans lequel "
+"se trouve votre nœud. N'oubliez pas que votre nœud ne peut se connecter "
+"qu'aux nœuds du domaine sélectionné."
+
+msgid "gluon-config-mode:pubkey"
+msgstr ""
+"<p>Ceci est la clé publique de votre nœud Freifunk. Seulment après que la clé "
+"soit entrée sur les serveurs de votre groupe de Freifunk votre nœud pourra se "
+"connecter sur les serveur Mesh-VPN de votre groupe Freifunk. Veuillez envoyer "
+"la clé avec le nom de votre nœud "
+"(<em><%=pcdata(hostname)%></em>) à "
+"<a href=\"mailto:keys@alpha-centauri.freifunk.net?"
+"subject=<%= urlencode('Enregistrement: ' .. hostname) %>&amp;"
+"body=<%= urlencode('# ' .. hostname .. '\n' .. pubkey) %>\">keys@alpha-centauri.freifunk.net</a>."
+"</p>"
+"<div class=\"the-key\">"
+" # <%= pcdata(hostname) %><br>"
+"<%= pubkey %>"
+"</div>"
+
+msgid "gluon-config-mode:novpn"
+msgstr ""
+"<p>Vous avez choisi de <strong>ne pas utiliser</strong> "
+"le réseau VPN. Votre nœud ne pourra se connecter au réseau Freifunk que si "
+"d'autres nœuds à portée ont déjà une connexion.</p>"
+
+msgid "gluon-config-mode:reboot"
+msgstr ""
+"<p>Votre nœud <em><%= pcdata(hostname) %></em> es en train de redémarrer et "
+"va ensuite éssayer de se connecter avec les autres nœuds du réseau Freifunk "
+"Vous pourrez trouver plus d'informations sur votre groupe Freifunk sur la page "
+"<a href=\"https://alpha-centauri.freifunk.net/\" target=\"_blank\"> de ton "
+"groupe </a>.</p>"
+"<p> Pour retrouver cette page de configuration veuillier appuyez pendant le "
+"fonctionement normal pendant 3 Secondes sur le bouton reset. L'appareil va "
+"ensuite redémarer en mode configuration.</p>"
+"<p>Profitez votre de nœud et amusez vous à découvrir le réseau Freifunk!</p>"
+
+# Leave empty to use the default text, which can be found in:
+# package/gluon-config-mode-hostname/i18n/
+msgid "gluon-config-mode:hostname-help"
+msgstr ""
+
+# Leave empty to use the default text, which can be found in:
+# package/gluon-config-mode-geo-location/i18n/
+msgid "gluon-config-mode:geo-location-help"
+msgstr ""
+
+msgid "gluon-config-mode:altitude-label"
+msgstr ""
+
+# Leave empty to use the default text, which can be found in:
+# package/gluon-config-mode-contact-info/i18n/
+msgid "gluon-config-mode:contact-help"
+msgstr ""
+
+msgid "gluon-config-mode:contact-note"
+msgstr ""

docs/site-example/i18n/gluon-site.pot

@@ -4,8 +4,32 @@ msgstr "Content-Type: text/plain; charset=UTF-8"
 msgid "gluon-config-mode:welcome"
 msgstr ""
 
+msgid "gluon-config-mode:domain"
+msgstr ""
+
+msgid "gluon-config-mode:domain-select"
+msgstr ""
+
 msgid "gluon-config-mode:pubkey"
 msgstr ""
 
+msgid "gluon-config-mode:novpn"
+msgstr ""
+
 msgid "gluon-config-mode:reboot"
 msgstr ""
+
+msgid "gluon-config-mode:hostname-help"
+msgstr ""
+
+msgid "gluon-config-mode:geo-location-help"
+msgstr ""
+
+msgid "gluon-config-mode:altitude-label"
+msgstr ""
+
+msgid "gluon-config-mode:contact-help"
+msgstr ""
+
+msgid "gluon-config-mode:contact-note"
+msgstr ""

docs/site-example/image-customization.lua

+packages {'iwinfo'}
+
+features {
+	'autoupdater',
+	'ebtables-filter-multicast',
+	'ebtables-filter-ra-dhcp',
+	'ebtables-limit-arp',
+	'mesh-batman-adv-15',
+	'mesh-vpn-fastd',
+	'respondd',
+	'status-page',
+	'web-advanced',
+	'web-wizard',
+}
+
+if not device_class('tiny') then
+	features {
+		'wireless-encryption-wpa3',
+	}
+end

docs/site-example/modules

@@ -12,7 +12,6 @@
 #		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

docs/site-example/site.conf

--- This is an example site configuration for Gluon v2015.1
+-- This is an example site configuration for Gluon v2023.2.5
 --
 -- Take a look at the documentation located at
--- http://gluon.readthedocs.org/ for details.
+-- https://gluon.readthedocs.io/ for details.
 --
--- This configuration will not work as it. You're required to make
+-- This configuration will not work as is. You're required to make
 -- community specific changes to it!
 {
   -- Used for generated hostnames, e.g. freifunk-abcdef123456. (optional)
   -- hostname_prefix = 'freifunk-',
 
   -- Name of the community.
-  site_name = 'Freifunk Entenhausen',
+  site_name = 'Freifunk Alpha Centauri',
 
   -- Shorthand of the community.
   site_code = 'ffxx',
 
-  -- Prefixes used within the mesh. Both are required.
+  -- 32 bytes of random data, encoded in hexadecimal
+  -- This data must be unique among all sites and domains!
+  -- 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',
 
   -- Timezone of your community.
-  -- See http://wiki.openwrt.org/doc/uci/system#time_zones
+  -- See https://openwrt.org/docs/guide-user/base-system/system_configuration#time_zones
   timezone = 'CET-1CEST,M3.5.0,M10.5.0/3',
 
   -- List of NTP servers in your community.
@@ -35,68 +42,84 @@
     -- Wireless channel.
     channel = 1,
 
-    -- ESSID used for client network.
-    ssid = 'entenhausen.freifunk.net',
+    -- ESSIDs used for client network.
+    ap = {
+      -- ssid = 'alpha-centauri.freifunk.net', (optional - SSID for open client network)
+      -- disabled = true, -- (optional)
 
-    -- 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',
+      -- Configuration for a backward compatible OWE network below.
+      -- owe_ssid = 'owe.alpha-centauri.freifunk.net', -- (optional - SSID for OWE client network)
+      -- owe_transition_mode = true, -- (optional - enables transition-mode - requires ssid as well as owe_ssid)
+    },
 
+    mesh = {
       -- Adjust these values!
-    mesh_ssid = 'xe:xx:xx:xx:xx:xx',  -- ESSID used for mesh
-    mesh_bssid = 'xe:xx:xx:xx:xx:xx', -- BSSID used for mesh
-
-    -- Bitrate used for multicast/broadcast packets.
-    mesh_mcast_rate = 12000,
-
-    -- (optional) mesh VLAN on 802.11 ad-hoc interface (1-4095)
-    -- mesh_vlan = 14,
-    -- client_disabled = true,
-    -- mesh_disabled = false,
+      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)
+    },
   },
 
   -- Wireless configuration for 5 GHz interfaces.
   -- This should be equal to the 2.4 GHz variant, except
-  -- for channel and htmode.
+  -- for channel.
   wifi5 = {
-    ssid = 'entenhausen.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,
-    -- mesh_vlan = 14,
-    -- client_disabled = true,
-    -- mesh_disabled = false,
+    outdoor_chanlist = '100-140',
+    ap = {
+      ssid = 'alpha-centauri.freifunk.net',
+    },
+    mesh = {
+      -- Adjust these values!
+      id = 'ueH3uXjdp',
+      mcast_rate = 12000,
+    },
+  },
+
+  mesh = {
+    vxlan = true,
+    batman_adv = {
+      routing_algo = 'BATMAN_IV',
+    },
   },
 
   -- 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
+    -- name = { 'nextnode.location.community.example.org', 'nextnode', 'nn' },
     ip4 = '10.xxx.0.xxx',
     ip6 = 'fdxx:xxxx:xxxx::xxxx',
-
-    -- anycast MAC of all nodes
-    mac = 'xe:xx:xx:xx:xx:xx',
   },
 
-  -- Refer to http://fastd.readthedocs.org/en/latest/ to better understand
+  -- Options specific to routing protocols (optional)
+  -- mesh = {
+    -- Options specific to the batman-adv routing protocol (optional)
+    -- batman_adv = {
+      -- Gateway selection class (optional)
+      -- The default class 20 is based on the link quality (TQ) only,
+      -- class 1 is calculated from both the TQ and the announced bandwidth
+      -- gw_sel_class = 1,
+    -- },
+  -- },
+
+  mesh_vpn = {
+    -- enabled = true,
+
+    fastd = {
+      -- Refer to https://fastd.readthedocs.io/en/latest/ to better understand
       -- what these options do.
-  fastd_mesh_vpn = {
+
       -- List of crypto-methods to use.
       methods = {'salsa2012+umac'},
-    -- enabled = true,
+      mtu = 1312,
       -- configurable = true,
+      -- syslog_level = 'warn',
 
-    mtu = 1426,
       groups = {
         backbone = {
           -- Limit number of connected peers to reduce bandwidth.
-        limit = 2,
+          limit = 1,
 
           -- List of peers.
           peers = {
@@ -128,8 +151,21 @@
       },
     },
 
+    bandwidth_limit = {
+      -- The bandwidth limit can be enabled by default here.
+      enabled = false,
+
+      -- Default upload limit (kbit/s).
+      egress = 200,
+
+      -- Default download limit (kbit/s).
+      ingress = 3000,
+    },
+  },
+
   autoupdater = {
-    -- Default branch. Don't forget to set GLUON_BRANCH when building!
+    -- Default branch (optional), can be overridden by setting GLUON_AUTOUPDATER_BRANCH when building.
+    -- Set GLUON_AUTOUPDATER_ENABLED to enable the autoupdater by default for newly installed nodes.
     branch = 'stable',
 
     -- List of branches. You may define multiple branches.
@@ -138,7 +174,15 @@
         name = 'stable',
 
         -- List of mirrors to fetch images from. IPv6 required!
-        mirrors = {'http://1.updates.services.ffhl/stable/sysupgrade'},
+        mirrors = {
+          'http://1.updates.example.org/stable/sysupgrade',
+
+          -- Requires the tls feature in image-customization.lua
+          -- 'https://2.updates.example.org/stable/sysupgrade',
+
+          -- Uses http or https depending on the tls feature in image-customization.lua
+          '//3.updates.example.org/stable/sysupgrade',
+        },
 
         -- Number of good signatures required.
         -- Have multiple maintainers sign your build and only
@@ -155,36 +199,4 @@
       },
     },
   },
-
-  -- Node roles
-  -- roles = {
-  --   default = 'node',
-  --   list = {
-  --     'node',
-  --     'test',
-  --     'backbone',
-  --     'service',
-  --   },
-  -- },
-
-  -- 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,
-    },
-  },
-
-  -- Skip setup mode (config mode) on first boot
-  -- setup_mode = {
-  --  skip = true,
-  -- },
 }

docs/site-example/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-15 \
-	gluon-alfred \
-	gluon-announced \
-	gluon-autoupdater \
-	gluon-config-mode-autoupdater \
-	gluon-config-mode-contact-info \
-	gluon-config-mode-core \
-	gluon-config-mode-geo-location \
-	gluon-config-mode-hostname \
-	gluon-config-mode-mesh-vpn \
-	gluon-ebtables-filter-multicast \
-	gluon-ebtables-filter-ra-dhcp \
-	gluon-luci-admin \
-	gluon-luci-autoupdater \
-	gluon-luci-portconfig \
-	gluon-luci-wifi-config \
-	gluon-next-node \
-	gluon-mesh-vpn-fastd \
-	gluon-radvd \
-	gluon-setup-mode \
-	gluon-status-page \
-	haveged \
-	iptables \
-	iwinfo
-
 ##	DEFAULT_GLUON_RELEASE
 #		version string to use for images
 #		gluon relies on
@@ -38,6 +8,7 @@ GLUON_SITE_PACKAGES := \
 
 DEFAULT_GLUON_RELEASE := 0.6+exp$(shell date '+%Y%m%d')
 
+# Variables set with ?= can be overwritten from the command line
 
 ##	GLUON_RELEASE
 #		call make with custom GLUON_RELEASE flag, to use your own release version scheme.
@@ -46,11 +17,13 @@ DEFAULT_GLUON_RELEASE := 0.6+exp$(shell date '+%Y%m%d')
 #		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
 
+# Region code required for some images; supported values: us eu
+GLUON_REGION ?= eu
+
 # Languages to include
 GLUON_LANGS ?= en de

docs/user/faq.rst

 Frequently Asked Questions
 ==========================
 
+.. _faq-hardware:
+
+What hardware is supported?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A table with hardware supported by Gluon can be found on the `OpenWrt Wiki`_.
+If you want to find out if your device can potentially be supported
+have a look at :doc:`../dev/hardware` for detailed hardware requirements.
+
+.. _OpenWrt Wiki: https://openwrt.org/toh/views/toh_gluon_supported
+
+.. _faq-dns:
+
+Why does DNS not work on the nodes?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Gluon nodes will ignore the DNS server on the WAN port for everything except
+the mesh VPN, which can lead to confusion.
+
+All normal services on the nodes exclusively use the DNS server on the mesh
+interface. This DNS server must be announced in router advertisements (using
+*radvd* or a similar software) from one or more central servers in meshes based
+on *batman-adv*. If your mesh does not have global IPv6 connectivity, you can setup
+your *radvd* not to announce a default route by setting the *default lifetime* to 0;
+in this case, the *radvd* is only used to announce the DNS server.
+
+.. _faq-lost-settings:
+
+Which settings are retained or migrated upon an update?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Gluon provides a :doc:`../dev/web/config-mode`, which allows the configuration via webinterface.
+Under the hood it uses UCI and sets options according to the users input.
+
+There's a recurring misconception that all UCI settings are retained and migrated across
+updates unconditionally. A settings presence does not imply this on its own.
+
+Only if a setting is either configurable via the setupmode, or explicitly referenced
+in this documentation - the wiki or other inofficial places do not count - it is supposed to
+survive the update process.
+
+All other options may be overridden, might disappear or lose functionality after a firmware update or already
+after calling gluon-reconfigure.
+
+.. _faq-gluon-preserve:
+
+How can I retain options upon updates anyway?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+For settings in the sections *network* and *system*, the option *gluon_preserve* can be set to true
+in order to preserve the sections. However, this is still at a high risk and may result in broken setups.
+
+There are two conditions that must hold:
+
+- The preserved section must not already exist after OpenWrt's and
+  Gluon's setup scripts ran. Modifying existing sections is currently
+  unsupported.
+- Preserved sections must be named, so it can be detected whether a
+  section conflicts with a preexisting one.
+
+Furthermore, this merely ensures the existence, not the functionality of a UCI setting after the update.