Skip to content

Commit 8fc505e

Browse files
LinuxServer-CILinuxServer-CI
committed
Bot Updating Templated Files
1 parent e4bc61a commit 8fc505e

File tree

1 file changed

+134
-122
lines changed

1 file changed

+134
-122
lines changed

‎README.md‎

Lines changed: 134 additions & 122 deletions
Original file line numberDiff line numberDiff line change
@@ -83,11 +83,94 @@ The web interface includes a terminal with passwordless `sudo` access. Any user
8383

8484
While not generally recommended, certain legacy environments specifically those with older hardware or outdated Linux distributions may require the deactivation of the standard seccomp profile to get containerized desktop software to run. This can be achieved by utilizing the `--security-opt seccomp=unconfined` parameter. It is critical to use this option only when absolutely necessary as it disables a key security layer of Docker, elevating the potential for container escape vulnerabilities.
8585

86+
### Hardware Acceleration & The Move to Wayland
87+
88+
We are currently transitioning our desktop containers from X11 to Wayland. While X11 is still the default, we strongly encourage users to test the new Wayland mode.
89+
90+
**Important:** GPU acceleration support for X11 is being deprecated. Future development for hardware acceleration will focus entirely on the Wayland stack.
91+
92+
To enable Wayland mode, set the following environment variable:
93+
* `-e PIXELFLUX_WAYLAND=true`
94+
95+
**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.
98+
99+
#### GPU Configuration
100+
101+
To use hardware acceleration in Wayland mode, we distinguish between the card used for **Rendering** (3D apps/Desktops) and **Encoding** (Video Stream).
102+
103+
**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+
If both variables point to the same device, the container will automatically enable **Zero Copy** encoding, significantly reducing CPU usage and latency.
108+
109+
##### Intel & AMD (Open Source Drivers)
110+
111+
For Intel and AMD GPUs.
112+
113+
```yaml
114+
devices:
115+
- /dev/dri:/dev/dri
116+
environment:
117+
- PIXELFLUX_WAYLAND=true
118+
# Optional: Specify device if multiple exist (IE: /dev/dri/renderD129)
119+
- DRINODE=/dev/dri/renderD128
120+
- DRI_NODE=/dev/dri/renderD128
121+
```
122+
123+
##### Nvidia (Proprietary Drivers)
124+
125+
**Note: Nvidia support is not available for Alpine-based images.**
126+
127+
**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:
132+
```bash
133+
sudo nvidia-ctk runtime configure --runtime=docker
134+
sudo systemctl restart docker
135+
```
136+
137+
**Compose Configuration:**
138+
139+
```yaml
140+
services:
141+
bitcoin-knots:
142+
image: lscr.io/linuxserver/bitcoin-knots:latest
143+
environment:
144+
- PIXELFLUX_WAYLAND=true
145+
# Ensure these point to the rendered node injected by the runtime (usually renderD128)
146+
- DRINODE=/dev/dri/renderD128
147+
- DRI_NODE=/dev/dri/renderD128
148+
deploy:
149+
resources:
150+
reservations:
151+
devices:
152+
- driver: nvidia
153+
count: 1
154+
capabilities: [compute,video,graphics,utility]
155+
```
156+
157+
### SealSkin Compatibility
158+
159+
This container is compatible with [SealSkin](https://sealskin.app).
160+
161+
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.
162+
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+
167+
86168
### Options in all Selkies-based GUI containers
87169

88-
This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies), which provides the following environment variables and run configurations to customize its functionality.
170+
This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies).
89171

90-
#### Optional Environment Variables
172+
<details>
173+
<summary>Click to expand: Optional Environment Variables</summary>
91174

