Skip to content

Commit 15c2fc6

Browse files
authored
Merge pull request #5 from linuxserver/wayland-default
make wayland default
2 parents d3003f7 + c0d1c9c commit 15c2fc6

4 files changed

Lines changed: 121 additions & 92 deletions

File tree

Dockerfile

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ ARG SIGNAL_VERSION
1010
LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
1111
LABEL maintainer="thelamer"
1212

13-
ENV TITLE="Signal"
13+
ENV TITLE="Signal" \
14+
NO_GAMEPAD=true \
15+
PIXELFLUX_WAYLAND=true
1416

1517
RUN \
1618
echo "**** add icon ****" && \

Jenkinsfile

Lines changed: 85 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ pipeline {
7575
'''
7676
script{
7777
env.EXIT_STATUS = ''
78+
env.CI_TEST_ATTEMPTED = ''
7879
env.LS_RELEASE = sh(
7980
script: '''docker run --rm quay.io/skopeo/stable:v1 inspect docker://ghcr.io/${LS_USER}/${CONTAINER_NAME}:latest 2>/dev/null | jq -r '.Labels.build_version' | awk '{print $3}' | grep '\\-ls' || : ''',
8081
returnStdout: true).trim()
@@ -871,6 +872,7 @@ pipeline {
871872
script{
872873
env.CI_URL = 'https://ci-tests.linuxserver.io/' + env.IMAGE + '/' + env.META_TAG + '/index.html'
873874
env.CI_JSON_URL = 'https://ci-tests.linuxserver.io/' + env.IMAGE + '/' + env.META_TAG + '/report.json'
875+
env.CI_TEST_ATTEMPTED = 'true'
874876
}
875877
sh '''#! /bin/bash
876878
set -e
@@ -1073,98 +1075,13 @@ EOF
10731075
) '''
10741076
}
10751077
}
1076-
// If this is a Pull request send the CI link as a comment on it
1077-
stage('Pull Request Comment') {
1078-
when {
1079-
not {environment name: 'CHANGE_ID', value: ''}
1080-
environment name: 'EXIT_STATUS', value: ''
1081-
}
1082-
steps {
1083-
sh '''#! /bin/bash
1084-
# Function to retrieve JSON data from URL
1085-
get_json() {
1086-
local url="$1"
1087-
local response=$(curl -s "$url")
1088-
if [ $? -ne 0 ]; then
1089-
echo "Failed to retrieve JSON data from $url"
1090-
return 1
1091-
fi
1092-
local json=$(echo "$response" | jq .)
1093-
if [ $? -ne 0 ]; then
1094-
echo "Failed to parse JSON data from $url"
1095-
return 1
1096-
fi
1097-
echo "$json"
1098-
}
1099-
1100-
build_table() {
1101-
local data="$1"
1102-
1103-
# Get the keys in the JSON data
1104-
local keys=$(echo "$data" | jq -r 'to_entries | map(.key) | .[]')
1105-
1106-
# Check if keys are empty
1107-
if [ -z "$keys" ]; then
1108-
echo "JSON report data does not contain any keys or the report does not exist."
1109-
return 1
1110-
fi
1111-
1112-
# Build table header
1113-
local header="| Tag | Passed |\\n| --- | --- |\\n"
1114-
1115-
# Loop through the JSON data to build the table rows
1116-
local rows=""
1117-
for build in $keys; do
1118-
local status=$(echo "$data" | jq -r ".[\\"$build\\"].test_success")
1119-
if [ "$status" = "true" ]; then
1120-
status="✅"
1121-
else
1122-
status="❌"
1123-
fi
1124-
local row="| "$build" | "$status" |\\n"
1125-
rows="${rows}${row}"
1126-
done
1127-
1128-
local table="${header}${rows}"
1129-
local escaped_table=$(echo "$table" | sed 's/\"/\\\\"/g')
1130-
echo "$escaped_table"
1131-
}
1132-
1133-
if [[ "${CI}" = "true" ]]; then
1134-
# Retrieve JSON data from URL
1135-
data=$(get_json "$CI_JSON_URL")
1136-
# Create table from JSON data
1137-
table=$(build_table "$data")
1138-
echo -e "$table"
1139-
1140-
curl -X POST -H "Authorization: token $GITHUB_TOKEN" \
1141-
-H "Accept: application/vnd.github.v3+json" \
1142-
"https://api.github.com/repos/$LS_USER/$LS_REPO/issues/$PULL_REQUEST/comments" \
1143-
-d "{\\"body\\": \\"I am a bot, here are the test results for this PR: \\n${CI_URL}\\n${SHELLCHECK_URL}\\n${table}\\"}"
1144-
else
1145-
curl -X POST -H "Authorization: token $GITHUB_TOKEN" \
1146-
-H "Accept: application/vnd.github.v3+json" \
1147-
"https://api.github.com/repos/$LS_USER/$LS_REPO/issues/$PULL_REQUEST/comments" \
1148-
-d "{\\"body\\": \\"I am a bot, here is the pushed image/manifest for this PR: \\n\\n\\`${GITHUBIMAGE}:${META_TAG}\\`\\"}"
1149-
fi
1150-
'''
1151-
1152-
}
1153-
}
11541078
}
11551079
/* ######################
1156-
Send status to Discord
1080+
Comment on PR and Send status to Discord
11571081
###################### */
11581082
post {
11591083
always {
1160-
sh '''#!/bin/bash
1161-
rm -rf /config/.ssh/id_sign
1162-
rm -rf /config/.ssh/id_sign.pub
1163-
git config --global --unset gpg.format
1164-
git config --global --unset user.signingkey
1165-
git config --global --unset commit.gpgsign
1166-
'''
1167-
script{
1084+
script {
11681085
env.JOB_DATE = sh(
11691086
script: '''date '+%Y-%m-%dT%H:%M:%S%:z' ''',
11701087
returnStdout: true).trim()
@@ -1207,6 +1124,87 @@ EOF
12071124
"username": "Jenkins"}' ${BUILDS_DISCORD} '''
12081125
}
12091126
}
1127+
script {
1128+
if (env.GITHUBIMAGE =~ /lspipepr/){
1129+
if (env.CI_TEST_ATTEMPTED == "true"){
1130+
sh '''#! /bin/bash
1131+
# Function to retrieve JSON data from URL
1132+
get_json() {
1133+
local url="$1"
1134+
local response=$(curl -s "$url")
1135+
if [ $? -ne 0 ]; then
1136+
echo "Failed to retrieve JSON data from $url"
1137+
return 1
1138+
fi
1139+
local json=$(echo "$response" | jq .)
1140+
if [ $? -ne 0 ]; then
1141+
echo "Failed to parse JSON data from $url"
1142+
return 1
1143+
fi
1144+
echo "$json"
1145+
}
1146+
1147+
build_table() {
1148+
local data="$1"
1149+
1150+
# Get the keys in the JSON data
1151+
local keys=$(echo "$data" | jq -r 'to_entries | map(.key) | .[]')
1152+
1153+
# Check if keys are empty
1154+
if [ -z "$keys" ]; then
1155+
echo "JSON report data does not contain any keys or the report does not exist."
1156+
return 1
1157+
fi
1158+
1159+
# Build table header
1160+
local header="| Tag | Passed |\\n| --- | --- |\\n"
1161+
1162+
# Loop through the JSON data to build the table rows
1163+
local rows=""
1164+
for build in $keys; do
1165+
local status=$(echo "$data" | jq -r ".[\\"$build\\"].test_success")
1166+
if [ "$status" = "true" ]; then
1167+
status="✅"
1168+
else
1169+
status="❌"
1170+
fi
1171+
local row="| "$build" | "$status" |\\n"
1172+
rows="${rows}${row}"
1173+
done
1174+
1175+
local table="${header}${rows}"
1176+
local escaped_table=$(echo "$table" | sed 's/\"/\\\\"/g')
1177+
echo "$escaped_table"
1178+
}
1179+
1180+
if [[ "${CI}" = "true" ]]; then
1181+
# Retrieve JSON data from URL
1182+
data=$(get_json "$CI_JSON_URL")
1183+
# Create table from JSON data
1184+
table=$(build_table "$data")
1185+
echo -e "$table"
1186+
1187+
curl -X POST -H "Authorization: token $GITHUB_TOKEN" \
1188+
-H "Accept: application/vnd.github.v3+json" \
1189+
"https://api.github.com/repos/$LS_USER/$LS_REPO/issues/$PULL_REQUEST/comments" \
1190+
-d "{\\"body\\": \\"I am a bot, here are the test results for this PR: \\n${CI_URL}\\n${SHELLCHECK_URL}\\n${table}\\"}"
1191+
else
1192+
curl -X POST -H "Authorization: token $GITHUB_TOKEN" \
1193+
-H "Accept: application/vnd.github.v3+json" \
1194+
"https://api.github.com/repos/$LS_USER/$LS_REPO/issues/$PULL_REQUEST/comments" \
1195+
-d "{\\"body\\": \\"I am a bot, here is the pushed image/manifest for this PR: \\n\\n\\`${GITHUBIMAGE}:${META_TAG}\\`\\"}"
1196+
fi
1197+
'''
1198+
}
1199+
}
1200+
}
1201+
sh '''#!/bin/bash
1202+
rm -rf /config/.ssh/id_sign
1203+
rm -rf /config/.ssh/id_sign.pub
1204+
git config --global --unset gpg.format
1205+
git config --global --unset user.signingkey
1206+
git config --global --unset commit.gpgsign
1207+
'''
12101208
}
12111209
cleanup {
12121210
sh '''#! /bin/bash

README.md

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,9 @@ To use hardware acceleration in Wayland mode, we distinguish between the card us
107107
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
108108
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
109109

110-
If both variables point to the same device, the container will automatically enable **Zero Copy** encoding, significantly reducing CPU usage and latency.
110+
If both variables point to the same device, the container will automatically enable **Zero Copy** encoding, significantly reducing CPU usage and latency. If they are set to different devices one will be used for **Rendering** and one for **Encoding** with a cpu readback.
111+
112+
You can also use the environment variable `AUTO_GPU=true`, with this set the first card detected in the container (IE `/dev/dri/renderD128`) will be used and configured for **Zero Copy**.
111113

112114
##### Intel & AMD (Open Source Drivers)
113115

@@ -125,13 +127,34 @@ For Intel and AMD GPUs.
125127
126128
##### Nvidia (Proprietary Drivers)
127129
130+
**Note: Nvidia support is currently considered experimental, driver changes can break it at any time.**
131+
128132
**Note: Nvidia support is not available for Alpine-based images.**
129133
134+
**Note: Nvidia frames have issues with hardware decoders in Chromium browsers you need to navigate to `chrome://flags/#disable-accelerated-video-decode` and toggle it to `Disabled` for smooth playback**
135+
130136
**Prerequisites:**
131137

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.
138+
1. **Driver:** Proprietary drivers **580 or higher** are required. **Crucially, you should install the driver using the `.run` file downloaded directly from the Nvidia website.**
139+
* **Unraid:** Use the production branch from the Nvidia Driver Plugin.
140+
141+
2. **Kernel Parameter:** You must set `nvidia-drm.modeset=1 nvidia_drm.fbdev=1` in your host bootloader.
142+
* **Standard Linux (GRUB):** Edit `/etc/default/grub` and add the parameter to your existing `GRUB_CMDLINE_LINUX_DEFAULT` line:
143+
144+
```text
145+
GRUB_CMDLINE_LINUX_DEFAULT="<other existing options> nvidia-drm.modeset=1 nvidia_drm.fbdev=1"
146+
```
147+
148+
Then apply the changes by running:
149+
150+
```bash
151+
sudo update-grub
152+
```
153+
154+
* **Unraid (Syslinux):** Edit the file `/boot/syslinux/syslinux.cfg` and add `nvidia-drm.modeset=1 nvidia_drm.fbdev=1` to the end of the `append` line for the Unraid OS boot entry.
155+
156+
3. **Hardware Initialization:** **On headless systems, the Nvidia video card requires a physical dummy plug inserted into the GPU so that DRM initializes properly.**
157+
135158
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
136159

137160
```bash
@@ -160,6 +183,8 @@ services:
160183
capabilities: [compute,video,graphics,utility]
161184
```
162185

186+
* **Unraid:** Ensure you're properly setting the DRINODE/DRI_NODE and adding `--gpus all --runtime nvidia` to your extra parameters.
187+
163188
### SealSkin Compatibility
164189

165190
This container is compatible with [SealSkin](https://sealskin.app).
@@ -180,12 +205,14 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
180205
| Variable | Description |
181206
| :----: | --- |
182207
| PIXELFLUX_WAYLAND | **Experimental** If set to true the container will initialize in Wayland mode running [Smithay](https://github.com/Smithay/smithay) and Labwc while enabling zero copy encoding with a GPU |
208+
| SELKIES_DESKTOP | If set to true and in Wayland mode, a simple panel will be initialized with labwc |
183209
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default `3000` |
184210
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default `3001` |
185211
| CUSTOM_WS_PORT | Internal port the container listens on for websockets if it needs to be swapped from the default 8082 |
186212
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
187213
| DRI_NODE | **Encoding GPU**: Enable VAAPI/NVENC stream encoding and use the specified device IE `/dev/dri/renderD128` |
188214
| DRINODE | **Rendering GPU**: Specify which GPU to use for EGL/3D acceleration IE `/dev/dri/renderD129` |
215+
| AUTO_GPU | If set to true and in Wayland mode, we will automatically use the first GPU available for encoding and rendering IE `/dev/dri/renderD128` |
189216
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
190217
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` |
191218
| TITLE | The page title displayed on the web browser, default "Selkies" |
@@ -615,6 +642,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
615642

616643
## Versions
617644

645+
* **04.04.26:** - Make Wayland default disable with PIXELFLUX_WAYLAND=false.
618646
* **21.03.26:** - Use Wayland ozone platform fixes scaling and acceleration.
619647
* **28.12.25:** - Add Wayland init logic.
620648
* **02.12.25:** - Initial Version.

readme-vars.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ init_diagram: |
105105
"signal:latest" <- Base Images
106106
# changelog
107107
changelogs:
108+
- {date: "04.04.26:", desc: "Make Wayland default disable with PIXELFLUX_WAYLAND=false."}
108109
- {date: "21.03.26:", desc: "Use Wayland ozone platform fixes scaling and acceleration."}
109110
- {date: "28.12.25:", desc: "Add Wayland init logic."}
110111
- {date: "02.12.25:", desc: "Initial Version."}

0 commit comments

Comments
 (0)