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
@@ -117,19 +117,22 @@ We are currently transitioning our desktop containers from X11 to Wayland. While
117
117
**Important:** GPU acceleration support for X11 is being deprecated. Future development for hardware acceleration will focus entirely on the Wayland stack.
118
118
119
119
To enable Wayland mode, set the following environment variable:
120
-
*`-e PIXELFLUX_WAYLAND=true`
120
+
121
+
*`-e PIXELFLUX_WAYLAND=true`
121
122
122
123
**Why use Wayland?**
123
-
***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.
124
-
***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.
124
+
125
+
***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.
126
+
***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.
125
127
126
128
#### GPU Configuration
127
129
128
130
To use hardware acceleration in Wayland mode, we distinguish between the card used for **Rendering** (3D apps/Desktops) and **Encoding** (Video Stream).
129
131
130
132
**Configuration Variables:**
131
-
*`DRINODE`: The path to the GPU used for **Rendering** (EGL).
132
-
*`DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
133
+
134
+
*`DRINODE`: The path to the GPU used for **Rendering** (EGL).
135
+
*`DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
133
136
134
137
If both variables point to the same device, the container will automatically enable **Zero Copy** encoding, significantly reducing CPU usage and latency.
135
138
@@ -152,10 +155,12 @@ For Intel and AMD GPUs.
152
155
**Note: Nvidia support is not available for Alpine-based images.**
153
156
154
157
**Prerequisites:**
155
-
1. **Driver:** Proprietary drivers **580 or higher** are required.
156
-
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
157
-
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
158
-
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
158
+
159
+
1. **Driver:** Proprietary drivers **580 or higher** are required.
160
+
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
161
+
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
162
+
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
@@ -187,10 +193,9 @@ This container is compatible with [SealSkin](https://sealskin.app).
187
193
188
194
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.
189
195
190
-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
191
-
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
192
-
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
193
-
196
+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
197
+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
198
+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
194
199
195
200
### Options in all Selkies-based GUI containers
196
201
@@ -226,12 +231,13 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
226
231
| WATERMARK_LOCATION | Where to paint the image over the stream integer options below |
227
232
228
233
**`WATERMARK_LOCATION` Options:**
229
-
- **1**: Top Left
230
-
- **2**: Top Right
231
-
- **3**: Bottom Left
232
-
- **4**: Bottom Right
233
-
- **5**: Centered
234
-
- **6**: Animated
234
+
235
+
* **1**: Top Left
236
+
* **2**: Top Right
237
+
* **3**: Bottom Left
238
+
* **4**: Bottom Right
239
+
* **5**: Centered
240
+
* **6**: Animated
235
241
236
242
</details>
237
243
@@ -257,7 +263,7 @@ When using 3d acceleration via Nvidia DRM or DRI3 in X11 mode, it is important t
257
263
258
264
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:
259
265
260
-
```
266
+
```bash
261
267
-e SELKIES_MANUAL_WIDTH=1920
262
268
-e SELKIES_MANUAL_HEIGHT=1080
263
269
-e MAX_RESOLUTION=1920x1080
@@ -269,16 +275,16 @@ This will set the total virtual framebuffer to 4K. By default, the virtual monit
269
275
270
276
To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example:
0 commit comments