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
@@ -96,19 +96,22 @@ We are currently transitioning our desktop containers from X11 to Wayland. While
96
96
**Important:** GPU acceleration support for X11 is being deprecated. Future development for hardware acceleration will focus entirely on the Wayland stack.
97
97
98
98
To enable Wayland mode, set the following environment variable:
99
-
*`-e PIXELFLUX_WAYLAND=true`
99
+
100
+
*`-e PIXELFLUX_WAYLAND=true`
100
101
101
102
**Why use Wayland?**
102
-
***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.
103
-
***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.
103
+
104
+
***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.
105
+
***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.
104
106
105
107
#### GPU Configuration
106
108
107
109
To use hardware acceleration in Wayland mode, we distinguish between the card used for **Rendering** (3D apps/Desktops) and **Encoding** (Video Stream).
108
110
109
111
**Configuration Variables:**
110
-
*`DRINODE`: The path to the GPU used for **Rendering** (EGL).
111
-
*`DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
112
+
113
+
*`DRINODE`: The path to the GPU used for **Rendering** (EGL).
114
+
*`DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
112
115
113
116
If both variables point to the same device, the container will automatically enable **Zero Copy** encoding, significantly reducing CPU usage and latency.
114
117
@@ -131,10 +134,12 @@ For Intel and AMD GPUs.
131
134
**Note: Nvidia support is not available for Alpine-based images.**
132
135
133
136
**Prerequisites:**
134
-
1. **Driver:** Proprietary drivers **580 or higher** are required.
135
-
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
136
-
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
137
-
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
137
+
138
+
1. **Driver:** Proprietary drivers **580 or higher** are required.
139
+
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
140
+
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
141
+
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
@@ -166,10 +172,9 @@ This container is compatible with [SealSkin](https://sealskin.app).
166
172
167
173
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.
168
174
169
-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
170
-
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
171
-
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
172
-
175
+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
176
+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
177
+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
173
178
174
179
### Options in all Selkies-based GUI containers
175
180
@@ -205,12 +210,13 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
205
210
| WATERMARK_LOCATION | Where to paint the image over the stream integer options below |
206
211
207
212
**`WATERMARK_LOCATION` Options:**
208
-
- **1**: Top Left
209
-
- **2**: Top Right
210
-
- **3**: Bottom Left
211
-
- **4**: Bottom Right
212
-
- **5**: Centered
213
-
- **6**: Animated
213
+
214
+
* **1**: Top Left
215
+
* **2**: Top Right
216
+
* **3**: Bottom Left
217
+
* **4**: Bottom Right
218
+
* **5**: Centered
219
+
* **6**: Animated
214
220
215
221
</details>
216
222
@@ -236,7 +242,7 @@ When using 3d acceleration via Nvidia DRM or DRI3 in X11 mode, it is important t
236
242
237
243
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:
238
244
239
-
```
245
+
```bash
240
246
-e SELKIES_MANUAL_WIDTH=1920
241
247
-e SELKIES_MANUAL_HEIGHT=1080
242
248
-e MAX_RESOLUTION=1920x1080
@@ -248,16 +254,16 @@ This will set the total virtual framebuffer to 4K. By default, the virtual monit
248
254
249
255
To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example:
0 commit comments