Skip to content

Commit 9899fc9

Browse files
authored
Merge pull request #398 from linuxserver/wayland-default
update wayland blob to reflect transition, add note on avx2 requirement
2 parents bde5f81 + 4323d48 commit 9899fc9

1 file changed

Lines changed: 10 additions & 8 deletions

File tree

  • ansible/roles/documentation/templates/README_SNIPPETS

ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{%- set selkies_variables -%}
22
| Variable | Description |
33
| :----: | --- |
4-
| PIXELFLUX_WAYLAND | **Experimental** If set to true the container will initialize in Wayland mode running [Smithay](https://github.com/Smithay/smithay) and Labwc while enabling zero copy encoding with a GPU |
4+
| PIXELFLUX_WAYLAND | If set to true the container will initialize in Wayland mode running [Smithay](https://github.com/Smithay/smithay) and Labwc while enabling zero copy encoding with a GPU |
55
| SELKIES_DESKTOP | If set to true and in Wayland mode, a simple panel will be initialized with labwc |
66
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default `{% if external_http_port is defined %}{{ external_http_port }}{% else %}3000{% endif %}` |
77
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default `{% if external_https_port is defined %}{{ external_https_port }}{% else %}3001{% endif %}` |
@@ -179,20 +179,22 @@ If you notice blurry text, particularly light text on a black background, you ca
179179

180180
**Note on Hardware Acceleration:** Currently, only Nvidia GPUs support encoding this color profile in **Zero Copy** mode. If FullColor 4:4:4 is enabled on Intel or AMD GPUs, the system will fall back to CPU encoding. This forces the CPU to read the pixels back from the GPU, which will cause a significant decrease in performance.
181181

182-
### Hardware Acceleration & The Move to Wayland
182+
### Hardware Acceleration & Wayland
183183

184-
We are currently transitioning our desktop containers from X11 to Wayland. While X11 is still the default, we strongly encourage users to test the new Wayland mode.
184+
We have transitioned our desktop containers from X11 to a modern Wayland stack, which is now the default.
185185

186-
**Important:** GPU acceleration support for X11 is being deprecated. Future development for hardware acceleration will focus entirely on the Wayland stack.
186+
**Hardware Fallback Note:** On `x86_64` architecture, the Wayland stack requires a processor with AVX2 support (Intel Haswell generation or newer). If your processor lacks AVX2 (such as older CPUs or certain low-end Celerons), the container will automatically fall back to X11.
187187

188-
To enable Wayland mode, set the following environment variable:
188+
**Important:** GPU acceleration support for X11 is deprecated. Future development for hardware acceleration is focused entirely on the Wayland stack.
189189

190-
* `-e PIXELFLUX_WAYLAND=true`
190+
If you experience compatibility issues and need to manually disable Wayland (forcing a fallback to X11), you can do so by setting the following environment variable:
191191

192-
**Why use Wayland?**
192+
* `-e PIXELFLUX_WAYLAND=false`
193+
194+
**Why Wayland?**
193195

194196
* **Zero Copy Encoding:** When configured correctly with a GPU, the frame is rendered and encoded on the video card without ever being copied to the system RAM. This drastically lowers CPU usage and latency.
195-
* **Modern Stack:** Single-application containers utilize **Labwc** (replacing Openbox) and full desktop containers use **KDE Plasma Wayland**, providing a more modern and secure compositing environment while retaining the same user experience.
197+
* **Modern Stack:** Single-application containers utilize **Labwc** (replacing Openbox) and full desktop containers use **KDE Plasma Wayland**, providing a more modern, performant, and secure compositing environment while retaining the same user experience.
196198

197199
#### GPU Configuration
198200

0 commit comments

Comments
 (0)