Skip to content

Commit 9e99a25

Browse files
committed
rebase to ubuntu noble and selkies
1 parent eeb5a0f commit 9e99a25

6 files changed

Lines changed: 108 additions & 142 deletions

File tree

.github/workflows/external_trigger.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,12 @@ jobs:
110110
echo "New version \`${EXT_RELEASE}\` found; but there already seems to be an active build on Jenkins; exiting" >> $GITHUB_STEP_SUMMARY
111111
exit 0
112112
else
113+
assets=$(curl -u "${{ secrets.CR_USER }}:${{ secrets.CR_PAT }}" -sX GET "https://api.github.com/repos/SoftFever/OrcaSlicer/releases/tags/${EXT_RELEASE}" | jq -r '.assets[].browser_download_url')
114+
if grep -q "OrcaSlicer_Linux_AppImage_Ubuntu2404" <<< "${assets}"; then
115+
artifacts_found="true"
116+
else
117+
artifacts_found="false"
118+
fi
113119
if [[ "${artifacts_found}" == "false" ]]; then
114120
echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
115121
echo "> New version detected, but not all artifacts are published yet; skipping trigger" >> $GITHUB_STEP_SUMMARY

Dockerfile

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
FROM ghcr.io/linuxserver/baseimage-kasmvnc:debianbookworm
1+
# syntax=docker/dockerfile:1
2+
3+
FROM ghcr.io/linuxserver/baseimage-selkies:ubuntunoble
24

35
# set version label
46
ARG BUILD_DATE
@@ -9,18 +11,20 @@ LABEL maintainer="thelamer"
911

1012
# title
1113
ENV TITLE=OrcaSlicer \
12-
SSL_CERT_FILE=/etc/ssl/certs/ca-certificates.crt
14+
SSL_CERT_FILE=/etc/ssl/certs/ca-certificates.crt \
15+
NO_GAMEPAD=true
1316

1417
RUN \
1518
echo "**** add icon ****" && \
1619
curl -o \
17-
/kclient/public/icon.png \
20+
/usr/share/selkies/www/icon.png \
1821
https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/orcaslicer-logo.png && \
1922
echo "**** install packages ****" && \
23+
add-apt-repository ppa:xtradeb/apps && \
2024
apt-get update && \
2125
DEBIAN_FRONTEND=noninteractive \
2226
apt-get install --no-install-recommends -y \
23-
firefox-esr \
27+
firefox \
2428
gstreamer1.0-alsa \
2529
gstreamer1.0-gl \
2630
gstreamer1.0-gtk3 \
@@ -33,23 +37,25 @@ RUN \
3337
gstreamer1.0-qt5 \
3438
gstreamer1.0-tools \
3539
gstreamer1.0-x \
36-
libgstreamer1.0 \
3740
libgstreamer-plugins-bad1.0 \
38-
libgstreamer-plugins-base1.0 \
39-
libwebkit2gtk-4.0-37 \
41+
libwebkit2gtk-4.1-0 \
4042
libwx-perl && \
41-
echo "**** install oracaslicer from appimage ****" && \
43+
echo "**** install orcaslicer from appimage ****" && \
4244
if [ -z ${ORCASLICER_VERSION+x} ]; then \
4345
ORCASLICER_VERSION=$(curl -sX GET "https://api.github.com/repos/SoftFever/OrcaSlicer/releases/latest" \
4446
| awk '/tag_name/{print $4;exit}' FS='[""]'); \
4547
fi && \
48+
RELEASE_URL=$(curl -sX GET "https://api.github.com/repos/SoftFever/OrcaSlicer/releases/latest" | awk '/url/{print $4;exit}' FS='[""]') && \
49+
DOWNLOAD_URL=$(curl -sX GET "${RELEASE_URL}" | awk '/browser_download_url.*Ubuntu2404/{print $4;exit}' FS='[""]') && \
4650
cd /tmp && \
4751
curl -o \
4852
/tmp/orca.app -L \
49-
"https://github.com/SoftFever/OrcaSlicer/releases/download/${ORCASLICER_VERSION}/OrcaSlicer_Linux_AppImage_$(echo ${ORCASLICER_VERSION} | sed 's/\b\(.\)/\u\1/g').AppImage" && \
53+
"${DOWNLOAD_URL}" && \
5054
chmod +x /tmp/orca.app && \
5155
./orca.app --appimage-extract && \
5256
mv squashfs-root /opt/orcaslicer && \
57+
localedef -i en_GB -f UTF-8 en_GB.UTF-8 && \
58+
printf "Linuxserver.io version: ${VERSION}\nBuild-date: ${BUILD_DATE}" > /build_version && \
5359
echo "**** cleanup ****" && \
5460
apt-get autoclean && \
5561
rm -rf \
@@ -63,5 +69,5 @@ RUN \
6369
COPY /root /
6470

