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