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