Skip to content

Commit

Permalink
docs: add v2023.1 release notes
Browse files Browse the repository at this point in the history
Signed-off-by: David Bauer <[email protected]>
  • Loading branch information
blocktrron committed Aug 2, 2023
1 parent 58664bb commit 4489a8b
Show file tree
Hide file tree
Showing 2 changed files with 127 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/releases/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Release Notes
=============

.. toctree::
:caption: Gluon 2023.1
:maxdepth: 2

v2023.1

.. toctree::
:caption: Gluon 2022.1
:maxdepth: 2
Expand Down
121 changes: 121 additions & 0 deletions docs/releases/v2023.1.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
Gluon 2023.1
============

Important notes
---------------

Upgrades to v2022.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.


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.

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
WireGuard pendants whose public keys can be **separately** translated 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 are now preserved on upgrade when ``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.
- Fixed a bug in the MediaTek MT7621 NAND driver which led to devices end up in a bootlooping state
after initial installation.


Minor changes
-------------

- Images built for the ``x86`` targets are now natively bootable on
EFI systems without CSM or BIOS support modes.


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).

0 comments on commit 4489a8b

Please sign in to comment.