92175
| Variable | Description |
93176
| :----: | --- |
@@ -96,8 +179,8 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
96179
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default `3001` |
97180
| CUSTOM_WS_PORT | Internal port the container listens on for websockets if it needs to be swapped from the default 8082 |
98181
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
99-
| DRI_NODE | Enable VAAPI stream encoding and use the specified device IE `/dev/dri/renderD128` |
100-
| DRINODE | Specify which GPU to use for DRI3 acceleration IE `/dev/dri/renderD129` |
182+
| DRI_NODE | **Encoding GPU**: Enable VAAPI/NVENC stream encoding and use the specified device IE `/dev/dri/renderD128` |
183+
| DRINODE | **Rendering GPU**: Specify which GPU to use for EGL/3D acceleration IE `/dev/dri/renderD129` |
101184
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
102185
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` |
103186
| TITLE | The page title displayed on the web browser, default "Selkies" |
@@ -123,105 +206,52 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
123206
- **5**: Centered
124207
- **6**: Animated
125208

126-
#### Optional Run Configurations
209+
</details>
210+
211+
<details>
212+
<summary>Click to expand: Optional Run Configurations (DinD & GPU Mounts)</summary>
127213

128214
| Argument | Description |
129215
| :----: | --- |
130216
| `--privileged` | Starts a Docker-in-Docker (DinD) environment. For better performance, mount the Docker data directory from the host, e.g., `-v /path/to/docker-data:/var/lib/docker`. |
131217
| `-v /var/run/docker.sock:/var/run/docker.sock` | Mounts the host's Docker socket to manage host containers from within this container. |
132-
| `--device /dev/dri:/dev/dri` | Mount a GPU into the container, this can be used in conjunction with the `DRINODE` environment variable to leverage a host video card for GPU accelerated applications. Only **Open Source** drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
218+
| `--device /dev/dri:/dev/dri` | Mount a GPU into the container, this can be used in conjunction with the `DRINODE` environment variable to leverage a host video card for GPU accelerated applications. |
133219

134-
### Language Support - Internationalization
220+
</details>
135221

136-
To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example:
222+
<details>
223+
<summary>Click to expand: Legacy X11 Resolution & Acceleration</summary>
137224

138-
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
139-
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
140-
* `-e LC_ALL=ko_KR.UTF-8` - Korean
141-
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
142-
* `-e LC_ALL=ru_RU.UTF-8` - Russian
143-
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
144-
* `-e LC_ALL=de_DE.UTF-8` - German
145-
* `-e LC_ALL=fr_FR.UTF-8` - French
146-
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
147-
* `-e LC_ALL=it_IT.UTF-8` - Italian
148-
149-
### SealSkin Compatibility
225+
**Note:** This section applies only if you are **NOT** using `PIXELFLUX_WAYLAND=true`.
150226

151-
This container is compatible with [SealSkin](https://github.com/linuxserver/docker-sealskin).
152-
153-
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.
154-
155-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
156-
* **Browser Extension:** [Install Here](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk)
157-
158-
### All GPU Acceleration - use sane resolutions
159-
160-
When using 3d acceleration via Nvidia DRM or DRI3 it is important to clamp the virtual display to a reasonable max resolution. This can be achieved with the environment setting:
227+
When using 3d acceleration via Nvidia DRM or DRI3 in X11 mode, it is important to clamp the virtual display to a reasonable max resolution to avoid memory exhaustion or poor performance.
161228

162229
* `-e MAX_RESOLUTION=3840x2160`
163230

164-
This will set the total virtual framebuffer to 4K, you can also set a manual resolution to achieve this.
165-
By default the virtual monitor in the session is 16K to support large monitors and dual display configurations. Leaving it this large has no impact on CPU based performance but costs GPU memory usage and memory bandwidth when leveraging one for acceleration. If you have performance issues in an accelerated session, try clamping the resolution to 1080p and work up from there:
231+
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:
166232

167233
```
168234
-e SELKIES_MANUAL_WIDTH=1920
169235
-e SELKIES_MANUAL_HEIGHT=1080
170236
-e MAX_RESOLUTION=1920x1080
171237
```
172238

173-
### DRI3 GPU Acceleration
174-
175-
For accelerated apps or games, render devices can be mounted into the container and leveraged by applications using:
176-
177-
`--device /dev/dri:/dev/dri`
178-
179-
This feature only supports **Open Source** GPU drivers:
180-
181-
| Driver | Description |
182-
| :----: | --- |
183-
| Intel | i965 and i915 drivers for Intel iGPU chipsets |
184-
| AMD | AMDGPU, Radeon, and ATI drivers for AMD dedicated or APU chipsets |
185-
| NVIDIA | nouveau2 drivers only, closed source NVIDIA drivers lack DRI3 support |
186-
187-
The `DRINODE` environment variable can be used to point to a specific GPU.
188-
189-
DRI3 will work on aarch64 given the correct drivers are installed inside the container for your chipset.
190-
191-
### Nvidia GPU Support
192-
193-
**Note: Nvidia support is not available for Alpine-based images.**
194-
195-
Nvidia GPU support is available by leveraging Zink for OpenGL. When a compatible Nvidia GPU is passed through, it will also be **automatically utilized for hardware-accelerated video stream encoding** (using the `x264enc` full-frame profile), significantly reducing CPU load.
239+
</details>
196240

197-
Enable Nvidia support with the following runtime flags:
198-
199-
| Flag | Description |
200-
| :----: | --- |
201-
| `--gpus all` | Passes all available host GPUs to the container. This can be filtered to specific GPUs. |
202-
| `--runtime nvidia` | Specifies the Nvidia runtime, which provides the necessary drivers and tools from the host. |
203-
204-
For Docker Compose, you must first configure the Nvidia runtime as the default on the host:
205-
206-
```
207-
sudo nvidia-ctk runtime configure --runtime=docker --set-as-default
208-
sudo systemctl restart docker
209-
```
241+
### Language Support - Internationalization
210242

211-
Then, assign the GPU to the service in your `compose.yaml`:
243+
To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example:
212244

213-
```
214-
services:
215-
bitcoin-knots:
216-
image: lscr.io/linuxserver/bitcoin-knots:latest
217-
deploy:
218-
resources:
219-
reservations:
220-
devices:
221-
- driver: nvidia
222-
count: 1
223-
capabilities: [compute,video,graphics,utility]
224-
```
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
225255

226256
### Application Management
227257

@@ -249,20 +279,19 @@ You can install packages from the system's native repository using the [universa
249279
- INSTALL_PACKAGES=libfuse2|git|gdb
250280
```
251281

