Skip to content

Commit 971c42b

Browse files
Bot Updating Templated Files
1 parent c610440 commit 971c42b

1 file changed

Lines changed: 18 additions & 14 deletions

File tree

README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -82,20 +82,28 @@ The web interface includes a terminal with passwordless `sudo` access. Any user
8282

8383
While not generally recommended, certain legacy environments specifically those with older hardware or outdated Linux distributions may require the deactivation of the standard seccomp profile to get containerized desktop software to run. This can be achieved by utilizing the `--security-opt seccomp=unconfined` parameter. It is critical to use this option only when absolutely necessary as it disables a key security layer of Docker, elevating the potential for container escape vulnerabilities.
8484

85-
### Hardware Acceleration & The Move to Wayland
85+
### FullColor 4:4:4 Encoding
8686

87-
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.
87+
If you notice blurry text, particularly light text on a black background, you can send true 8-bit color to the browser by enabling the **FullColor 4:4:4** encoding in the sidebar, or by using the jpeg encoding mode.
8888

89-
**Important:** GPU acceleration support for X11 is being deprecated. Future development for hardware acceleration will focus entirely on the Wayland stack.
89+
**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.
9090

91-
To enable Wayland mode, set the following environment variable:
91+
### Hardware Acceleration & Wayland
9292

93-
* `-e PIXELFLUX_WAYLAND=true`
93+
We have transitioned our desktop containers from X11 to a modern Wayland stack, which is now the default.
9494

95-
**Why use Wayland?**
95+
**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.
96+
97+
**Important:** GPU acceleration support for X11 is deprecated. Future development for hardware acceleration is focused entirely on the Wayland stack.
98+
99+
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:
100+
101+
* `-e PIXELFLUX_WAYLAND=false`
102+
103+
**Why Wayland?**
96104

97105
* **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.
98-
* **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.
106+
* **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.
99107

100108
#### GPU Configuration
101109

@@ -126,12 +134,8 @@ For Intel and AMD GPUs.
126134
127135
##### Nvidia (Proprietary Drivers)
128136
129-
**Note: Nvidia support is currently considered experimental, driver changes can break it at any time.**
130-
131137
**Note: Nvidia support is not available for Alpine-based images.**
132138
133-
**Note: Nvidia frames have issues with hardware decoders in Chromium browsers you need to navigate to `chrome://flags/#disable-accelerated-video-decode` and toggle it to `Disabled` for smooth playback**
134-
135139
**Prerequisites:**
136140
137141
1. **Driver:** Proprietary drivers **580 or higher** are required. **Crucially, you should install the driver using the `.run` file downloaded directly from the Nvidia website.**
@@ -203,7 +207,7 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
203207

204208
| Variable | Description |
205209
| :----: | --- |
206-
| 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 |
210+
| 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 |
207211
| SELKIES_DESKTOP | If set to true and in Wayland mode, a simple panel will be initialized with labwc |
208212
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default `3000` |
209213
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default `3001` |
@@ -258,14 +262,14 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
258262

259263
When using 3d acceleration via Nvidia DRM or DRI3 in X11 mode, it is important to clamp the virtual display to a reasonable max resolution to avoid memory exhaustion or poor performance.
260264

261-
* `-e MAX_RESOLUTION=3840x2160`
265+
* `-e MAX_RES=3840x2160`
262266

263267
This will set the total virtual framebuffer to 4K. By default, the virtual monitor is 16K. If you have performance issues in an accelerated X11 session, try clamping the resolution to 1080p and work up from there:
264268

265269
```bash
266270
-e SELKIES_MANUAL_WIDTH=1920
267271
-e SELKIES_MANUAL_HEIGHT=1080
268-
-e MAX_RESOLUTION=1920x1080
272+
-e MAX_RES=1920x1080
269273
```
270274

271275
</details>

0 commit comments

Comments
 (0)