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