Add known issues and some more review feedback

reference/release-notes/1.23.1.md

@@ -11,34 +11,31 @@ Please see {ref}`ref-component-versions` for a list of updated components.
 
 ## Requirements
 
-See {ref}`ref-requirements` for detailed requirements to run Anbox Cloud 1.23.1.
+See the {ref}`ref-requirements` for details on general and deployment specific requirements to run Anbox Cloud.
 
 ## New features & improvements
 
-### Anbox Cloud Appliance (epoch=1)
+### Anbox Cloud Appliance
 
-* You can now change the appliance network configuration using `anbox-cloud-appliance config set`. You can change the public IP address and location of the appliance.<!--AC-2727-->.
-* You can now configure the [CORS settings](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) for those API endpoints that the appliance reverse proxy passes to the Anbox Stream Gateway. You can set the following using the `anbox-cloud-appliance config set` command:<!--AC-2732-->
+* You can now set the following appliance network configuration using `anbox-cloud-appliance config set`:<!--AC-2732-->
   - The network's public IP address (`network.public_address`)
-  - The network's DNS name (`network.location`)
+  - The network's DNS name (`network.location`)<!--AC-2727-->.
+* You can now configure the [CORS settings](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) for those API endpoints that the appliance reverse proxy passes to the Anbox Stream Gateway. You can set the following using the `anbox-cloud-appliance config set` command:<!--AC-2732-->
   - The [HTTP origin](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin) (`core.https_allowed_origin`)
   - List of allowed HTTP headers (`core.https_allowed_headers`)
   - List of allowed HTTP methods (`core.https_allowed_methods`)
 * You can skip setting up coturn when initialising the appliance and can configure a custom STUN server.<!--AC-2719-->
 * The [`prepare-node-script`](prepare-node-script.md) command is extended to support systems with an already installed NVIDIA driver. <!--AC-2714-->
+* You can now set up a custom identity provider for the dashboard by configuring an OpenID Connect provider through the preseed configuration when initialising the appliance.
 
 ### Streaming
 
 * With the 1.23.0 release, the functionalities of the *Instances* page and the *Sessions* page on the web dashboard were merged. For debugging purposes, viewing a list of available sessions can be really useful. With the 1.23.1 release, you can list all available sessions using the `anbox-stream-gateway sessions list` command.<!--AC-2662-->
 * You can dynamically change the display density when joining an existing streaming session.<!--AC-2673-->
 
