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