Skip to content

Commit c302d4d

Browse files
LinuxServer-CILinuxServer-CI
committed
Bot Updating Templated Files
1 parent 95de6d1 commit c302d4d

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
@@ -84,11 +84,94 @@ The web interface includes a terminal with passwordless `sudo` access. Any user
8484

8585
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.
8686

87+
### Hardware Acceleration & The Move to Wayland
88+
89+
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.
90+
91+
**Important:** GPU acceleration support for X11 is being deprecated. Future development for hardware acceleration will focus entirely on the Wayland stack.
92+
93+
To enable Wayland mode, set the following environment variable:
94+
* `-e PIXELFLUX_WAYLAND=true`
95+
96+
**Why use Wayland?**
97+
* **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.
98+
* **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.
99+
100+
#### GPU Configuration
101+
102+
To use hardware acceleration in Wayland mode, we distinguish between the card used for **Rendering** (3D apps/Desktops) and **Encoding** (Video Stream).
103+
104+
**Configuration Variables:**
105+
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
106+
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
107+
108+
If both variables point to the same device, the container will automatically enable **Zero Copy** encoding, significantly reducing CPU usage and latency.
109+
110+
##### Intel & AMD (Open Source Drivers)
111+
112+
For Intel and AMD GPUs.
113+
114+
```yaml
115+
devices:
116+
- /dev/dri:/dev/dri
117+
environment:
118+
- PIXELFLUX_WAYLAND=true
119+
# Optional: Specify device if multiple exist (IE: /dev/dri/renderD129)
120+
- DRINODE=/dev/dri/renderD128
121+
- DRI_NODE=/dev/dri/renderD128
122+
```
123+
124+
##### Nvidia (Proprietary Drivers)
125+
126+
**Note: Nvidia support is not available for Alpine-based images.**
127+
128+
**Prerequisites:**
129+
1. **Driver:** Proprietary drivers **580 or higher** are required.
130+
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
131+
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
132+
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
133+
```bash
134+
sudo nvidia-ctk runtime configure --runtime=docker
135+
sudo systemctl restart docker
136+
```
137+
138+
**Compose Configuration:**
139+
140+
```yaml
141+
services:
142+
digikam:
143+
image: lscr.io/linuxserver/digikam:latest
144+
environment:
145+
- PIXELFLUX_WAYLAND=true
146+
# Ensure these point to the rendered node injected by the runtime (usually renderD128)
147+
- DRINODE=/dev/dri/renderD128
148+
- DRI_NODE=/dev/dri/renderD128
149+
deploy:
150+
resources:
151+
reservations:
152+
devices:
153+
- driver: nvidia
154+
count: 1
155+
capabilities: [compute,video,graphics,utility]
156+
```
157+
158+
### SealSkin Compatibility
159+
160+
This container is compatible with [SealSkin](https://sealskin.app).
161+
162+
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.
163+
164+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
165+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
166+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
167+
168+
87169
### Options in all Selkies-based GUI containers
88170

89-
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.
171+
This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies).
90172

91-
#### Optional Environment Variables
173+
<details>
174+
<summary>Click to expand: Optional Environment Variables</summary>
92175

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

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

129215
| Argument | Description |
130216
| :----: | --- |
131217
| `--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`. |
132218
| `-v /var/run/docker.sock:/var/run/docker.sock` | Mounts the host's Docker socket to manage host containers from within this container. |
133-
| `--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) |
219+
| `--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. |
134220

135-
### Language Support - Internationalization
221+
</details>
136222

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

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

