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-signal.md
+48-39Lines changed: 48 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,19 +73,22 @@ We are currently transitioning our desktop containers from X11 to Wayland. While
73
73
**Important:** GPU acceleration support for X11 is being deprecated. Future development for hardware acceleration will focus entirely on the Wayland stack.
74
74
75
75
To enable Wayland mode, set the following environment variable:
76
-
*`-e PIXELFLUX_WAYLAND=true`
76
+
77
+
*`-e PIXELFLUX_WAYLAND=true`
77
78
78
79
**Why use Wayland?**
79
-
***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.
80
-
***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.
80
+
81
+
***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.
82
+
***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.
81
83
82
84
#### GPU Configuration
83
85
84
86
To use hardware acceleration in Wayland mode, we distinguish between the card used for **Rendering** (3D apps/Desktops) and **Encoding** (Video Stream).
85
87
86
88
**Configuration Variables:**
87
-
*`DRINODE`: The path to the GPU used for **Rendering** (EGL).
88
-
*`DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
89
+
90
+
*`DRINODE`: The path to the GPU used for **Rendering** (EGL).
91
+
*`DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
89
92
90
93
If both variables point to the same device, the container will automatically enable **Zero Copy** encoding, significantly reducing CPU usage and latency.
91
94
@@ -108,10 +111,12 @@ For Intel and AMD GPUs.
108
111
**Note: Nvidia support is not available for Alpine-based images.**
109
112
110
113
**Prerequisites:**
111
-
1. **Driver:** Proprietary drivers **580 or higher** are required.
112
-
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
113
-
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
114
-
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
114
+
115
+
1. **Driver:** Proprietary drivers **580 or higher** are required.
116
+
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
117
+
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
118
+
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
@@ -143,16 +149,15 @@ This container is compatible with [SealSkin](https://sealskin.app).
143
149
144
150
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.
145
151
146
-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
147
-
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
148
-
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
149
-
152
+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
153
+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
154
+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
150
155
151
156
### Options in all Selkies-based GUI containers
152
157
153
158
This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies).
154
159
155
-
???+ note "Click to expand: Optional Environment Variables"
160
+
??? note "Click to expand: Optional Environment Variables"
156
161
157
162
| Variable | Description |
158
163
| :----: | --- |
@@ -181,15 +186,16 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
181
186
| WATERMARK_LOCATION | Where to paint the image over the stream integer options below |
182
187
183
188
**`WATERMARK_LOCATION` Options:**
184
-
- **1**: Top Left
185
-
- **2**: Top Right
186
-
- **3**: Bottom Left
187
-
- **4**: Bottom Right
188
-
- **5**: Centered
189
-
- **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
190
196
191
197
192
-
???+ note "Click to expand: Optional Run Configurations (DinD & GPU Mounts)"
198
+
??? note "Click to expand: Optional Run Configurations (DinD & GPU Mounts)"
193
199
194
200
| Argument | Description |
195
201
| :----: | --- |
@@ -198,7 +204,7 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
198
204
| `--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. |
199
205
200
206
201
-
???+ note "Click to expand: Legacy X11 Resolution & Acceleration"
207
+
??? note "Click to expand: Legacy X11 Resolution & Acceleration"
202
208
203
209
**Note:** This section applies only if you are **NOT** using `PIXELFLUX_WAYLAND=true`.
204
210
@@ -208,7 +214,7 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
208
214
209
215
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:
210
216
211
-
```
217
+
```bash
212
218
-e SELKIES_MANUAL_WIDTH=1920
213
219
-e SELKIES_MANUAL_HEIGHT=1080
214
220
-e MAX_RESOLUTION=1920x1080
@@ -219,16 +225,16 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
219
225
220
226
To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example:
@@ -240,7 +246,7 @@ Natively installed packages (e.g., via `apt-get install`) will not persist if th
240
246
241
247
To install an application, use the command line inside the container:
242
248
243
-
```
249
+
```bash
244
250
proot-apps install filezilla
245
251
```
246
252
@@ -258,7 +264,7 @@ You can install packages from the system's native repository using the [universa
258
264
259
265
### Advanced Configuration
260
266
261
-
???+ note "Click to expand: Hardening Options"
267
+
??? note "Click to expand: Hardening Options"
262
268
263
269
These variables can be used to lock down the desktop environment for single-application use cases or to restrict user capabilities.
264
270
@@ -280,21 +286,24 @@ You can install packages from the system's native repository using the [universa
280
286
| **`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. |
281
287
282
288
283
-
???+ note "Click to expand: Selkies Application Settings"
289
+
??? note "Click to expand: Selkies Application Settings"
284
290
285
291
Using environment variables every facet of the application can be configured.
286
292
287
293
**Booleans and Locking:**
288
294
Boolean settings accept `true` or `false`. You can also prevent the user from changing a boolean setting in the UI by appending `|locked`.
289
-
* Example: `-e SELKIES_USE_CPU="true|locked"`
295
+
296
+
* Example: `-e SELKIES_USE_CPU="true|locked"`
290
297
291
298
**Enums and Lists:**
292
299
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.
293
-
* Example: `-e SELKIES_ENCODER="jpeg"`
300
+
301
+
* Example: `-e SELKIES_ENCODER="jpeg"`
294
302
295
303
**Ranges:**
296
304
Use a hyphen-separated `min-max` format for a slider, or a single number to lock the value.
297
-
* Example: `-e SELKIES_FRAMERATE="60"`
305
+
306
+
* Example: `-e SELKIES_FRAMERATE="60"`
298
307
299
308
**Manual Resolution Mode:**
300
309
If `SELKIES_MANUAL_WIDTH` or `SELKIES_MANUAL_HEIGHT` are set, the resolution is locked to those values.
0 commit comments