You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+43-34Lines changed: 43 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -130,19 +130,22 @@ We are currently transitioning our desktop containers from X11 to Wayland. While
130
130
**Important:** GPU acceleration support for X11 is being deprecated. Future development for hardware acceleration will focus entirely on the Wayland stack.
131
131
132
132
To enable Wayland mode, set the following environment variable:
133
-
*`-e PIXELFLUX_WAYLAND=true`
133
+
134
+
*`-e PIXELFLUX_WAYLAND=true`
134
135
135
136
**Why use Wayland?**
136
-
***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.
137
-
***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.
137
+
138
+
***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.
139
+
***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.
138
140
139
141
#### GPU Configuration
140
142
141
143
To use hardware acceleration in Wayland mode, we distinguish between the card used for **Rendering** (3D apps/Desktops) and **Encoding** (Video Stream).
142
144
143
145
**Configuration Variables:**
144
-
*`DRINODE`: The path to the GPU used for **Rendering** (EGL).
145
-
*`DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
146
+
147
+
*`DRINODE`: The path to the GPU used for **Rendering** (EGL).
148
+
*`DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
146
149
147
150
If both variables point to the same device, the container will automatically enable **Zero Copy** encoding, significantly reducing CPU usage and latency.
148
151
@@ -165,10 +168,12 @@ For Intel and AMD GPUs.
165
168
**Note: Nvidia support is not available for Alpine-based images.**
166
169
167
170
**Prerequisites:**
168
-
1. **Driver:** Proprietary drivers **580 or higher** are required.
169
-
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
170
-
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
171
-
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
171
+
172
+
1. **Driver:** Proprietary drivers **580 or higher** are required.
173
+
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
174
+
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
175
+
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
@@ -200,10 +206,9 @@ This container is compatible with [SealSkin](https://sealskin.app).
200
206
201
207
SealSkin is a self-hosted, client-server platform that provides secure authentication and collaboration features while using a browser extension to intercept user actions such as clicking a link or downloading a file and redirect them to a secure, isolated application environment running on a remote server.
202
208
203
-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
204
-
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
205
-
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
206
-
209
+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
210
+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
211
+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
207
212
208
213
### Options in all Selkies-based GUI containers
209
214
@@ -239,12 +244,13 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
239
244
| WATERMARK_LOCATION | Where to paint the image over the stream integer options below |
240
245
241
246
**`WATERMARK_LOCATION` Options:**
242
-
- **1**: Top Left
243
-
- **2**: Top Right
244
-
- **3**: Bottom Left
245
-
- **4**: Bottom Right
246
-
- **5**: Centered
247
-
- **6**: Animated
247
+
248
+
* **1**: Top Left
249
+
* **2**: Top Right
250
+
* **3**: Bottom Left
251
+
* **4**: Bottom Right
252
+
* **5**: Centered
253
+
* **6**: Animated
248
254
249
255
</details>
250
256
@@ -270,7 +276,7 @@ When using 3d acceleration via Nvidia DRM or DRI3 in X11 mode, it is important t
270
276
271
277
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:
272
278
273
-
```
279
+
```bash
274
280
-e SELKIES_MANUAL_WIDTH=1920
275
281
-e SELKIES_MANUAL_HEIGHT=1080
276
282
-e MAX_RESOLUTION=1920x1080
@@ -282,16 +288,16 @@ This will set the total virtual framebuffer to 4K. By default, the virtual monit
282
288
283
289
To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example:
0 commit comments