Skip to content

Commit 4147fad

Browse files
Bot Updating Templated Files
1 parent 84fe1fb commit 4147fad

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

9292
To enable Wayland mode, set the following environment variable:
93-
* `-e PIXELFLUX_WAYLAND=true`
93+
94+
* `-e PIXELFLUX_WAYLAND=true`
9495

9596
**Why use Wayland?**
96-
* **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.
97-
* **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.
97+
98+
* **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.
99+
* **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.
98100

99101
#### GPU Configuration
100102

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

103105
**Configuration Variables:**
104-
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
105-
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
106+
107+
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
108+
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
106109

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

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

139144
```yaml
145+
---
140146
services:
141147
bitcoin-knots:
142148
image: lscr.io/linuxserver/bitcoin-knots:latest
@@ -160,10 +166,9 @@ This container is compatible with [SealSkin](https://sealskin.app).
160166

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

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

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

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

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

209215
</details>
210216

@@ -230,7 +236,7 @@ When using 3d acceleration via Nvidia DRM or DRI3 in X11 mode, it is important t
230236

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

233-
```
239+
```bash
234240
-e SELKIES_MANUAL_WIDTH=1920
235241
-e SELKIES_MANUAL_HEIGHT=1080
236242
-e MAX_RESOLUTION=1920x1080
@@ -242,16 +248,16 @@ This will set the total virtual framebuffer to 4K. By default, the virtual monit
242248

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

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

256262
### Application Management
257263

@@ -263,7 +269,7 @@ Natively installed packages (e.g., via `apt-get install`) will not persist if th
263269

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

266-
```
272+
```bash
267273
proot-apps install filezilla
268274
```
269275

@@ -312,15 +318,18 @@ Using environment variables every facet of the application can be configured.
312318

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

317324
**Enums and Lists:**
318325
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.
319-
* Example: `-e SELKIES_ENCODER="jpeg"`
326+
327+
* Example: `-e SELKIES_ENCODER="jpeg"`
320328

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

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

0 commit comments

Comments
 (0)