152-
This container is compatible with [SealSkin](https://github.com/linuxserver/docker-sealskin).
153-
154-
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.
155-
156-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
157-
* **Browser Extension:** [Install Here](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk)
158-
159-
### All GPU Acceleration - use sane resolutions
160-
161-
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:
228+
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.
162229

163230
* `-e MAX_RESOLUTION=3840x2160`
164231

165-
This will set the total virtual framebuffer to 4K, you can also set a manual resolution to achieve this.
166-
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:
232+
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:
167233

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

174-
### DRI3 GPU Acceleration
175-
176-
For accelerated apps or games, render devices can be mounted into the container and leveraged by applications using:
177-
178-
`--device /dev/dri:/dev/dri`
179-
180-
This feature only supports **Open Source** GPU drivers:
181-
182-
| Driver | Description |
183-
| :----: | --- |
184-
| Intel | i965 and i915 drivers for Intel iGPU chipsets |
185-
| AMD | AMDGPU, Radeon, and ATI drivers for AMD dedicated or APU chipsets |
186-
| NVIDIA | nouveau2 drivers only, closed source NVIDIA drivers lack DRI3 support |
187-
188-
The `DRINODE` environment variable can be used to point to a specific GPU.
189-
190-
DRI3 will work on aarch64 given the correct drivers are installed inside the container for your chipset.
191-
192-
### Nvidia GPU Support
193-
194-
**Note: Nvidia support is not available for Alpine-based images.**
195-
196-
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.
240+
</details>
197241

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

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

214-
```
215-
services:
216-
digikam:
217-
image: lscr.io/linuxserver/digikam:latest
218-
deploy:
219-
resources:
220-
reservations:
221-
devices:
222-
- driver: nvidia
223-
count: 1
224-
capabilities: [compute,video,graphics,utility]
225-
```
246+
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
247+
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
248+
* `-e LC_ALL=ko_KR.UTF-8` - Korean
249+
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
250+
* `-e LC_ALL=ru_RU.UTF-8` - Russian
251+
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
252+
* `-e LC_ALL=de_DE.UTF-8` - German
253+
* `-e LC_ALL=fr_FR.UTF-8` - French
254+
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
255+
* `-e LC_ALL=it_IT.UTF-8` - Italian
226256

227257
### Application Management
228258

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

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

257-
##### Meta Variables
285+
<details>
286+
<summary>Click to expand: Hardening Options</summary>
258287

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

261290
| Variable | Description |
262291
| :----: | --- |
263292
| **`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. |
264293
| **`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. |
265294

266-
##### Individual Hardening Variables
295+
**Individual Hardening Variables:**
267296

268297
| Variable | Description |
269298
| :--- | --- |
@@ -275,46 +304,27 @@ These variables act as presets, enabling multiple hardening options at once. Ind
275304
| **`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). |
276305
| **`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. |
277306

278-
#### Selkies application settings
279-
280-
Using environment variables every facet of the application can be configured.
281-
282-
##### Booleans and Locking
283-
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.
284-
285-
* **Example**: To force CPU encoding on and prevent the user from disabling it:
286-
```bash
287-
-e SELKIES_USE_CPU="true|locked"
288-
```
289-
290-
##### Enums and Lists
291-
These settings accept a comma-separated list of values. Their behavior depends on the number of items provided:
307+
</details>
292308

293-
* **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.
294-
* **Single Value**: The provided value becomes the default, and the UI dropdown is hidden because the choice is locked.
309+
<details>
310+
<summary>Click to expand: Selkies Application Settings</summary>
295311

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

301-
##### Ranges
302-
Range settings define a minimum and maximum for a value (e.g., framerate).
314+
**Booleans and Locking:**
315+
Boolean settings accept `true` or `false`. You can also prevent the user from changing a boolean setting in the UI by appending `|locked`.
316+
* Example: `-e SELKIES_USE_CPU="true|locked"`
303317

304-
* **To set a range**: Use a hyphen-separated `min-max` format. The UI will show a slider.
305-
* **To set a fixed value**: Provide a single number. This will lock the value and hide the UI slider.
318+
**Enums and Lists:**
319+
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.
320+
* Example: `-e SELKIES_ENCODER="jpeg"`
306321

307-
* **Example**: Lock the framerate to exactly 60 FPS.
308-
```bash
309-
-e SELKIES_FRAMERATE="60"
310-
```
311-
312-
##### Manual Resolution Mode
313-
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.
322+
**Ranges:**
323+
Use a hyphen-separated `min-max` format for a slider, or a single number to lock the value.
324+
* Example: `-e SELKIES_FRAMERATE="60"`
314325

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

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

388+
</details>
389+
378390
## Usage
379391

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

382394
>[!NOTE]
383-
>Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided.
395+
>Unless a parameter is flagged as 'optional', it is *mandatory* and a value must be provided.
384396

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

0 commit comments

Comments
 (0)