252-
#### Hardening
253-
254-
These variables can be used to lock down the desktop environment for single-application use cases or to restrict user capabilities.
282+
### Advanced Configuration
255283

256-
##### Meta Variables
284+
<details>
285+
<summary>Click to expand: Hardening Options</summary>
257286

258-
These variables act as presets, enabling multiple hardening options at once. Individual options can still be set to override the preset.
287+
These variables can be used to lock down the desktop environment for single-application use cases or to restrict user capabilities.
259288

260289
| Variable | Description |
261290
| :----: | --- |
262291
| **`HARDEN_DESKTOP`** | Enables `DISABLE_OPEN_TOOLS`, `DISABLE_SUDO`, and `DISABLE_TERMINALS`. Also sets related Selkies UI settings (`SELKIES_FILE_TRANSFERS`, `SELKIES_COMMAND_ENABLED`, `SELKIES_UI_SIDEBAR_SHOW_FILES`, `SELKIES_UI_SIDEBAR_SHOW_APPS`) if they are not explicitly set by the user. |
263292
| **`HARDEN_OPENBOX`** | Enables `DISABLE_CLOSE_BUTTON`, `DISABLE_MOUSE_BUTTONS`, and `HARDEN_KEYBINDS`. It also flags `RESTART_APP` if not set by the user, ensuring the primary application is automatically restarted if closed. |
264293

265-
##### Individual Hardening Variables
294+
**Individual Hardening Variables:**
266295

