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: docs/images/docker-yaak.md
+41-35Lines changed: 41 additions & 35 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -68,19 +68,22 @@ We are currently transitioning our desktop containers from X11 to Wayland. While
68
68
**Important:** GPU acceleration support for X11 is being deprecated. Future development for hardware acceleration will focus entirely on the Wayland stack.
69
69
70
70
To enable Wayland mode, set the following environment variable:
71
-
*`-e PIXELFLUX_WAYLAND=true`
71
+
72
+
*`-e PIXELFLUX_WAYLAND=true`
72
73
73
74
**Why use Wayland?**
74
-
***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.
75
-
***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.
75
+
76
+
***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.
77
+
***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.
76
78
77
79
#### GPU Configuration
78
80
79
81
To use hardware acceleration in Wayland mode, we distinguish between the card used for **Rendering** (3D apps/Desktops) and **Encoding** (Video Stream).
80
82
81
83
**Configuration Variables:**
82
-
*`DRINODE`: The path to the GPU used for **Rendering** (EGL).
83
-
*`DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
84
+
85
+
*`DRINODE`: The path to the GPU used for **Rendering** (EGL).
86
+
*`DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
84
87
85
88
If both variables point to the same device, the container will automatically enable **Zero Copy** encoding, significantly reducing CPU usage and latency.
86
89
@@ -105,16 +108,15 @@ This container is compatible with [SealSkin](https://sealskin.app).
105
108
106
109
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.
107
110
108
-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
109
-
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
110
-
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
111
-
111
+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
112
+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
113
+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
112
114
113
115
### Options in all Selkies-based GUI containers
114
116
115
117
This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies).
116
118
117
-
???+ note "Click to expand: Optional Environment Variables"
119
+
??? note "Click to expand: Optional Environment Variables"
118
120
119
121
| Variable | Description |
120
122
| :----: | --- |
@@ -143,15 +145,16 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
143
145
| WATERMARK_LOCATION | Where to paint the image over the stream integer options below |
144
146
145
147
**`WATERMARK_LOCATION` Options:**
146
-
- **1**: Top Left
147
-
- **2**: Top Right
148
-
- **3**: Bottom Left
149
-
- **4**: Bottom Right
150
-
- **5**: Centered
151
-
- **6**: Animated
148
+
149
+
* **1**: Top Left
150
+
* **2**: Top Right
151
+
* **3**: Bottom Left
152
+
* **4**: Bottom Right
153
+
* **5**: Centered
154
+
* **6**: Animated
152
155
153
156
154
-
???+ note "Click to expand: Optional Run Configurations (DinD & GPU Mounts)"
157
+
??? note "Click to expand: Optional Run Configurations (DinD & GPU Mounts)"
155
158
156
159
| Argument | Description |
157
160
| :----: | --- |
@@ -160,7 +163,7 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
160
163
| `--device /dev/dri:/dev/dri` | Mount a GPU into the container, this can be used in conjunction with the `DRINODE` environment variable to leverage a host video card for GPU accelerated applications. |
161
164
162
165
163
-
???+ note "Click to expand: Legacy X11 Resolution & Acceleration"
166
+
??? note "Click to expand: Legacy X11 Resolution & Acceleration"
164
167
165
168
**Note:** This section applies only if you are **NOT** using `PIXELFLUX_WAYLAND=true`.
166
169
@@ -170,7 +173,7 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
170
173
171
174
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:
172
175
173
-
```
176
+
```bash
174
177
-e SELKIES_MANUAL_WIDTH=1920
175
178
-e SELKIES_MANUAL_HEIGHT=1080
176
179
-e MAX_RESOLUTION=1920x1080
@@ -181,16 +184,16 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
181
184
182
185
To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example:
@@ -202,7 +205,7 @@ Natively installed packages (e.g., via `apt-get install`) will not persist if th
202
205
203
206
To install an application, use the command line inside the container:
204
207
205
-
```
208
+
```bash
206
209
proot-apps install filezilla
207
210
```
208
211
@@ -220,7 +223,7 @@ You can install packages from the system's native repository using the [universa
220
223
221
224
### Advanced Configuration
222
225
223
-
???+ note "Click to expand: Hardening Options"
226
+
??? note "Click to expand: Hardening Options"
224
227
225
228
These variables can be used to lock down the desktop environment for single-application use cases or to restrict user capabilities.
226
229
@@ -242,21 +245,24 @@ You can install packages from the system's native repository using the [universa
242
245
| **`RESTART_APP`** | If true, enables a watchdog service that automatically restarts the main application if it is closed. The user's autostart script is made read-only and root owned to prevent tampering. |
243
246
244
247
245
-
???+ note "Click to expand: Selkies Application Settings"
248
+
??? note "Click to expand: Selkies Application Settings"
246
249
247
250
Using environment variables every facet of the application can be configured.
248
251
249
252
**Booleans and Locking:**
250
253
Boolean settings accept `true` or `false`. You can also prevent the user from changing a boolean setting in the UI by appending `|locked`.
251
-
* Example: `-e SELKIES_USE_CPU="true|locked"`
254
+
255
+
* Example: `-e SELKIES_USE_CPU="true|locked"`
252
256
253
257
**Enums and Lists:**
254
258
These settings accept a comma-separated list of values. The first item becomes default. If only one item is provided, the UI dropdown is hidden.
255
-
* Example: `-e SELKIES_ENCODER="jpeg"`
259
+
260
+
* Example: `-e SELKIES_ENCODER="jpeg"`
256
261
257
262
**Ranges:**
258
263
Use a hyphen-separated `min-max` format for a slider, or a single number to lock the value.
259
-
* Example: `-e SELKIES_FRAMERATE="60"`
264
+
265
+
* Example: `-e SELKIES_FRAMERATE="60"`
260
266
261
267
**Manual Resolution Mode:**
262
268
If `SELKIES_MANUAL_WIDTH` or `SELKIES_MANUAL_HEIGHT` are set, the resolution is locked to those values.
0 commit comments