Skip to content

Commit 24fa5a5

Browse files
Bot Updating Templated Files
1 parent 9e7a030 commit 24fa5a5

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
@@ -130,19 +130,22 @@ We are currently transitioning our desktop containers from X11 to Wayland. While
130130
**Important:** GPU acceleration support for X11 is being deprecated. Future development for hardware acceleration will focus entirely on the Wayland stack.
131131

132132
To enable Wayland mode, set the following environment variable:
133-
* `-e PIXELFLUX_WAYLAND=true`
133+
134+
* `-e PIXELFLUX_WAYLAND=true`
134135

135136
**Why use Wayland?**
136-
* **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.
137-
* **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.
137+
138+
* **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.
139+
* **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.
138140

139141
#### GPU Configuration
140142

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

143145
**Configuration Variables:**
144-
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
145-
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
146+
147+
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
148+
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
146149

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

@@ -165,10 +168,12 @@ For Intel and AMD GPUs.
165168
**Note: Nvidia support is not available for Alpine-based images.**
166169
167170
**Prerequisites:**
168-
1. **Driver:** Proprietary drivers **580 or higher** are required.
169-
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
170-
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
171-
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
171+
172+
1. **Driver:** Proprietary drivers **580 or higher** are required.
173+
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
174+
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
175+
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
176+
172177
```bash
173178
sudo nvidia-ctk runtime configure --runtime=docker
174179
sudo systemctl restart docker
@@ -177,6 +182,7 @@ For Intel and AMD GPUs.
177182
**Compose Configuration:**
178183

179184
```yaml
185+
---
180186
services:
181187
steam:
182188
image: lscr.io/linuxserver/steam:latest
@@ -200,10 +206,9 @@ This container is compatible with [SealSkin](https://sealskin.app).
200206

201207
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.
202208

203-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
204-
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
205-
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
206-
209+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
210+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
211+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
207212

208213
### Options in all Selkies-based GUI containers
209214

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

241246
**`WATERMARK_LOCATION` Options:**
242-
- **1**: Top Left
243-
- **2**: Top Right
244-
- **3**: Bottom Left
245-
- **4**: Bottom Right
246-
- **5**: Centered
247-
- **6**: Animated
247+
248+
* **1**: Top Left
249+
* **2**: Top Right
250+
* **3**: Bottom Left
251+
* **4**: Bottom Right
252+
* **5**: Centered
253+
* **6**: Animated
248254

249255
</details>
250256

@@ -270,7 +276,7 @@ When using 3d acceleration via Nvidia DRM or DRI3 in X11 mode, it is important t
270276

271277
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:
272278

273-
```
279+
```bash
274280
-e SELKIES_MANUAL_WIDTH=1920
275281
-e SELKIES_MANUAL_HEIGHT=1080
276282
-e MAX_RESOLUTION=1920x1080
@@ -282,16 +288,16 @@ This will set the total virtual framebuffer to 4K. By default, the virtual monit
282288

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

285-
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
286-
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
287-
* `-e LC_ALL=ko_KR.UTF-8` - Korean
288-
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
289-
* `-e LC_ALL=ru_RU.UTF-8` - Russian
290-
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
291-
* `-e LC_ALL=de_DE.UTF-8` - German
292-
* `-e LC_ALL=fr_FR.UTF-8` - French
293-
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
294-
* `-e LC_ALL=it_IT.UTF-8` - Italian
291+
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
292+
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
293+
* `-e LC_ALL=ko_KR.UTF-8` - Korean
294+
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
295+
* `-e LC_ALL=ru_RU.UTF-8` - Russian
296+
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
297+
* `-e LC_ALL=de_DE.UTF-8` - German
298+
* `-e LC_ALL=fr_FR.UTF-8` - French
299+
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
300+
* `-e LC_ALL=it_IT.UTF-8` - Italian
295301

296302
### Application Management
297303

@@ -303,7 +309,7 @@ Natively installed packages (e.g., via `apt-get install`) will not persist if th
303309

304310
To install an application, use the command line inside the container:
305311

306-
```
312+
```bash
307313
proot-apps install filezilla
308314
```
309315

@@ -352,15 +358,18 @@ Using environment variables every facet of the application can be configured.
352358

353359
**Booleans and Locking:**
354360
Boolean settings accept `true` or `false`. You can also prevent the user from changing a boolean setting in the UI by appending `|locked`.
355-
* Example: `-e SELKIES_USE_CPU="true|locked"`
361+
362+
* Example: `-e SELKIES_USE_CPU="true|locked"`
356363

357364
**Enums and Lists:**
358365
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.
359-
* Example: `-e SELKIES_ENCODER="jpeg"`
366+
367+
* Example: `-e SELKIES_ENCODER="jpeg"`
360368

361369
**Ranges:**
362370
Use a hyphen-separated `min-max` format for a slider, or a single number to lock the value.
363-
* Example: `-e SELKIES_FRAMERATE="60"`
371+
372+
* Example: `-e SELKIES_FRAMERATE="60"`
364373

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

0 commit comments

Comments
 (0)