Skip to content

Commit b34957f

Browse files
Bot Updating Templated Files
1 parent d883e4b commit b34957f

1 file changed

Lines changed: 43 additions & 34 deletions

File tree

README.md

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

9191
To enable Wayland mode, set the following environment variable:
92-
* `-e PIXELFLUX_WAYLAND=true`
92+
93+
* `-e PIXELFLUX_WAYLAND=true`
9394

9495
**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.
9799

98100
#### GPU Configuration
99101

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

102104
**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).
105108

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

@@ -124,10 +127,12 @@ For Intel and AMD GPUs.
124127
**Note: Nvidia support is not available for Alpine-based images.**
125128
126129
**Prerequisites:**
127-
1. **Driver:** Proprietary drivers **580 or higher** are required.
128-
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
129-
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
130-
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
130+
131+
1. **Driver:** Proprietary drivers **580 or higher** are required.
132+
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
133+
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
134+
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
135+
131136
```bash
132137
sudo nvidia-ctk runtime configure --runtime=docker
133138
sudo systemctl restart docker
@@ -136,6 +141,7 @@ For Intel and AMD GPUs.
136141
**Compose Configuration:**
137142

138143
```yaml
144+
---
139145
services:
140146
scummvm:
141147
image: lscr.io/linuxserver/scummvm:latest
@@ -159,10 +165,9 @@ This container is compatible with [SealSkin](https://sealskin.app).
159165

160166
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.
161167

162-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
163-
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
164-
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
165-
168+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
169+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
170+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
166171

167172
### Options in all Selkies-based GUI containers
168173

@@ -198,12 +203,13 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
198203
| WATERMARK_LOCATION | Where to paint the image over the stream integer options below |
199204

200205
**`WATERMARK_LOCATION` Options:**
201-
- **1**: Top Left
202-
- **2**: Top Right
203-
- **3**: Bottom Left
204-
- **4**: Bottom Right
205-
- **5**: Centered
206-
- **6**: Animated
206+
207+
* **1**: Top Left
208+
* **2**: Top Right
209+
* **3**: Bottom Left
210+
* **4**: Bottom Right
211+
* **5**: Centered
212+
* **6**: Animated
207213

208214
</details>
209215

@@ -229,7 +235,7 @@ When using 3d acceleration via Nvidia DRM or DRI3 in X11 mode, it is important t
229235

230236
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:
231237

232-
```
238+
```bash
233239
-e SELKIES_MANUAL_WIDTH=1920
234240
-e SELKIES_MANUAL_HEIGHT=1080
235241
-e MAX_RESOLUTION=1920x1080
@@ -241,16 +247,16 @@ This will set the total virtual framebuffer to 4K. By default, the virtual monit
241247

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

244-
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
245-
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
246-
* `-e LC_ALL=ko_KR.UTF-8` - Korean
247-
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
248-
* `-e LC_ALL=ru_RU.UTF-8` - Russian
249-
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
250-
* `-e LC_ALL=de_DE.UTF-8` - German
251-
* `-e LC_ALL=fr_FR.UTF-8` - French
252-
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
253-
* `-e LC_ALL=it_IT.UTF-8` - Italian
250+
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
251+
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
252+
* `-e LC_ALL=ko_KR.UTF-8` - Korean
253+
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
254+
* `-e LC_ALL=ru_RU.UTF-8` - Russian
255+
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
256+
* `-e LC_ALL=de_DE.UTF-8` - German
257+
* `-e LC_ALL=fr_FR.UTF-8` - French
258+
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
259+
* `-e LC_ALL=it_IT.UTF-8` - Italian
254260

255261
### Application Management
256262

@@ -262,7 +268,7 @@ Natively installed packages (e.g., via `apt-get install`) will not persist if th
262268

263269
To install an application, use the command line inside the container:
264270

265-
```
271+
```bash
266272
proot-apps install filezilla
267273
```
268274

@@ -311,15 +317,18 @@ Using environment variables every facet of the application can be configured.
311317

312318
**Booleans and Locking:**
313319
Boolean settings accept `true` or `false`. You can also prevent the user from changing a boolean setting in the UI by appending `|locked`.
314-
* Example: `-e SELKIES_USE_CPU="true|locked"`
320+
321+
* Example: `-e SELKIES_USE_CPU="true|locked"`
315322

316323
**Enums and Lists:**
317324
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.
318-
* Example: `-e SELKIES_ENCODER="jpeg"`
325+
326+
* Example: `-e SELKIES_ENCODER="jpeg"`
319327

320328
**Ranges:**
321329
Use a hyphen-separated `min-max` format for a slider, or a single number to lock the value.
322-
* Example: `-e SELKIES_FRAMERATE="60"`
330+
331+
* Example: `-e SELKIES_FRAMERATE="60"`
323332

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

0 commit comments

Comments
 (0)