freifunk-gluon · neocturne · Dec 25, 2024 · Jan 5, 2024 · Jan 21, 2024 · Feb 9, 2024
diff --git a/.github/workflows/build-container.yml b/.github/workflows/build-container.yml
@@ -4,7 +4,7 @@ name: Create and publish a Docker image
 on:
   push:
     branches:
-      - 'master'
+      - 'main'
       - 'next'
       - 'v202[0-9].[0-9].x'
     tags:

diff --git a/.github/workflows/build-gluon.yml b/.github/workflows/build-gluon.yml
@@ -2,7 +2,7 @@ name: Build Gluon
 on:
   push:
     branches:
-      - master
+      - main
       - next
       - 'v20[2-9][0-9].[0-9].x'
   pull_request:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -29,13 +29,13 @@ discuss there. We maintain a [list of rejected features] and we'd like to
 kindly ask you to review it first. In general, looking for duplicates may save
 you some time.
 
-Develop on top of master
-------------------------
+Develop on top of main
+----------------------
 If you are not developing something specific to a release (like for example a
 security fix to a feature that got completely rewritten since the release),
-develop it on top of the master branch. New features and even feature changes
+develop it on top of the main branch. New features and even feature changes
 aren't usually backported to old releases, but will be included in the upcoming
-release, which will be built from master.
+release, which will be built from main.
 
 Use descriptive commit messages
 -------------------------------

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-[![Build Gluon](https://github.com/freifunk-gluon/gluon/actions/workflows/build-gluon.yml/badge.svg?branch=master)](https://github.com/freifunk-gluon/gluon/actions/workflows/build-gluon.yml)
+[![Build Gluon](https://github.com/freifunk-gluon/gluon/actions/workflows/build-gluon.yml/badge.svg?branch=main)](https://github.com/freifunk-gluon/gluon/actions/workflows/build-gluon.yml)
 [![License](https://img.shields.io/badge/License-BSD%202--Clause-orange.svg)](https://opensource.org/license/bsd-2-clause/)
 [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/freifunk-gluon/gluon?sort=semver)](https://github.com/freifunk-gluon/gluon/releases/latest)
 
@@ -57,12 +57,12 @@ the future development of Gluon.
 
 ## Use a release!
 
-Please refrain from using the `master` branch for anything else but development purposes!
+Please refrain from using the `main` branch for anything else but development purposes!
 Use the most recent release instead. You can list all releases by running `git tag`
 and switch to one by running `git checkout v2023.2.4 && make update`.
 
 If you're using the autoupdater, do not autoupdate nodes with anything but releases.
-If you upgrade using random master commits the nodes *might break* eventually.
+If you upgrade using random main commits the nodes *might break* eventually.
 
 ## Mailinglist
 

diff --git a/docs/dev/uplink.rst b/docs/dev/uplink.rst
@@ -12,7 +12,7 @@ After the VPN connection has been established, the node should be able to reach
 the mesh's DNS servers and use these for all other name resolution.
 
 If a device has only a single Ethernet port (or group of ports), it will be
-used as an uplink port even when it is not labelled as "WAN" by default. This
+used as an uplink port even when it is not labeled as "WAN" by default. This
 behavior can be controlled using the ``interfaces.single.default_roles``
 site.conf option. It is also possible to alter the interface assignment after
 installation by modifying ``/etc/config/gluon`` and running

diff --git a/docs/dev/web/config-mode.rst b/docs/dev/web/config-mode.rst
@@ -11,18 +11,28 @@ gluon-config-mode-core
 gluon-config-mode-hostname
     Provides a hostname field.
 
-gluon-config-mode-autoupdater
+:doc:`gluon-config-mode-autoupdater <../../features/autoupdater>`
     Informs whether the autoupdater is enabled.
 
-gluon-config-mode-mesh-vpn
-    Allows toggling of mesh-vpn-fastd and setting a bandwidth limit.
+:doc:`gluon-config-mode-mesh-vpn <../../features/vpn>`
+    Allows toggling of installed mesh-vpn technology and setting a bandwidth limit.
 
 gluon-config-mode-geo-location
     Enables the user to set the geographical location of the node.
 
+:doc:`../../package/gluon-config-mode-geo-location-osm`
+    Lets the user click on a map to select the geographical location through a OSM map
+
 gluon-config-mode-contact-info
     Adds a field where the user can provide contact information.
 
+:doc:`../../package/gluon-web-cellular`
+    Adds advanced options to enter WWAN config.
+
+:doc:`../../package/gluon-web-network`
+    Adds option to configure used role on interfaces
+
+Most of the configuration options are described in :ref:`user-site-config_mode`
 
 Writing Config Mode modules
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/features/autoupdater.rst b/docs/features/autoupdater.rst
@@ -31,7 +31,7 @@ as otherwise the generated manifest will be incomplete.
 
 
 Manifest format
-------------------------
+---------------
 
 The manifest starts with a short header, followed by the list of firmwares and signatures.
 The header contains the following information:

diff --git a/docs/features/configmode.png b/docs/features/configmode.png
diff --git a/docs/features/configmode.rst b/docs/features/configmode.rst
@@ -38,3 +38,17 @@ Accessing Config Mode
 Config Mode can be accessed at http://192.168.1.1. The node will offer DHCP
 to clients. Should this fail, you may assign an IP from 192.168.1.0/24 to
 your computer manually.
+
+.. image:: configmode.png
+
+Advanced Config Options
+-----------------------
+
+Depending on the installed packages, the advanced config mode allows to configure packages further.
+
+* :doc:`gluon-web-wifi-config enable <wlan-configuration>` radios used for wifi and mesh as well as outdoor mode
+* :doc:`../package/gluon-web-network` allows to configure the used roles (uplink, mesh, client) on each interface
+* :doc:`../package/gluon-web-admin` allows to enter SSH keys or set a password in the `Remote access` section
+* :doc:`../package/gluon-web-cellular` allows to configure SIM card / WWAN settings on supported cellular devices
+
+The advanced config does also allow to upload a sysupgrade file to update the firmware to a different version.
diff --git a/docs/features/monitoring.rst b/docs/features/monitoring.rst
@@ -135,5 +135,5 @@ Adding a data provider
 ----------------------
 
 To add a provider, you need to install a shared object into ``/lib/gluon/respondd``.
-For more information, refer to the `respondd README <https://github.com/freifunk-gluon/packages/blob/master/net/respondd/README.md>`_
+For more information, refer to the `respondd README <https://github.com/freifunk-gluon/packages/blob/main/net/respondd/README.md>`_
 and have a look the existing providers.
diff --git a/docs/features/status-page.png b/docs/features/status-page.png
diff --git a/docs/features/status-page.rst b/docs/features/status-page.rst
@@ -0,0 +1,30 @@
+Status-Page
+===========
+
+When the feature ``gluon-status-page`` is enabled, Gluon nodes run a HTTP server with status information on all IP addresses of ``br-client``.
+This makes it possible to check information of the node in realtime.
+
+If the mesh protocol ``gluon-mesh-batman-adv`` is installed too, the package ``gluon-status-page-mesh-batman-adv`` is added too according to the :ref:`user-site-feature-flags`
+
+.. _status-page-example-picture:
+
+Example Picture
+---------------
+
+The left side of the status page contains Overview information.
+In the middle, current monitoring information abut the system, number of clients, radios, amount of traffic and connected mesh-vpn if any are shown.
+The right side of the Status-Page contains information about Neighbours to this node through :doc:`wired-mesh` as well as wireless mesh.
+
+.. image:: status-page.png
+
+Mesh Graphs
+-----------
+
+When wireless mesh is enabled, the mesh interfaces show realtime Graphs about the received signal strength (RSSI) in dBm.
+
+Neighbours
+----------
+
+The list of neighbours at first shows the mac-address of the neighbour it sees.
+The status-page sends a second request to ``http://[ipv6]/cgi-bin/dyn/neighbours-nodeinfo?mesh-vpn`` which triggers the lookup of neighbour information on the node itself.
+Through this, the actual nodenames of the neighbours are shown on the status-page as can be seen in the :ref:`status-page-example-picture`.
diff --git a/docs/features/tls.rst b/docs/features/tls.rst
@@ -0,0 +1,10 @@
+TLS support
+===========
+
+The generic TLS implementation which is currently used by OpenWRT can be installed or added as dependency through the package ``gluon-tls``.
+This removes the need for community packages to depend on a specific TLS implementation (like mbedtls, OpenSSL or WolfSSL).
+
+This package is an alias for the current TLS implementation used.
+To allow for easy usage of communicating through HTTPS from the node, typical Certificate Authorities (CAs) are included through the package ``ca-bundle`` .
+
+* Starting with OpenWRT 23.05, mbedtls is the default TLS layer - this is reflected in Gluon :ref:`v2023.2 <releases-v2023.2-minor-changes>`. HTTPS is used by default to communicate with OpenWRT opkg servers.
diff --git a/docs/features/vpn.rst b/docs/features/vpn.rst
@@ -176,7 +176,7 @@ gateway, tries to establish a connection, and if it fails, tries to connect
 to the next gateway. This approach has several advantages, such as load
 balancing VPN connection attempts and avoiding problems with offline gateways.
 More information about the wgpeerselector and its algorithm can be found
-`here <https://github.com/freifunk-gluon/packages/blob/master/net/wgpeerselector/README.md>`__.
+`here <https://github.com/freifunk-gluon/packages/blob/main/net/wgpeerselector/README.md>`__.
 
 On the gluon node both VXLAN and the wgpeerselector are well integrated and no
 explicit configuration of those tools is necessary, once the general WireGuard

diff --git a/docs/features/wlan-configuration.rst b/docs/features/wlan-configuration.rst
@@ -6,6 +6,13 @@ may include one or both of the two networks "client" (AP mode) and "mesh" (802.1
 mode), which can be used simultaneously. See :doc:`../user/site` for details on the
 configuration.
 
+Outdoor mode
+------------
+
+Configuring the node for outdoor use tunes the 5 GHz radio to a frequency and transmission power that conforms with the local regulatory requirements. 
+It also enables dynamic frequency selection (DFS; radar detection).
+At the same time, mesh functionality is disabled as it requires neighbouring nodes to stay on the same channel permanently.
+
 Upgrade behaviour
 -----------------
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -25,12 +25,14 @@ Several Freifunk communities in Germany use Gluon as the foundation of their Fre
   features/wlan-configuration
   features/private-wlan
   features/wired-mesh
+  features/tls
   features/dns-cache
   features/monitoring
   features/multidomain
   features/authorized-keys
   features/roles
   features/vpn
+  features/status-page
 
 .. toctree::
   :caption: Developer Documentation
@@ -62,6 +64,7 @@ Several Freifunk communities in Germany use Gluon as the foundation of their Fre
 
   package/gluon-client-bridge
   package/gluon-config-mode-domain-select
+  package/gluon-config-mode-geo-location-osm
   package/gluon-ebtables-filter-multicast
   package/gluon-ebtables-filter-ra-dhcp
   package/gluon-ebtables-limit-arp
@@ -73,6 +76,8 @@ Several Freifunk communities in Germany use Gluon as the foundation of their Fre
   package/gluon-radv-filterd
   package/gluon-scheduled-domain-switch
   package/gluon-web-admin
+  package/gluon-web-cellular
+  package/gluon-web-network
   package/gluon-web-logging
 
 .. toctree::
@@ -86,7 +91,7 @@ License
 
 See LICENCE_
 
-.. _LICENCE: https://github.com/freifunk-gluon/gluon/blob/master/LICENSE
+.. _LICENCE: https://github.com/freifunk-gluon/gluon/blob/main/LICENSE
 
 Indices and tables
 ==================

diff --git a/docs/package/gluon-config-mode-geo-location-osm.png b/docs/package/gluon-config-mode-geo-location-osm.png
diff --git a/docs/package/gluon-config-mode-geo-location-osm.rst b/docs/package/gluon-config-mode-geo-location-osm.rst
@@ -0,0 +1,11 @@
+.. _package-gluon-config-mode-geo-location-osm:
+
+gluon-config-mode-geo-location-osm
+==================================
+
+When package *gluon-config-mode-geo-location-osm* is enabled, the configuration wizard will
+try to load an OSM-based map to allow the user to specify the node location.
+Loading the map requires a working internet connection, for example via WLAN
+(while connected to the Gluon node via Ethernet).
+
+.. image:: gluon-config-mode-geo-location-osm.png
diff --git a/docs/package/gluon-mesh-wireless-sae.rst b/docs/package/gluon-mesh-wireless-sae.rst
@@ -34,7 +34,7 @@ wifi.mesh.sae_passphrase \: optional
   - sets a shared secret used to authenticate any two mesh nodes,
     crucial for private mesh networks
   - should not be set, if the shared secret is shared with untrusted
-    third parties, like in a publish mesh network
+    third parties, like in a public mesh network
   - defaults to an autogenerated value derived from ``prefix6``
 
 

diff --git a/docs/package/gluon-web-cellular.png b/docs/package/gluon-web-cellular.png
diff --git a/docs/package/gluon-web-cellular.rst b/docs/package/gluon-web-cellular.rst
@@ -0,0 +1,14 @@
+.. _package-gluon-web-cellular:
+
+gluon-web-cellular
+==================
+
+This package allows to configure WWAN for capable cellular devices.
+
+This works by creating an abstraction layer into Gluon which takes common options (SIM PIN / APN) and translates it to modem-specific settings based on the specific device using. 
+Doing so limits the use-case onto specific models (no LTE sticks possible) but provides a common interface.
+
+The WWAN is assigned the WAN firewall zone and wired WAN can still be used, however without prioritization.
+The traffic path is not configured to prefer one uplink source or the other.
+
+.. image:: gluon-web-cellular.png
diff --git a/docs/package/gluon-web-network.png b/docs/package/gluon-web-network.png
diff --git a/docs/package/gluon-web-network.rst b/docs/package/gluon-web-network.rst
@@ -0,0 +1,19 @@
+gluon-web-network
+=================
+
+The package *gluon-web-network* is part of :ref:`Feature Flag <user-site-feature-flags>` web-advanced.
+It allows to configure the network interfaces roles of the gluon node in config mode through checkboxes.
+
+It is a user-friendly way to configure what otherwise would need the :ref:`wired-mesh-commandline`.
+
+.. image:: gluon-web-network.png
+
+configuration options
+---------------------
+
+The following roles can be assigned to the interfaces:
+* `Uplink` - interface is used for WAN connection, which is used for the VPN if `mesh-vpn` checkbox is enabled in basic config mode
+* `Mesh` - interface is used for :doc:`../features/wired-mesh`. Using this on the WAN interface is also known as "Mesh-on-WAN"
+* `Client` - interface is used as client network - connected devices to this interface should get a working internet configuration through DHCP
+
+The roles `Uplink`/`Mesh` and `Client` are mutually exclusive.
diff --git a/docs/releases/index.rst b/docs/releases/index.rst
@@ -15,6 +15,7 @@ Release Notes
   :caption: Gluon 2023.1
   :maxdepth: 2
 
+  v2023.1.2
   v2023.1.1
   v2023.1
 

diff --git a/docs/releases/v2018.2.1.rst b/docs/releases/v2018.2.1.rst
@@ -47,34 +47,34 @@ Bugfixes
   This was visible on the status page and several map implementations.
   The new implementation uses netlink instead of parsing `/proc/net/if_inet6`.
 
-* Fixes a localization issue in gluon-config-mode-geo-location which 
+* Fixes a localization issue in gluon-config-mode-geo-location which
   resulted in a partial translation of the wizard's location section
   text. (`#1611 <https://github.com/freifunk-gluon/gluon/issues/1611>`_)
 
 * Fixes the display of the improved memory usage estimation in gluon-status-page
 
-  This change was actually already merged in time for v2018.2 but the 
+  This change was actually already merged in time for v2018.2 but the
   JavaScript was not rebuilt.
 
-* Fixes automatic updates for several devices by adding and updating 
+* Fixes automatic updates for several devices by adding and updating
   the autoupdater image names
 
   This affects the following devices:
 
-  * GL.iNet GL-AR150, 
+  * GL.iNet GL-AR150
   * GL.iNet GL-AR300M
   * GL.iNet GL-AR750
   * Raspberry Pi Model B+ Rev 1.2
 
-* Fixes the primary MAC address selection for Unifi AC 
+* Fixes the primary MAC address selection for Unifi AC
   Lite/Mesh/Pro/Mesh Pro (`#1629 <https://github.com/freifunk-gluon/gluon/issues/1629>`_)
 
 * Fixes low data rate selection for multicast and management frames on
   ath10k and ath10k-ct (`#1644 <https://github.com/freifunk-gluon/gluon/pull/1644>`_)
 
   A patchset has been backported that notifies these drivers of requested data rate changes
 
-* Fixes the data rate selection in ath10k and ath10k-ct when no 
+* Fixes the data rate selection in ath10k and ath10k-ct when no
   `mcast_rate` is configured (`#1657 <https://github.com/freifunk-gluon/gluon/pull/1657>`_)
 
   Previously a missing mcast_rate could result in broken 5 GHz connectivity
@@ -86,7 +86,7 @@ Scheduled domain switch
 ^^^^^^^^^^^^^^^^^^^^^^^
 
 Gluon has support for multiple domains since its v2018.1 release.
-The scheduled domain switch allows for reliable migrations between 
+The scheduled domain switch allows for reliable migrations between
 domains at a preconfigured time.
 This can be useful for communities that, among other things, plan to
 
@@ -98,7 +98,7 @@ Improved frequency band distribution of dual-band radios
 
 A new algorithm that improves the distribution of dual-band radios was
 added. They will now be evenly distributed between the 2.4 and 5 GHz
-band, with a preference towards 2.4 GHz. 
+band, with a preference towards 2.4 GHz.
 
 If a device has only a single dual-band radio, like the AVM FRITZ!WLAN
 Repeater 300E, it will be configured for 2.4 GHz.

diff --git a/docs/releases/v2019.1.rst b/docs/releases/v2019.1.rst
@@ -158,7 +158,7 @@ Bugfixes
   (`#1777 <https://github.com/freifunk-gluon/gluon/issues/1777>`_)
 
 * Fixes cross-domain leakage of respondd data by not joining the link-local multicast group on br-client. Nodes will
-  not be answering respondd queries on  ``[ff02::2:1001]:1001`` anymore. Respondd queries using that address must be
+  not be answering respondd queries on ``[ff02::2:1001]:1001`` anymore. Respondd queries using that address must be
   updated to the new address ``[ff05::2:1001]:1001``. (`#1701 <https://github.com/freifunk-gluon/gluon/issues/1701>`_)
 
 
@@ -176,7 +176,7 @@ site.mk
 * The variable ``DEVICES`` that controls which devices to build images for has been renamed to ``GLUON_DEVICES``.
   (`#1686 <https://github.com/freifunk-gluon/gluon/pull/1686>`_)
 
-* The ``gluon-radvd`` package is now included by default and can be dropped from *FEATURES* and  *GLUON_SITE_PACKGES*.
+* The ``gluon-radvd`` package is now included by default and can be dropped from *FEATURES* and *GLUON_SITE_PACKAGES*.
 
 site.conf
 =========

diff --git a/docs/releases/v2023.1.1.rst b/docs/releases/v2023.1.1.rst
@@ -12,14 +12,14 @@ 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 <http://ftp.avm.de/fritzbox/fritzbox-7530/other/recover/>`_)
+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>`_)
+- 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 a always failing watchdog script resulting in endless restarts (`#2987 <https://github.com/freifunk-gluon/gluon/pull/2987>`_)
+- 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>`_)
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,7 +4,7 @@ name: Create and publish a Docker image @@
     on:
       push:
         branches:
-          - 'master'
+          - 'main'
           - 'next'
           - 'v202[0-9].[0-9].x'
         tags:
@@ Expand Down @@