6571
# ports and volumes
66-
EXPOSE 3000
72+
EXPOSE 3001
6773
VOLUME /config

README.md

Lines changed: 72 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -58,63 +58,70 @@ The architectures supported by this image are:
5858

5959
The application can be accessed at:
6060

61-
* http://yourhost:3000/
6261
* https://yourhost:3001/
6362

64-
**Modern GUI desktop apps have issues with the latest Docker and syscall compatibility, you can use Docker with the `--security-opt seccomp=unconfined` setting to allow these syscalls on hosts with older Kernels or libseccomp**
63+
**Modern GUI desktop apps may have compatibility issues with the latest Docker syscall restrictions. You can use Docker with the `--security-opt seccomp=unconfined` setting to allow these syscalls on hosts with older Kernels or libseccomp versions.**
6564

6665
### Security
6766

6867
>[!WARNING]
69-
>Do not put this on the Internet if you do not know what you are doing.
68+
>This container provides privileged access to the host system. Do not expose it to the Internet unless you have secured it properly.
7069
71-
By default this container has no authentication and the optional environment variables `CUSTOM_USER` and `PASSWORD` to enable basic http auth via the embedded NGINX server should only be used to locally secure the container from unwanted access on a local network. If exposing this to the Internet we recommend putting it behind a reverse proxy, such as [SWAG](https://github.com/linuxserver/docker-swag), and ensuring a secure authentication solution is in place. From the web interface a terminal can be launched and it is configured for passwordless sudo, so anyone with access to it can install and run whatever they want along with probing your local network.
70+
**HTTPS is required for full functionality.** Modern browser features such as WebCodecs, used for video and audio, will not function over an insecure HTTP connection.
7271

73-
### Options in all KasmVNC based GUI containers
72+
By default, this container has no authentication. The optional `CUSTOM_USER` and `PASSWORD` environment variables enable basic HTTP auth, which is suitable only for securing the container on a trusted local network. For internet exposure, we strongly recommend placing the container behind a reverse proxy, such as [SWAG](https://github.com/linuxserver/docker-swag), with a robust authentication mechanism.
7473

75-
This container is based on [Docker Baseimage KasmVNC](https://github.com/linuxserver/docker-baseimage-kasmvnc) which means there are additional environment variables and run configurations to enable or disable specific functionality.
74+
The web interface includes a terminal with passwordless `sudo` access. Any user with access to the GUI can gain root control within the container, install arbitrary software, and probe your local network.
7675

77-
#### Optional environment variables
76+
### Options in all Selkies-based GUI containers
7877

79-
| Variable | Description |
80-
| :----: | --- |
81-
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
82-
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
83-
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
84-
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
85-
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` |
86-
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
87-
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
88-
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
89-
| DRINODE | If mounting in /dev/dri for [DRI3 GPU Acceleration](https://www.kasmweb.com/kasmvnc/docs/master/gpu_acceleration.html) allows you to specify the device to use IE `/dev/dri/renderD128` |
90-
| DISABLE_IPV6 | If set to true or any value this will disable IPv6 |
91-
| LC_ALL | Set the Language for the container to run as IE `fr_FR.UTF-8` `ar_AE.UTF-8` |
92-
| NO_DECOR | If set the application will run without window borders in openbox for use as a PWA. |
93-
| NO_FULL | Do not autmatically fullscreen applications when using openbox. |
94-
95-
#### Optional run configurations
78+
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.
79+
80+
#### Optional Environment Variables
9681

9782
| Variable | Description |
9883
| :----: | --- |
99-
| `--privileged` | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE `-v /home/user/docker-data:/var/lib/docker`. |
100-
| `-v /var/run/docker.sock:/var/run/docker.sock` | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
84+
| `CUSTOM_PORT` | Internal HTTP port. Defaults to `3000`. |
85+
| `CUSTOM_HTTPS_PORT` | Internal HTTPS port. Defaults to `3001`. |
86+
| `CUSTOM_WS_PORT` | Internal port the container listens on for websockets if it needs to be swapped from the default 8082. |
87+
| `CUSTOM_USER` | Username for HTTP Basic Auth. Defaults to `abc`. |
88+
| `PASSWORD` | Password for HTTP Basic Auth. If unset, authentication is disabled. |
89+
| `SUBFOLDER` | Application subfolder for reverse proxy configurations. Must include leading and trailing slashes, e.g., `/subfolder/`. |
90+
| `TITLE` | Page title displayed in the web browser. Defaults to "Selkies". |
91+
| `START_DOCKER` | If set to `false`, the privileged Docker-in-Docker setup will not start automatically. |
92+
| `DISABLE_IPV6` | Set to `true` to disable IPv6 support in the container. |
93+
| `LC_ALL` | Sets the container's locale, e.g., `fr_FR.UTF-8`. |
94+
| `DRINODE` | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE `/dev/dri/renderD128` |
95+
| `NO_DECOR` | If set, applications will run without window borders, suitable for PWA usage. |
96+
| `NO_FULL` | If set, applications will not be automatically fullscreened. |
97+
| `DISABLE_ZINK` | If set, Zink-related environment variables will not be configured when a video card is detected. |
98+
| `WATERMARK_PNG` | Full path to a watermark PNG file inside the container, e.g., `/usr/share/selkies/www/icon.png`. |
99+
| `WATERMARK_LOCATION` | Integer specifying the watermark location: `1` (Top Left), `2` (Top Right), `3` (Bottom Left), `4` (Bottom Right), `5` (Centered), `6` (Animated). |
100+
101+
#### Optional Run Configurations
102+
103+
| Argument | Description |
104+
| :----: | --- |
105+
| `--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`. |
106+
| `-v /var/run/docker.sock:/var/run/docker.sock` | Mounts the host's Docker socket to manage host containers from within this container. |
101107
| `--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) |
102108

103109
### Language Support - Internationalization
104110

105-
The environment variable `LC_ALL` can be used to start this container in a different language than English simply pass for example to launch the Desktop session in French `LC_ALL=fr_FR.UTF-8`. Some languages like Chinese, Japanese, or Korean will be missing fonts needed to render properly known as cjk fonts, but others may exist and not be installed inside the container depending on what underlying distribution you are running. We only ensure fonts for Latin characters are present. Fonts can be installed with a mod on startup.
111+
To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example:
106112

107-
To install cjk fonts on startup as an example pass the environment variables (Alpine base):
108-
109-
```
110-
-e DOCKER_MODS=linuxserver/mods:universal-package-install
111-
-e INSTALL_PACKAGES=fonts-noto-cjk
112-
-e LC_ALL=zh_CN.UTF-8
113-
```
113+
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
114+
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
115+
* `-e LC_ALL=ko_KR.UTF-8` - Korean
116+
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
117+
* `-e LC_ALL=ru_RU.UTF-8` - Russian
118+
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
119+
* `-e LC_ALL=de_DE.UTF-8` - German
120+
* `-e LC_ALL=fr_FR.UTF-8` - French
121+
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
122+
* `-e LC_ALL=it_IT.UTF-8` - Italian
114123

115-
The web interface has the option for "IME Input Mode" in Settings which will allow non english characters to be used from a non en_US keyboard on the client. Once enabled it will perform the same as a local Linux installation set to your locale.
116-
117-
### DRI3 GPU Acceleration (KasmVNC interface)
124+
### DRI3 GPU Acceleration
118125

119126
For accelerated apps or games, render devices can be mounted into the container and leveraged by applications using:
120127

@@ -129,27 +136,30 @@ This feature only supports **Open Source** GPU drivers:
129136
| NVIDIA | nouveau2 drivers only, closed source NVIDIA drivers lack DRI3 support |
130137

131138
The `DRINODE` environment variable can be used to point to a specific GPU.
132-
Up to date information can be found [here](https://www.kasmweb.com/kasmvnc/docs/master/gpu_acceleration.html)
133139

134-
### Nvidia GPU Support (KasmVNC interface)
140+
DRI3 will work on aarch64 given the correct drivers are installed inside the container for your chipset.
135141

136-
**Nvidia support is not compatible with Alpine based images as Alpine lacks Nvidia drivers**
142+
### Nvidia GPU Support
137143

138-
Nvidia support is available by leveraging Zink for OpenGL support. This can be enabled with the following run flags:
144+
**Note: Nvidia support is not available for Alpine-based images.**
139145

140-
| Variable | Description |
146+
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.
147+
148+
Enable Nvidia support with the following runtime flags:
149+
150+
| Flag | Description |
141151
| :----: | --- |
142-
| --gpus all | This can be filtered down but for most setups this will pass the one Nvidia GPU on the system |
143-
| --runtime nvidia | Specify the Nvidia runtime which mounts drivers and tools in from the host |
152+
| `--gpus all` | Passes all available host GPUs to the container. This can be filtered to specific GPUs. |
153+
| `--runtime nvidia` | Specifies the Nvidia runtime, which provides the necessary drivers and tools from the host. |
144154

145-
The compose syntax is slightly different for this as you will need to set nvidia as the default runtime:
155+
For Docker Compose, you must first configure the Nvidia runtime as the default on the host:
146156

147157
```
148158
sudo nvidia-ctk runtime configure --runtime=docker --set-as-default
149-
sudo service docker restart
159+
sudo systemctl restart docker
150160
```
151161

152-
And to assign the GPU in compose:
162+
Then, assign the GPU to the service in your `compose.yaml`:
153163

154164
```
155165
services:
@@ -164,21 +174,25 @@ services:
164174
capabilities: [compute,video,graphics,utility]
165175
```
166176

167-
### Application management
177+
### Application Management
178+
179+
There are two methods for installing applications inside the container: PRoot Apps (recommended for persistence) and Native Apps.
180+
181+
#### PRoot Apps (Persistent)
168182

169-
#### PRoot Apps
183+
Natively installed packages (e.g., via `apt-get install`) will not persist if the container is recreated. To retain applications and their settings across container updates, we recommend using [proot-apps](https://github.com/linuxserver/proot-apps). These are portable applications installed to the user's persistent `$HOME` directory.
170184

171-
If you run system native installations of software IE `sudo apt-get install filezilla` and then upgrade or destroy/re-create the container that software will be removed and the container will be at a clean state. For some users that will be acceptable and they can update their system packages as well using system native commands like `apt-get upgrade`. If you want Docker to handle upgrading the container and retain your applications and settings we have created [proot-apps](https://github.com/linuxserver/proot-apps) which allow portable applications to be installed to persistent storage in the user's `$HOME` directory and they will work in a confined Docker environment out of the box. These applications and their settings will persist upgrades of the base container and can be mounted into different flavors of KasmVNC based containers on the fly. This can be achieved from the command line with:
185+
To install an application, use the command line inside the container:
172186

173187
```
174188
proot-apps install filezilla
175189
```
176190

177-
PRoot Apps is included in all KasmVNC based containers, a list of linuxserver.io supported applications is located [HERE](https://github.com/linuxserver/proot-apps?tab=readme-ov-file#supported-apps).
191+
A list of supported applications is available [here](https://github.com/linuxserver/proot-apps?tab=readme-ov-file#supported-apps).
178192

179-
#### Native Apps
193+
#### Native Apps (Non-Persistent)
180194

181-
It is possible to install extra packages during container start using [universal-package-install](https://github.com/linuxserver/docker-mods/tree/universal-package-install). It might increase starting time significantly. PRoot is preferred.
195+
You can install packages from the system's native repository using the [universal-package-install](https://github.com/linuxserver/docker-mods/tree/universal-package-install) mod. This method will increase the container's start time and is not persistent. Add the following to your `compose.yaml`:
182196

183197
```yaml
184198
environment:
@@ -201,8 +215,6 @@ services:
201215
orcaslicer:
202216
image: lscr.io/linuxserver/orcaslicer:latest
203217
container_name: orcaslicer
204-
security_opt:
205-
- seccomp:unconfined #optional
206218
environment:
207219
- PUID=1000
208220
- PGID=1000
@@ -212,6 +224,7 @@ services:
212224
ports:
213225
- 3000:3000
214226
- 3001:3001
227+
shm_size: "1gb" #optional
215228
restart: unless-stopped
216229
```
217230
@@ -220,13 +233,13 @@ services:
220233
```bash
221234
docker run -d \
222235
--name=orcaslicer \
223-
--security-opt seccomp=unconfined `#optional` \
224236
-e PUID=1000 \
225237
-e PGID=1000 \
226238
-e TZ=Etc/UTC \
227239
-p 3000:3000 \
228240
-p 3001:3001 \
229241
-v /path/to/config:/config \
242+
--shm-size="1gb" `#optional` \
230243
--restart unless-stopped \
231244
lscr.io/linuxserver/orcaslicer:latest
232245
```
@@ -237,13 +250,13 @@ Containers are configured using parameters passed at runtime (such as those abov
237250

238251
| Parameter | Function |
239252
| :----: | --- |
240-
| `-p 3000:3000` | Orca Slicer desktop gui. |
253+
| `-p 3000:3000` | Orca Slicer desktop gui HTTP, must be proxied. |
241254
| `-p 3001:3001` | Orca Slicer desktop gui HTTPS. |
242255
| `-e PUID=1000` | for UserID - see below for explanation |
243256
| `-e PGID=1000` | for GroupID - see below for explanation |
244257
| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
245258
| `-v /config` | Users home directory in the container, stores program settings and files. |
246-
| `--security-opt seccomp=unconfined` | For Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker. |
259+
| `--shm-size=` | We set this to 1 gig to prevent modern web browsers from crashing |
247260

248261
## Environment variables from files (Docker secrets)
249262

@@ -407,5 +420,6 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
407420

408421
## Versions
409422

423+
* **15.09.25:** - Rebase to Ubuntu Noble and Selkies, HTTPS is now required.
410424
* **10.02.24:** - Update Readme with new env vars and ingest proper PWA icon.
411425
* **15.11.23:** - Initial release.

jenkins-vars.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ external_type: github_stable
66
release_type: stable
77
release_tag: latest
88
ls_branch: master
9+
external_artifact_check: |
10+
assets=$(curl -u "${{ '{{' }} secrets.CR_USER {{ '}}' }}:${{ '{{' }} secrets.CR_PAT {{ '}}' }}" -sX GET "https://api.github.com/repos/SoftFever/OrcaSlicer/releases/tags/${EXT_RELEASE}" | jq -r '.assets[].browser_download_url')
11+
if grep -q "OrcaSlicer_Linux_AppImage_Ubuntu2404" <<< "${assets}"; then
12+
artifacts_found="true"
13+
else
14+
artifacts_found="false"
15+
fi
916
repo_vars:
1017
- EXT_USER = 'SoftFever'
1118
- EXT_REPO = 'OrcaSlicer'

0 commit comments

Comments
 (0)