Skip to content

Commit 6df25dc

Browse files
Bot Updating Documentation
1 parent 74a22f1 commit 6df25dc

File tree

1 file changed

+48
-39
lines changed

1 file changed

+48
-39
lines changed

docs/images/docker-cura.md

Lines changed: 48 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -72,19 +72,22 @@ We are currently transitioning our desktop containers from X11 to Wayland. While
7272
**Important:** GPU acceleration support for X11 is being deprecated. Future development for hardware acceleration will focus entirely on the Wayland stack.
7373

7474
To enable Wayland mode, set the following environment variable:
75-
* `-e PIXELFLUX_WAYLAND=true`
75+
76+
* `-e PIXELFLUX_WAYLAND=true`
7677

7778
**Why use Wayland?**
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.
79+
80+
* **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.
81+
* **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.
8082

8183
#### GPU Configuration
8284

8385
To use hardware acceleration in Wayland mode, we distinguish between the card used for **Rendering** (3D apps/Desktops) and **Encoding** (Video Stream).
8486

8587
**Configuration Variables:**
86-
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
87-
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
88+
89+
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
90+
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
8891

8992
If both variables point to the same device, the container will automatically enable **Zero Copy** encoding, significantly reducing CPU usage and latency.
9093

@@ -107,10 +110,12 @@ For Intel and AMD GPUs.
107110
**Note: Nvidia support is not available for Alpine-based images.**
108111
109112
**Prerequisites:**
110-
1. **Driver:** Proprietary drivers **580 or higher** are required.
111-
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
112-
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
113-
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
113+
114+
1. **Driver:** Proprietary drivers **580 or higher** are required.
115+
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
116+
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
117+
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
118+
114119
```bash
115120
sudo nvidia-ctk runtime configure --runtime=docker
116121
sudo systemctl restart docker
@@ -119,6 +124,7 @@ For Intel and AMD GPUs.
119124
**Compose Configuration:**
120125

121126
```yaml
127+
---
122128
services:
123129
cura:
124130
image: lscr.io/linuxserver/cura:latest
@@ -142,16 +148,15 @@ This container is compatible with [SealSkin](https://sealskin.app).
142148

143149
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.
144150

145-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
146-
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
147-
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
148-
151+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
152+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
153+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
149154

150155
### Options in all Selkies-based GUI containers
151156

152157
This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies).
153158

154-
???+ note "Click to expand: Optional Environment Variables"
159+
??? note "Click to expand: Optional Environment Variables"
155160

156161
| Variable | Description |
157162
| :----: | --- |
@@ -180,15 +185,16 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
180185
| WATERMARK_LOCATION | Where to paint the image over the stream integer options below |
181186

182187
**`WATERMARK_LOCATION` Options:**
183-
- **1**: Top Left
184-
- **2**: Top Right
185-
- **3**: Bottom Left
186-
- **4**: Bottom Right
187-
- **5**: Centered
188-
- **6**: Animated
188+
189+
* **1**: Top Left
190+
* **2**: Top Right
191+
* **3**: Bottom Left
192+
* **4**: Bottom Right
193+
* **5**: Centered
194+
* **6**: Animated
189195

190196

191-
???+ note "Click to expand: Optional Run Configurations (DinD & GPU Mounts)"
197+
??? note "Click to expand: Optional Run Configurations (DinD & GPU Mounts)"
192198

193199
| Argument | Description |
194200
| :----: | --- |
@@ -197,7 +203,7 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
197203
| `--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. |
198204

199205

200-
???+ note "Click to expand: Legacy X11 Resolution & Acceleration"
206+
??? note "Click to expand: Legacy X11 Resolution & Acceleration"
201207

202208
**Note:** This section applies only if you are **NOT** using `PIXELFLUX_WAYLAND=true`.
203209

@@ -207,7 +213,7 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
207213

208214
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:
209215

210-
```
216+
```bash
211217
-e SELKIES_MANUAL_WIDTH=1920
212218
-e SELKIES_MANUAL_HEIGHT=1080
213219
-e MAX_RESOLUTION=1920x1080
@@ -218,16 +224,16 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
218224

219225
To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example:
220226

221-
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
222-
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
223-
* `-e LC_ALL=ko_KR.UTF-8` - Korean
224-
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
225-
* `-e LC_ALL=ru_RU.UTF-8` - Russian
226-
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
227-
* `-e LC_ALL=de_DE.UTF-8` - German
228-
* `-e LC_ALL=fr_FR.UTF-8` - French
229-
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
230-
* `-e LC_ALL=it_IT.UTF-8` - Italian
227+
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
228+
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
229+
* `-e LC_ALL=ko_KR.UTF-8` - Korean
230+
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
231+
* `-e LC_ALL=ru_RU.UTF-8` - Russian
232+
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
233+
* `-e LC_ALL=de_DE.UTF-8` - German
234+
* `-e LC_ALL=fr_FR.UTF-8` - French
235+
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
236+
* `-e LC_ALL=it_IT.UTF-8` - Italian
231237

232238
### Application Management
233239

@@ -239,7 +245,7 @@ Natively installed packages (e.g., via `apt-get install`) will not persist if th
239245

240246
To install an application, use the command line inside the container:
241247

242-
```
248+
```bash
243249
proot-apps install filezilla
244250
```
245251

@@ -257,7 +263,7 @@ You can install packages from the system's native repository using the [universa
257263

258264
### Advanced Configuration
259265

260-
???+ note "Click to expand: Hardening Options"
266+
??? note "Click to expand: Hardening Options"
261267

262268
These variables can be used to lock down the desktop environment for single-application use cases or to restrict user capabilities.
263269

@@ -279,21 +285,24 @@ You can install packages from the system's native repository using the [universa
279285
| **`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. |
280286

281287

282-
???+ note "Click to expand: Selkies Application Settings"
288+
??? note "Click to expand: Selkies Application Settings"
283289

284290
Using environment variables every facet of the application can be configured.
285291

286292
**Booleans and Locking:**
287293
Boolean settings accept `true` or `false`. You can also prevent the user from changing a boolean setting in the UI by appending `|locked`.
288-
* Example: `-e SELKIES_USE_CPU="true|locked"`
294+
295+
* Example: `-e SELKIES_USE_CPU="true|locked"`
289296

290297
**Enums and Lists:**
291298
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.
292-
* Example: `-e SELKIES_ENCODER="jpeg"`
299+
300+
* Example: `-e SELKIES_ENCODER="jpeg"`
293301

294302
**Ranges:**
295303
Use a hyphen-separated `min-max` format for a slider, or a single number to lock the value.
296-
* Example: `-e SELKIES_FRAMERATE="60"`
304+
305+
* Example: `-e SELKIES_FRAMERATE="60"`
297306

298307
**Manual Resolution Mode:**
299308
If `SELKIES_MANUAL_WIDTH` or `SELKIES_MANUAL_HEIGHT` are set, the resolution is locked to those values.

0 commit comments

Comments
 (0)