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
@@ -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
@@ -126,10 +129,9 @@ This container is compatible with [SealSkin](https://sealskin.app).
126
129
127
130
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.
128
131
129
-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
130
-
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
131
-
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
132
-
132
+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
133
+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
134
+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
133
135
134
136
### Options in all Selkies-based GUI containers
135
137
@@ -165,12 +167,13 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
165
167
| WATERMARK_LOCATION | Where to paint the image over the stream integer options below |
166
168
167
169
**`WATERMARK_LOCATION` Options:**
168
-
- **1**: Top Left
169
-
- **2**: Top Right
170
-
- **3**: Bottom Left
171
-
- **4**: Bottom Right
172
-
- **5**: Centered
173
-
- **6**: Animated
170
+
171
+
* **1**: Top Left
172
+
* **2**: Top Right
173
+
* **3**: Bottom Left
174
+
* **4**: Bottom Right
175
+
* **5**: Centered
176
+
* **6**: Animated
174
177
175
178
</details>
176
179
@@ -196,7 +199,7 @@ When using 3d acceleration via Nvidia DRM or DRI3 in X11 mode, it is important t
196
199
197
200
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:
198
201
199
-
```
202
+
```bash
200
203
-e SELKIES_MANUAL_WIDTH=1920
201
204
-e SELKIES_MANUAL_HEIGHT=1080
202
205
-e MAX_RESOLUTION=1920x1080
@@ -208,16 +211,16 @@ This will set the total virtual framebuffer to 4K. By default, the virtual monit
208
211
209
212
To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example:
0 commit comments