Skip to content

Commit 2b43788

Browse files
Bot Updating Templated Files
1 parent 5736f91 commit 2b43788

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

119119
To enable Wayland mode, set the following environment variable:
120-
* `-e PIXELFLUX_WAYLAND=true`
120+
121+
* `-e PIXELFLUX_WAYLAND=true`
121122

122123
**Why use Wayland?**
123-
* **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.
124-
* **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.
124+
125+
* **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.
126+
* **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.
125127

126128
#### GPU Configuration
127129

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

130132
**Configuration Variables:**
131-
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
132-
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
133+
134+
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
135+
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
133136

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

@@ -152,10 +155,12 @@ For Intel and AMD GPUs.
152155
**Note: Nvidia support is not available for Alpine-based images.**
153156
154157
**Prerequisites:**
155-
1. **Driver:** Proprietary drivers **580 or higher** are required.
156-
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
157-
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
158-
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
158+
159+
1. **Driver:** Proprietary drivers **580 or higher** are required.
160+
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
161+
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
162+
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
163+
159164
```bash
160165
sudo nvidia-ctk runtime configure --runtime=docker
161166
sudo systemctl restart docker
@@ -164,6 +169,7 @@ For Intel and AMD GPUs.
164169
**Compose Configuration:**
165170

166171
```yaml
172+
---
167173
services:
168174
webtop:
169175
image: lscr.io/linuxserver/webtop:latest
@@ -187,10 +193,9 @@ This container is compatible with [SealSkin](https://sealskin.app).
187193

188194
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.
189195

190-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
191-
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
192-
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
193-
196+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
197+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
198+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
194199

195200
### Options in all Selkies-based GUI containers
196201

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

228233
**`WATERMARK_LOCATION` Options:**
229-
- **1**: Top Left
230-
- **2**: Top Right
231-
- **3**: Bottom Left
232-
- **4**: Bottom Right
233-
- **5**: Centered
234-
- **6**: Animated
234+
235+
* **1**: Top Left
236+
* **2**: Top Right
237+
* **3**: Bottom Left
238+
* **4**: Bottom Right
239+
* **5**: Centered
240+
* **6**: Animated
235241

236242
</details>
237243

@@ -257,7 +263,7 @@ When using 3d acceleration via Nvidia DRM or DRI3 in X11 mode, it is important t
257263

258264
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:
259265

260-
```
266+
```bash
261267
-e SELKIES_MANUAL_WIDTH=1920
262268
-e SELKIES_MANUAL_HEIGHT=1080
263269
-e MAX_RESOLUTION=1920x1080
@@ -269,16 +275,16 @@ This will set the total virtual framebuffer to 4K. By default, the virtual monit
269275

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

272-
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
273-
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
274-
* `-e LC_ALL=ko_KR.UTF-8` - Korean
275-
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
276-
* `-e LC_ALL=ru_RU.UTF-8` - Russian
277-
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
278-
* `-e LC_ALL=de_DE.UTF-8` - German
279-
* `-e LC_ALL=fr_FR.UTF-8` - French
280-
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
281-
* `-e LC_ALL=it_IT.UTF-8` - Italian
278+
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
279+
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
280+
* `-e LC_ALL=ko_KR.UTF-8` - Korean
281+
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
282+
* `-e LC_ALL=ru_RU.UTF-8` - Russian
283+
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
284+
* `-e LC_ALL=de_DE.UTF-8` - German
285+
* `-e LC_ALL=fr_FR.UTF-8` - French
286+
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
287+
* `-e LC_ALL=it_IT.UTF-8` - Italian
282288

283289
### Application Management
284290

@@ -290,7 +296,7 @@ Natively installed packages (e.g., via `apt-get install`) will not persist if th
290296

291297
To install an application, use the command line inside the container:
292298

293-
```
299+
```bash
294300
proot-apps install filezilla
295301
```
296302

@@ -339,15 +345,18 @@ Using environment variables every facet of the application can be configured.
339345

340346
**Booleans and Locking:**
341347
Boolean settings accept `true` or `false`. You can also prevent the user from changing a boolean setting in the UI by appending `|locked`.
342-
* Example: `-e SELKIES_USE_CPU="true|locked"`
348+
349+
* Example: `-e SELKIES_USE_CPU="true|locked"`
343350

344351
**Enums and Lists:**
345352
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.
346-
* Example: `-e SELKIES_ENCODER="jpeg"`
353+
354+
* Example: `-e SELKIES_ENCODER="jpeg"`
347355

348356
**Ranges:**
349357
Use a hyphen-separated `min-max` format for a slider, or a single number to lock the value.
350-
* Example: `-e SELKIES_FRAMERATE="60"`
358+
359+
* Example: `-e SELKIES_FRAMERATE="60"`
351360

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

0 commit comments

Comments
 (0)