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
+36-30Lines changed: 36 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -108,19 +108,22 @@ We are currently transitioning our desktop containers from X11 to Wayland. While
108
108
**Important:** GPU acceleration support for X11 is being deprecated. Future development for hardware acceleration will focus entirely on the Wayland stack.
109
109
110
110
To enable Wayland mode, set the following environment variable:
111
-
*`-e PIXELFLUX_WAYLAND=true`
111
+
112
+
*`-e PIXELFLUX_WAYLAND=true`
112
113
113
114
**Why use Wayland?**
114
-
***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.
115
-
***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.
115
+
116
+
***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.
117
+
***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.
116
118
117
119
#### GPU Configuration
118
120
119
121
To use hardware acceleration in Wayland mode, we distinguish between the card used for **Rendering** (3D apps/Desktops) and **Encoding** (Video Stream).
120
122
121
123
**Configuration Variables:**
122
-
*`DRINODE`: The path to the GPU used for **Rendering** (EGL).
123
-
*`DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
124
+
125
+
*`DRINODE`: The path to the GPU used for **Rendering** (EGL).
126
+
*`DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
124
127
125
128
If both variables point to the same device, the container will automatically enable **Zero Copy** encoding, significantly reducing CPU usage and latency.
126
129
@@ -145,10 +148,9 @@ This container is compatible with [SealSkin](https://sealskin.app).
145
148
146
149
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.
147
150
148
-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
149
-
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
150
-
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
151
-
151
+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
152
+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
153
+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
152
154
153
155
### Options in all Selkies-based GUI containers
154
156
@@ -184,12 +186,13 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
184
186
| WATERMARK_LOCATION | Where to paint the image over the stream integer options below |
185
187
186
188
**`WATERMARK_LOCATION` Options:**
187
-
- **1**: Top Left
188
-
- **2**: Top Right
189
-
- **3**: Bottom Left
190
-
- **4**: Bottom Right
191
-
- **5**: Centered
192
-
- **6**: Animated
189
+
190
+
* **1**: Top Left
191
+
* **2**: Top Right
192
+
* **3**: Bottom Left
193
+
* **4**: Bottom Right
194
+
* **5**: Centered
195
+
* **6**: Animated
193
196
194
197
</details>
195
198
@@ -215,7 +218,7 @@ When using 3d acceleration via Nvidia DRM or DRI3 in X11 mode, it is important t
215
218
216
219
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:
217
220
218
-
```
221
+
```bash
219
222
-e SELKIES_MANUAL_WIDTH=1920
220
223
-e SELKIES_MANUAL_HEIGHT=1080
221
224
-e MAX_RESOLUTION=1920x1080
@@ -227,16 +230,16 @@ This will set the total virtual framebuffer to 4K. By default, the virtual monit
227
230
228
231
To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example:
0 commit comments