Skip to content

Commit e7f681f

Browse files
Bot Updating Templated Files
1 parent 30edfbf commit e7f681f

File tree

1 file changed

+43
-34
lines changed

1 file changed

+43
-34
lines changed

README.md

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

8989
To enable Wayland mode, set the following environment variable:
90-
* `-e PIXELFLUX_WAYLAND=true`
90+
91+
* `-e PIXELFLUX_WAYLAND=true`
9192

9293
**Why use Wayland?**
93-
* **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.
94-
* **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.
94+
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.
9597

9698
#### GPU Configuration
9799

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

100102
**Configuration Variables:**
101-
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
102-
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
103+
104+
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
105+
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
103106

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

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

136141
```yaml
142+
---
137143
services:
138144
kdenlive:
139145
image: lscr.io/linuxserver/kdenlive:latest
@@ -157,10 +163,9 @@ This container is compatible with [SealSkin](https://sealskin.app).
157163

158164
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.
159165

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

165170
### Options in all Selkies-based GUI containers
166171

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

198203
**`WATERMARK_LOCATION` Options:**
199-
- **1**: Top Left
200-
- **2**: Top Right
201-
- **3**: Bottom Left
202-
- **4**: Bottom Right
203-
- **5**: Centered
204-
- **6**: Animated
204+
205+
* **1**: Top Left
206+
* **2**: Top Right
207+
* **3**: Bottom Left
208+
* **4**: Bottom Right
209+
* **5**: Centered
210+
* **6**: Animated
205211

206212
</details>
207213

@@ -227,7 +233,7 @@ When using 3d acceleration via Nvidia DRM or DRI3 in X11 mode, it is important t
227233

228234
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:
229235

230-
```
236+
```bash
231237
-e SELKIES_MANUAL_WIDTH=1920
232238
-e SELKIES_MANUAL_HEIGHT=1080
233239
-e MAX_RESOLUTION=1920x1080
@@ -239,16 +245,16 @@ This will set the total virtual framebuffer to 4K. By default, the virtual monit
239245

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

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

253259
### Application Management
254260

@@ -260,7 +266,7 @@ Natively installed packages (e.g., via `apt-get install`) will not persist if th
260266

261267
To install an application, use the command line inside the container:
262268

263-
```
269+
```bash
264270
proot-apps install filezilla
265271
```
266272

@@ -309,15 +315,18 @@ Using environment variables every facet of the application can be configured.
309315

310316
**Booleans and Locking:**
311317
Boolean settings accept `true` or `false`. You can also prevent the user from changing a boolean setting in the UI by appending `|locked`.
312-
* Example: `-e SELKIES_USE_CPU="true|locked"`
318+
319+
* Example: `-e SELKIES_USE_CPU="true|locked"`
313320

314321
**Enums and Lists:**
315322
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.
316-
* Example: `-e SELKIES_ENCODER="jpeg"`
323+
324+
* Example: `-e SELKIES_ENCODER="jpeg"`
317325

318326
**Ranges:**
319327
Use a hyphen-separated `min-max` format for a slider, or a single number to lock the value.
320-
* Example: `-e SELKIES_FRAMERATE="60"`
328+
329+
* Example: `-e SELKIES_FRAMERATE="60"`
321330

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

0 commit comments

Comments
 (0)