From 9168107f13871584ef4a7c48898e261568376487 Mon Sep 17 00:00:00 2001 From: Matthias Schiffer Date: Mon, 7 Aug 2017 21:37:58 +0200 Subject: [PATCH] docs: import v2017.1.2 release notes --- README.md | 2 +- docs/index.rst | 1 + docs/releases/v2017.1.2.rst | 84 +++++++++++++++++++++++++++++++++++ docs/user/getting_started.rst | 4 +- 4 files changed, 88 insertions(+), 3 deletions(-) create mode 100644 docs/releases/v2017.1.2.rst diff --git a/README.md b/README.md index 2845fc7a..d015362b 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ the future development of Gluon. Please refrain from using the `master` 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 v2017.1.1 && make update`. +and switch to one by running `git checkout v2017.1.2 && 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 *will break* eventually. diff --git a/docs/index.rst b/docs/index.rst index d36a5d6e..97d6b09d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -66,6 +66,7 @@ Several Freifunk communities in Germany use Gluon as the foundation of their Fre :caption: Releases :maxdepth: 1 + releases/v2017.1.2 releases/v2017.1.1 releases/v2017.1 releases/v2016.2.7 diff --git a/docs/releases/v2017.1.2.rst b/docs/releases/v2017.1.2.rst new file mode 100644 index 00000000..eac4ddc2 --- /dev/null +++ b/docs/releases/v2017.1.2.rst @@ -0,0 +1,84 @@ +Gluon 2017.1.2 +============== + +New features +~~~~~~~~~~~~ + +* Preserve *gw_mode* on sysupgrades (`#1196 `_) + + When a Gluon node is used as uplink (for example by connecting it to a router with + a DHCP server directly, instead of using non-Gluon servers for the internet uplink), + the *gw_mode* must be set to *server* on that node. The changed *gw_mode* is now + preserved on upgrades. + +* Allow configuring the batman-adv routing algorithm (*BATMAN IV* or *BATMAN V*) + in *site.conf* (`#1185 `_) + + *BATMAN V* still hasn't received extensive testing (and is incompatible with *BATMAN IV*). + This new option allows to set up *BATMAN V*-based test meshes. If unset, the routing + algorithm will default to *BATMAN IV*. + + Configuration: + + .. code-block:: lua + + mesh = { + batman_adv = { + routing_algo = 'BATMAN_V' + } + } + +* New *show-release* Make target + + The command ``make show-release`` can be used to print the release number + defined by *GLUON_RELEASE* to the standard output. This can be useful for build scripts + when a ``$(shell ...)`` expression is used in *site.mk* to generate the release + number. + +Bugfixes +~~~~~~~~ + +* The image build code used for some devices has been fixed, solving multiple + issues (`#1193 `_) + + Problems caused by this issue include: + + - sysupgrade rejecting Allnet images + - OpenMesh devices losing their configuration on upgrades + + This is a regression introduced in Gluon v2017.1. + +* Improve sysupgrade error handling (`#1160 `_) + + If for some reason processes don't react to SIGKILL (usually because of a kernel bug), + a node could hang forever in sysupgrade, requiring a power cycle. This has been + fixed, triggering a reboot instead. + +* Also display *gluon-config-mode:novpn* message when Tunneldigger is installed, but disabled + (`#1172 `_) + + It was only displayed on nodes with fastd before. + +* Fix migration of enabled/disabled state between fastd and Tunneldigger + (`#1187 `_) + +Known issues +~~~~~~~~~~~~ + +* Default TX power on many Ubiquiti devices is too high, correct offsets are unknown (`#94 `_) + + Reducing the TX power in the Advanced Settings is recommended. + +* The MAC address of the WAN interface is modified even when Mesh-on-WAN is disabled (`#496 `_) + + This may lead to issues in environments where a fixed MAC address is expected (like VMware when promicious mode is disallowed). + +* Inconsistent respondd API (`#522 `_) + + The current API is inconsistent and will be replaced eventually. The old API will still be supported for a while. + +* Sporadic segfaults of busybox (ash) when running shell scripts on ar71xx + (`#1157 `_) + + The workaround added in Gluon v2017.1.1 has greatly reduced the frequency of + segfaults, but did not make them disappear completely. diff --git a/docs/user/getting_started.rst b/docs/user/getting_started.rst index dc158efa..9c73c50f 100644 --- a/docs/user/getting_started.rst +++ b/docs/user/getting_started.rst @@ -8,7 +8,7 @@ Gluon's releases are managed using `Git tags`_. If you are just getting started with Gluon we recommend to use the latest stable release of Gluon. Take a look at the `list of gluon releases`_ and notice the latest release, -e.g. *v2017.1.1*. Always get Gluon using git and don't try to download it +e.g. *v2017.1.2*. Always get Gluon using git and don't try to download it as a Zip archive as the archive will be missing version information. Please keep in mind that there is no "default Gluon" build; a site configuration @@ -43,7 +43,7 @@ Building the images ------------------- To build Gluon, first check out the repository. Replace *RELEASE* with the -version you'd like to checkout, e.g. *v2017.1.1*. +version you'd like to checkout, e.g. *v2017.1.2*. ::