-### Dashboard
-
-* The micromatch dependency in the Anbox Cloud dashboard is updated to include an upstream fix for [CVE-2024-4067](https://github.com/advisories/GHSA-952p-6rrq-rcjv).<!--AC-2709-->
-
 ### VHAL
 
-* Starting with 1.23.0,the VNDK version required for building a custom VHAL is 34.<!--AC-2720-->
+* Starting with 1.23.0, the VNDK version required for building a custom VHAL is 34.<!--AC-2720-->
 
 ### Android vendor image
 
@@ -51,7 +48,54 @@ See {ref}`ref-requirements` for detailed requirements to run Anbox Cloud 1.23.1.
 
 ## Known issues
 
-< Add known issues here >
+* Since version 1.23.0, the Anbox WebRTC Data Proxy service starts on demand rather than at container startup. However, its startup time may take longer than expected, which can negatively impact the {ref}`out-of-band data exchange <sec-oob-data-version-2>` between the WebRTC server and client. This issue can be worked around by applying the following tweak in a [pre-start hook](https://anbox-cloud.io/docs/ref/hooks).
+
+  ```
+  #!/bin/sh -ex
+  if  [ "$CONTAINER_TYPE" = "regular" ]; then
+    exit 0
+  fi
+
+  DROP_IN_DIR=/etc/systemd/system/anbox-webrtc-data-proxy.service.d/
+  sudo mkdir -p "${DROP_IN_DIR}"
+  sudo tee "${DROP_IN_DIR}/override.conf" > /dev/null <<EOF
+  [Install]
+  WantedBy=multi-user.target
+  EOF
+
+  sudo systemctl daemon-reload
+  sudo systemctl enable anbox-webrtc-data-proxy
+  ```
+* For the Anbox Cloud Appliance deployment, after it is initialised, you may encounter the following error when creating an application or launching an instance:
+
+  ```
+  Failed to load kernel module ''anbox_sync'': Failed to run: modprobe -b anbox_sync: exit status 1 (modprobe: FATAL: Module anbox_sync not found in directory /lib/modules/x.x.x-xxxx-aws)'
+  ```
+  To resolve this issue, install the required package:
+
+      sudo apt install linux-headers-$(uname -r)
+
+  Then reinstall the `anbox-modules-dkms-123` package:
+
+      sudo apt install --reinstall anbox-modules-dkms-123
+
+  After completing these steps, you should be able to create an application or launch an instance normally. The issue will be fixed in the next patch release.
+
+## CVEs
+
+The Anbox Cloud 1.23.1 release includes fixes from the respective upstreams for the following CVEs:
+* [CVE-2024-4067](https://nvd.nist.gov/vuln/detail/CVE-2024-4067)
+* [CVE-2024-39338](https://nvd.nist.gov/vuln/detail/CVE-2024-39338)
+* [CVE-2024-32896](https://nvd.nist.gov/vuln/detail/CVE-2024-32896)
+* [CVE-2024-40650](https://nvd.nist.gov/vuln/detail/CVE-2024-40650)
+* [CVE-2024-40652](https://nvd.nist.gov/vuln/detail/cve-2024-40652)
+* [CVE-2024-40654](https://nvd.nist.gov/vuln/detail/CVE-2024-40654)
+* [CVE-2024-40655](https://nvd.nist.gov/vuln/detail/CVE-2024-40655)
+* [CVE-2024-40656](https://nvd.nist.gov/vuln/detail/CVE-2024-40656)
+* [CVE-2024-40657](https://nvd.nist.gov/vuln/detail/CVE-2024-40657)
+* [CVE-2024-40658](https://nvd.nist.gov/vuln/detail/CVE-2024-40658)
+* [CVE-2024-40659](https://nvd.nist.gov/vuln/detail/CVE-2024-40659)
+* [CVE-2024-40662](https://nvd.nist.gov/vuln/detail/CVE-2024-40662)
 
 ## Bug fixes
 

reference/release-notes/release-notes-template.md

@@ -11,7 +11,7 @@ Please see {ref}`ref-component-versions` for a list of updated components.
 
 ## Requirements
 
-See {ref}`ref-requirements` to run Anbox Cloud < version >.
+See the {ref}`ref-requirements` for details on general and deployment specific requirements to run Anbox Cloud.
 
 ## New features & improvements
 

reference/release-notes/release-notes.md

@@ -9,6 +9,7 @@ For instructions on how to update your Anbox Cloud deployment to later versions,
 
 | Release date   |  Release notes  |
 |----|----|
+| September 18 2024 | [Anbox Cloud 1.23.1](1.23.1.md) |
 | August 14 2024 | [Anbox Cloud 1.23.0](1.23.0.md) |
 | July 18 2024 | [Anbox Cloud 1.22.2](1.22.2.md) |
 | June 13 2024 | [Anbox Cloud 1.22.1](1.22.1.md) |
@@ -18,7 +19,7 @@ For instructions on how to update your Anbox Cloud deployment to later versions,
 
 The current minor release is **1.23.0** and the next one will be **1.24.0**.
 
-The target dates for upcoming releases are not final and could vary depending on various factors such as availability of Android security patches. The release notes link will be updated on the day of the release.
+The following target dates for upcoming releases are not final and could vary depending on various factors such as availability of Android security patches. The release notes link will be updated on the day of the release.
 
 | Target date | Version | Planned updates |
 |----|----|----|
@@ -60,19 +61,14 @@ Along with bug fixes and general improvements, Anbox Cloud 1.23.x includes:
 * Reworked charms that install snaps from the snap store
 * Android security updates
 
-## Older releases
+<details><summary>Click to view earlier releases' notes</summary>
 
-## 2024
 |  Release date  |  Release notes  |
 |----|----|
 | January 17 2024 | [Anbox Cloud 1.20.2](1.20.2.md) |
 | February 14 2024 | [Anbox Cloud 1.21.0](1.21.0.md) |
 | March 13 2024 | [Anbox Cloud 1.21.1](1.21.1.md) |
 | April 18 2024 | [Anbox Cloud 1.21.2](1.21.2.md) |
-
-### 2023
-|  Release date  |  Release notes  |
-|----|----|
 |December 13 2023| [Anbox Cloud 1.20.1](1.20.1.md) |
 |November 16 2023 | [Anbox Cloud 1.20.0](1.20.0.md) |
 |October 11 2023|[Anbox Cloud 1.19.2](1.19.2.md)|
@@ -88,10 +84,6 @@ Along with bug fixes and general improvements, Anbox Cloud 1.23.x includes:
 |January 24 2023|[Anbox Cloud 1.16.4](1.16.4.md)|
 |January 17 2023|[Anbox Cloud 1.16.3](1.16.3.md)|
 |January 12 2023|[Anbox Cloud 1.16.2](1.16.2.md)|
-
-### 2022
-|  Release date  |  Release notes  |
-|----|----|
 |December 14 2022|[Anbox Cloud 1.16.1](1.16.1.md)|
 |November 16 2022|[Anbox Cloud 1.16.0](1.16.0.md)|
 |October 20 2022|[Anbox Cloud 1.15.3](1.15.3.md)|
@@ -108,10 +100,6 @@ Along with bug fixes and general improvements, Anbox Cloud 1.23.x includes:
 |January 28 2022|[Anbox Cloud 1.12.5](1.12.5.md)|
 |January 21 2022|[Anbox Cloud 1.12.4](1.12.4.md)|
 |January 20 2022|[Anbox Cloud 1.12.3](1.12.3.md)|
-
-### 2021
-|  Release date  |  Release notes  |
-|----|----|
 |December 16 2021|[Anbox Cloud 1.12.2](1.12.2.md)|
 |November 30 2021|[Anbox Cloud 1.12.1](1.12.1.md)|
 |November 16 2021|[Anbox Cloud 1.12.0](1.12.0.md)|
@@ -131,10 +119,6 @@ Along with bug fixes and general improvements, Anbox Cloud 1.23.x includes:
 |March 4 2021|[Anbox Cloud 1.9.1](1.9.1.md)|
 |February 10 2021|[Anbox Cloud 1.9.0](1.9.0.md)|
 |January 19 2021|[Anbox Cloud 1.8.3](1.8.3.md)|
-
-### 2020
-|  Release date  |  Release notes  |
-|----|----|
 |December 17 2020|[Anbox Cloud 1.8.2](1.8.2.md)|
 |November 12 2020|[Anbox Cloud 1.8.1](1.8.1.md)|
 |November 4 2020|[Anbox Cloud 1.8.0](1.8.0.md)|
@@ -152,16 +136,13 @@ Along with bug fixes and general improvements, Anbox Cloud 1.23.x includes:
 |April 2020|[Anbox Cloud 1.5.0](1.5.0.md)|
 |March 2020|[Anbox Cloud 1.4.0](1.4.0.md)|
 |January 2020|[Anbox Cloud 1.3.3](1.3.3.md)|
-
-### 2019
 |October 2019|[Anbox Cloud 1.3.2](1.3.2.md)|
 |September 2019|[Anbox Cloud 1.3.1](1.3.1.md)|
 |August 2019|[Anbox Cloud 1.3.0](1.3.0.md)|
 |April 2019|[Anbox Cloud 1.2.1](1.2.1.md)|
 |April 2019|[Anbox Cloud 1.2.0](1.2.0.md)|
 |February 2019|[Anbox Cloud 1.1.1](1.1.1.md)|
 |January 2019|[Anbox Cloud 1.1.0](1.1.0.md)|
-
-### 2018
 |December 2018|[Anbox Cloud 1.0.1](1.0.1.md)|
 |November 2018|[Anbox Cloud 1.0.0](1.0.0.md)|
+</details>