Skip to content

Commit 0d131e9

Browse files
Bot Updating Templated Files
1 parent e1937d7 commit 0d131e9

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

9898
To enable Wayland mode, set the following environment variable:
99-
* `-e PIXELFLUX_WAYLAND=true`
99+
100+
* `-e PIXELFLUX_WAYLAND=true`
100101

101102
**Why use Wayland?**
102-
* **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.
103-
* **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.
103+
104+
* **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.
105+
* **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.
104106

105107
#### GPU Configuration
106108

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

109111
**Configuration Variables:**
110-
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
111-
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
112+
113+
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
114+
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
112115

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

@@ -131,10 +134,12 @@ For Intel and AMD GPUs.
131134
**Note: Nvidia support is not available for Alpine-based images.**
132135
133136
**Prerequisites:**
134-
1. **Driver:** Proprietary drivers **580 or higher** are required.
135-
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
136-
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
137-
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
137+
138+
1. **Driver:** Proprietary drivers **580 or higher** are required.
139+
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
140+
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
141+
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
142+
138143
```bash
139144
sudo nvidia-ctk runtime configure --runtime=docker
140145
sudo systemctl restart docker
@@ -143,6 +148,7 @@ For Intel and AMD GPUs.
143148
**Compose Configuration:**
144149

145150
```yaml
151+
---
146152
services:
147153
chromium:
148154
image: lscr.io/linuxserver/chromium:latest
@@ -166,10 +172,9 @@ This container is compatible with [SealSkin](https://sealskin.app).
166172

167173
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.
168174

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)
172-
175+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
176+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
177+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
173178

174179
### Options in all Selkies-based GUI containers
175180

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

207212
**`WATERMARK_LOCATION` Options:**
208-
- **1**: Top Left
209-
- **2**: Top Right
210-
- **3**: Bottom Left
211-
- **4**: Bottom Right
212-
- **5**: Centered
213-
- **6**: Animated
213+
214+
* **1**: Top Left
215+
* **2**: Top Right
216+
* **3**: Bottom Left
217+
* **4**: Bottom Right
218+
* **5**: Centered
219+
* **6**: Animated
214220

215221
</details>
216222

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

237243
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:
238244

239-
```
245+
```bash
240246
-e SELKIES_MANUAL_WIDTH=1920
241247
-e SELKIES_MANUAL_HEIGHT=1080
242248
-e MAX_RESOLUTION=1920x1080
@@ -248,16 +254,16 @@ This will set the total virtual framebuffer to 4K. By default, the virtual monit
248254

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

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
257+
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
258+
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
259+
* `-e LC_ALL=ko_KR.UTF-8` - Korean
260+
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
261+
* `-e LC_ALL=ru_RU.UTF-8` - Russian
262+
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
263+
* `-e LC_ALL=de_DE.UTF-8` - German
264+
* `-e LC_ALL=fr_FR.UTF-8` - French
265+
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
266+
* `-e LC_ALL=it_IT.UTF-8` - Italian
261267

262268
### Application Management
263269

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

270276
To install an application, use the command line inside the container:
271277

272-
```
278+
```bash
273279
proot-apps install filezilla
274280
```
275281

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

319325
**Booleans and Locking:**
320326
Boolean settings accept `true` or `false`. You can also prevent the user from changing a boolean setting in the UI by appending `|locked`.
321-
* Example: `-e SELKIES_USE_CPU="true|locked"`
327+
328+
* Example: `-e SELKIES_USE_CPU="true|locked"`
322329

323330
**Enums and Lists:**
324331
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.
325-
* Example: `-e SELKIES_ENCODER="jpeg"`
332+
333+
* Example: `-e SELKIES_ENCODER="jpeg"`
326334

327335
**Ranges:**
328336
Use a hyphen-separated `min-max` format for a slider, or a single number to lock the value.
329-
* Example: `-e SELKIES_FRAMERATE="60"`
337+
338+
* Example: `-e SELKIES_FRAMERATE="60"`
330339

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

0 commit comments

Comments
 (0)