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
@@ -85,19 +85,22 @@ We are currently transitioning our desktop containers from X11 to Wayland. While
85
85
**Important:** GPU acceleration support for X11 is being deprecated. Future development for hardware acceleration will focus entirely on the Wayland stack.
86
86
87
87
To enable Wayland mode, set the following environment variable:
88
-
*`-e PIXELFLUX_WAYLAND=true`
88
+
89
+
*`-e PIXELFLUX_WAYLAND=true`
89
90
90
91
**Why use Wayland?**
91
-
***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.
92
-
***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.
92
+
93
+
***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.
94
+
***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.
93
95
94
96
#### GPU Configuration
95
97
96
98
To use hardware acceleration in Wayland mode, we distinguish between the card used for **Rendering** (3D apps/Desktops) and **Encoding** (Video Stream).
97
99
98
100
**Configuration Variables:**
99
-
*`DRINODE`: The path to the GPU used for **Rendering** (EGL).
100
-
*`DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
101
+
102
+
*`DRINODE`: The path to the GPU used for **Rendering** (EGL).
103
+
*`DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
101
104
102
105
If both variables point to the same device, the container will automatically enable **Zero Copy** encoding, significantly reducing CPU usage and latency.
103
106
@@ -122,10 +125,9 @@ This container is compatible with [SealSkin](https://sealskin.app).
122
125
123
126
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.
124
127
125
-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
126
-
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
127
-
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
128
-
128
+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
129
+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
130
+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
129
131
130
132
### Options in all Selkies-based GUI containers
131
133
@@ -161,12 +163,13 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
161
163
| WATERMARK_LOCATION | Where to paint the image over the stream integer options below |
162
164
163
165
**`WATERMARK_LOCATION` Options:**
164
-
- **1**: Top Left
165
-
- **2**: Top Right
166
-
- **3**: Bottom Left
167
-
- **4**: Bottom Right
168
-
- **5**: Centered
169
-
- **6**: Animated
166
+
167
+
* **1**: Top Left
168
+
* **2**: Top Right
169
+
* **3**: Bottom Left
170
+
* **4**: Bottom Right
171
+
* **5**: Centered
172
+
* **6**: Animated
170
173
171
174
</details>
172
175
@@ -192,7 +195,7 @@ When using 3d acceleration via Nvidia DRM or DRI3 in X11 mode, it is important t
192
195
193
196
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:
194
197
195
-
```
198
+
```bash
196
199
-e SELKIES_MANUAL_WIDTH=1920
197
200
-e SELKIES_MANUAL_HEIGHT=1080
198
201
-e MAX_RESOLUTION=1920x1080
@@ -204,16 +207,16 @@ This will set the total virtual framebuffer to 4K. By default, the virtual monit
204
207
205
208
To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example:
0 commit comments