267296
| Variable | Description |
268297
| :--- | --- |
@@ -274,46 +303,27 @@ These variables act as presets, enabling multiple hardening options at once. Ind
274303
| **`HARDEN_KEYBINDS`** | If true, disables default Openbox keybinds that can bypass other hardening options (e.g., `Alt+F4` to close windows, `Alt+Escape` to show the root menu). |
275304
| **`RESTART_APP`** | If true, enables a watchdog service that automatically restarts the main application if it is closed. The user's autostart script is made read-only and root owned to prevent tampering. |
276305

277-
#### Selkies application settings
278-
279-
Using environment variables every facet of the application can be configured.
280-
281-
##### Booleans and Locking
282-
Boolean settings accept `true` or `false`. You can also prevent the user from changing a boolean setting in the UI by appending `|locked`. The UI toggle for this setting will be hidden.
283-
284-
* **Example**: To force CPU encoding on and prevent the user from disabling it:
285-
```bash
286-
-e SELKIES_USE_CPU="true|locked"
287-
```
288-
289-
##### Enums and Lists
290-
These settings accept a comma-separated list of values. Their behavior depends on the number of items provided:
306+
</details>
291307

292-
* **Multiple Values**: The first item in the list becomes the default selection, and all items in the list become the available options in the UI dropdown.
293-
* **Single Value**: The provided value becomes the default, and the UI dropdown is hidden because the choice is locked.
308+
<details>
309+
<summary>Click to expand: Selkies Application Settings</summary>
294310

295-
* **Example**: Force the encoder to be `jpeg` with no other options available to the user:
296-
```bash
297-
-e SELKIES_ENCODER="jpeg"
298-
```
311+
Using environment variables every facet of the application can be configured.
299312

300-
##### Ranges
301-
Range settings define a minimum and maximum for a value (e.g., framerate).
313+
**Booleans and Locking:**
314+
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"`
302316

303-
* **To set a range**: Use a hyphen-separated `min-max` format. The UI will show a slider.
304-
* **To set a fixed value**: Provide a single number. This will lock the value and hide the UI slider.
317+
**Enums and Lists:**
318+
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"`
305320

306-
* **Example**: Lock the framerate to exactly 60 FPS.
307-
```bash
308-
-e SELKIES_FRAMERATE="60"
309-
```
310-
311-
##### Manual Resolution Mode
312-
The server can be forced to use a single, fixed resolution for all connecting clients. This mode is automatically activated if `SELKIES_MANUAL_WIDTH`, `SELKIES_MANUAL_HEIGHT`, or `SELKIES_IS_MANUAL_RESOLUTION_MODE` is set.
321+
**Ranges:**
322+
Use a hyphen-separated `min-max` format for a slider, or a single number to lock the value.
323+
* Example: `-e SELKIES_FRAMERATE="60"`
313324

314-
* If `SELKIES_MANUAL_WIDTH` and/or `SELKIES_MANUAL_HEIGHT` are set, the resolution is locked to those values.
315-
* If `SELKIES_IS_MANUAL_RESOLUTION_MODE` is set to `true` without specifying width or height, the resolution defaults to **1024x768**.
316-
* When this mode is active, the client UI for changing resolution is disabled.
325+
**Manual Resolution Mode:**
326+
If `SELKIES_MANUAL_WIDTH` or `SELKIES_MANUAL_HEIGHT` are set, the resolution is locked to those values.
317327

318328
| Environment Variable | Default Value | Description |
319329
| --- | --- | --- |
@@ -374,12 +384,14 @@ The server can be forced to use a single, fixed resolution for all connecting cl
374384
| `SELKIES_ENABLE_PLAYER3` | `True` | Enable sharing link for gamepad player 3. |
375385
| `SELKIES_ENABLE_PLAYER4` | `True` | Enable sharing link for gamepad player 4. |
376386

387+
</details>
388+
377389
## Usage
378390

379391
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
380392

381393
>[!NOTE]
382-
>Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided.
394+
>Unless a parameter is flagged as 'optional', it is *mandatory* and a value must be provided.
383395

384396
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
385397

0 commit comments

Comments
 (0)