Skip to content

Commit 2996bd0

Browse files
Bot Updating Templated Files
1 parent 1298518 commit 2996bd0

1 file changed

Lines changed: 36 additions & 30 deletions

File tree

README.md

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

8787
To enable Wayland mode, set the following environment variable:
88-
* `-e PIXELFLUX_WAYLAND=true`
88+
89+
* `-e PIXELFLUX_WAYLAND=true`
8990

9091
**Why use Wayland?**
91-
* **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.
92-
* **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.
92+
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.
9395

9496
#### GPU Configuration
9597

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

98100
**Configuration Variables:**
99-
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
100-
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
101+
102+
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
103+
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
101104

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

@@ -122,10 +125,9 @@ This container is compatible with [SealSkin](https://sealskin.app).
122125
123126
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.
124127
125-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
126-
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
127-
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
128-
128+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
129+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
130+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
129131
130132
### Options in all Selkies-based GUI containers
131133
@@ -161,12 +163,13 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
161163
| WATERMARK_LOCATION | Where to paint the image over the stream integer options below |
162164

163165
**`WATERMARK_LOCATION` Options:**
164-
- **1**: Top Left
165-
- **2**: Top Right
166-
- **3**: Bottom Left
167-
- **4**: Bottom Right
168-
- **5**: Centered
169-
- **6**: Animated
166+
167+
* **1**: Top Left
168+
* **2**: Top Right
169+
* **3**: Bottom Left
170+
* **4**: Bottom Right
171+
* **5**: Centered
172+
* **6**: Animated
170173

171174
</details>
172175

@@ -192,7 +195,7 @@ When using 3d acceleration via Nvidia DRM or DRI3 in X11 mode, it is important t
192195

193196
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:
194197

195-
```
198+
```bash
196199
-e SELKIES_MANUAL_WIDTH=1920
197200
-e SELKIES_MANUAL_HEIGHT=1080
198201
-e MAX_RESOLUTION=1920x1080
@@ -204,16 +207,16 @@ This will set the total virtual framebuffer to 4K. By default, the virtual monit
204207

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

207-
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
208-
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
209-
* `-e LC_ALL=ko_KR.UTF-8` - Korean
210-
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
211-
* `-e LC_ALL=ru_RU.UTF-8` - Russian
212-
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
213-
* `-e LC_ALL=de_DE.UTF-8` - German
214-
* `-e LC_ALL=fr_FR.UTF-8` - French
215-
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
216-
* `-e LC_ALL=it_IT.UTF-8` - Italian
210+
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
211+
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
212+
* `-e LC_ALL=ko_KR.UTF-8` - Korean
213+
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
214+
* `-e LC_ALL=ru_RU.UTF-8` - Russian
215+
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
216+
* `-e LC_ALL=de_DE.UTF-8` - German
217+
* `-e LC_ALL=fr_FR.UTF-8` - French
218+
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
219+
* `-e LC_ALL=it_IT.UTF-8` - Italian
217220

218221
### Application Management
219222

@@ -225,7 +228,7 @@ Natively installed packages (e.g., via `apt-get install`) will not persist if th
225228

226229
To install an application, use the command line inside the container:
227230

228-
```
231+
```bash
229232
proot-apps install filezilla
230233
```
231234

@@ -274,15 +277,18 @@ Using environment variables every facet of the application can be configured.
274277

275278
**Booleans and Locking:**
276279
Boolean settings accept `true` or `false`. You can also prevent the user from changing a boolean setting in the UI by appending `|locked`.
277-
* Example: `-e SELKIES_USE_CPU="true|locked"`
280+
281+
* Example: `-e SELKIES_USE_CPU="true|locked"`
278282

279283
**Enums and Lists:**
280284
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.
281-
* Example: `-e SELKIES_ENCODER="jpeg"`
285+
286+
* Example: `-e SELKIES_ENCODER="jpeg"`
282287

283288
**Ranges:**
284289
Use a hyphen-separated `min-max` format for a slider, or a single number to lock the value.
285-
* Example: `-e SELKIES_FRAMERATE="60"`
290+
291+
* Example: `-e SELKIES_FRAMERATE="60"`
286292

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

0 commit comments

Comments
 (0)