Skip to content

Commit 0851e96

Browse files
Bot Updating Documentation
1 parent ab5b928 commit 0851e96

File tree

1 file changed

+101
-73
lines changed

1 file changed

+101
-73
lines changed

docs/images/docker-orcaslicer.md

Lines changed: 101 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -40,64 +40,76 @@ The architectures supported by this image are:
4040

4141
The application can be accessed at:
4242

43-
* http://yourhost:3000/
4443
* https://yourhost:3001/
4544

46-
**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**
45+
### Strict reverse proxies
46+
47+
This image uses a self-signed certificate by default. This naturally means the scheme is `https`.
48+
If you are using a reverse proxy which validates certificates, you need to [disable this check for the container](https://docs.linuxserver.io/faq#strict-proxy).
49+
50+
**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.**
4751

4852
### Security
4953

5054
!!! warning
5155

52-
Do not put this on the Internet if you do not know what you are doing.
56+
This container provides privileged access to the host system. Do not expose it to the Internet unless you have secured it properly.
5357

54-
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.
58+
**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.
5559

56-
### Options in all KasmVNC based GUI containers
60+
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.
5761

58-
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.
62+
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.
5963

60-
#### Optional environment variables
64+
### Options in all Selkies-based GUI containers
6165

62-
| Variable | Description |
63-
| :----: | --- |
64-
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
65-
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
66-
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
67-
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
68-
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` |
69-
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
70-
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
71-
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
72-
| 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` |
73-
| DISABLE_IPV6 | If set to true or any value this will disable IPv6 |
74-
| LC_ALL | Set the Language for the container to run as IE `fr_FR.UTF-8` `ar_AE.UTF-8` |
75-
| NO_DECOR | If set the application will run without window borders in openbox for use as a PWA. |
76-
| NO_FULL | Do not autmatically fullscreen applications when using openbox. |
77-
78-
#### Optional run configurations
66+
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.
67+
68+
#### Optional Environment Variables
7969

8070
| Variable | Description |
8171
| :----: | --- |
82-
| `--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`. |
83-
| `-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. |
72+
| `CUSTOM_PORT` | Internal HTTP port. Defaults to `3000`. |
73+
| `CUSTOM_HTTPS_PORT` | Internal HTTPS port. Defaults to `3001`. |
74+
| `CUSTOM_WS_PORT` | Internal port the container listens on for websockets if it needs to be swapped from the default 8082. |
75+
| `CUSTOM_USER` | Username for HTTP Basic Auth. Defaults to `abc`. |
76+
| `PASSWORD` | Password for HTTP Basic Auth. If unset, authentication is disabled. |
77+
| `SUBFOLDER` | Application subfolder for reverse proxy configurations. Must include leading and trailing slashes, e.g., `/subfolder/`. |
78+
| `TITLE` | Page title displayed in the web browser. Defaults to "Selkies". |
79+
| `START_DOCKER` | If set to `false`, the privileged Docker-in-Docker setup will not start automatically. |
80+
| `DISABLE_IPV6` | Set to `true` to disable IPv6 support in the container. |
81+
| `LC_ALL` | Sets the container's locale, e.g., `fr_FR.UTF-8`. |
82+
| `DRINODE` | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE `/dev/dri/renderD128` |
83+
| `NO_DECOR` | If set, applications will run without window borders, suitable for PWA usage. |
84+
| `NO_FULL` | If set, applications will not be automatically fullscreened. |
85+
| `DISABLE_ZINK` | If set, Zink-related environment variables will not be configured when a video card is detected. |
86+
| `WATERMARK_PNG` | Full path to a watermark PNG file inside the container, e.g., `/usr/share/selkies/www/icon.png`. |
87+
| `WATERMARK_LOCATION` | Integer specifying the watermark location: `1` (Top Left), `2` (Top Right), `3` (Bottom Left), `4` (Bottom Right), `5` (Centered), `6` (Animated). |
88+
89+
#### Optional Run Configurations
90+
91+
| Argument | Description |
92+
| :----: | --- |
93+
| `--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`. |
94+
| `-v /var/run/docker.sock:/var/run/docker.sock` | Mounts the host's Docker socket to manage host containers from within this container. |
8495
| `--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) |
8596

8697
### Language Support - Internationalization
8798

88-
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.
99+
To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example:
89100

90-
To install cjk fonts on startup as an example pass the environment variables (Alpine base):
101+
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
102+
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
103+
* `-e LC_ALL=ko_KR.UTF-8` - Korean
104+
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
105+
* `-e LC_ALL=ru_RU.UTF-8` - Russian
106+
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
107+
* `-e LC_ALL=de_DE.UTF-8` - German
108+
* `-e LC_ALL=fr_FR.UTF-8` - French
109+
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
110+
* `-e LC_ALL=it_IT.UTF-8` - Italian
91111

92-
```
93-
-e DOCKER_MODS=linuxserver/mods:universal-package-install
94-
-e INSTALL_PACKAGES=fonts-noto-cjk
95-
-e LC_ALL=zh_CN.UTF-8
96-
```
97-
98-
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.
99-
100-
### DRI3 GPU Acceleration (KasmVNC interface)
112+
### DRI3 GPU Acceleration
101113

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

@@ -112,27 +124,30 @@ This feature only supports **Open Source** GPU drivers:
112124
| NVIDIA | nouveau2 drivers only, closed source NVIDIA drivers lack DRI3 support |
113125

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

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

119-
**Nvidia support is not compatible with Alpine based images as Alpine lacks Nvidia drivers**
130+
### Nvidia GPU Support
120131

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

123-
| Variable | Description |
134+
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.
135+
136+
Enable Nvidia support with the following runtime flags:
137+
138+
| Flag | Description |
124139
| :----: | --- |
125-
| --gpus all | This can be filtered down but for most setups this will pass the one Nvidia GPU on the system |
126-
| --runtime nvidia | Specify the Nvidia runtime which mounts drivers and tools in from the host |
140+
| `--gpus all` | Passes all available host GPUs to the container. This can be filtered to specific GPUs. |
141+
| `--runtime nvidia` | Specifies the Nvidia runtime, which provides the necessary drivers and tools from the host. |
127142

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

130145
```
131146
sudo nvidia-ctk runtime configure --runtime=docker --set-as-default
132-
sudo service docker restart
147+
sudo systemctl restart docker
133148
```
134149

135-
And to assign the GPU in compose:
150+
Then, assign the GPU to the service in your `compose.yaml`:
136151

137152
```
138153
services:
@@ -147,27 +162,32 @@ services:
147162
capabilities: [compute,video,graphics,utility]
148163
```
149164

150-
### Application management
165+
### Application Management
166+
167+
There are two methods for installing applications inside the container: PRoot Apps (recommended for persistence) and Native Apps.
168+
169+
#### PRoot Apps (Persistent)
151170

152-
#### PRoot Apps
171+
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.
153172

154-
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:
173+
To install an application, use the command line inside the container:
155174

156175
```
157176
proot-apps install filezilla
158177
```
159178

160-
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).
179+
A list of supported applications is available [here](https://github.com/linuxserver/proot-apps?tab=readme-ov-file#supported-apps).
161180

162-
#### Native Apps
181+
#### Native Apps (Non-Persistent)
163182

164-
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.
183+
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`:
165184

166185
```yaml
167186
environment:
168187
- DOCKER_MODS=linuxserver/mods:universal-package-install
169188
- INSTALL_PACKAGES=libfuse2|git|gdb
170189
```
190+
171191
172192
## Usage
173193
@@ -185,8 +205,6 @@ services:
185205
orcaslicer:
186206
image: lscr.io/linuxserver/orcaslicer:latest
187207
container_name: orcaslicer
188-
security_opt:
189-
- seccomp:unconfined #optional
190208
environment:
191209
- PUID=1000
192210
- PGID=1000
@@ -196,6 +214,7 @@ services:
196214
ports:
197215
- 3000:3000
198216
- 3001:3001
217+
shm_size: "1gb" #optional
199218
restart: unless-stopped
200219
```
201220
@@ -204,13 +223,13 @@ services:
204223
```bash
205224
docker run -d \
206225
--name=orcaslicer \
207-
--security-opt seccomp=unconfined `#optional` \
208226
-e PUID=1000 \
209227
-e PGID=1000 \
210228
-e TZ=Etc/UTC \
211229
-p 3000:3000 \
212230
-p 3001:3001 \
213231
-v /path/to/config:/config \
232+
--shm-size="1gb" `#optional` \
214233
--restart unless-stopped \
215234
lscr.io/linuxserver/orcaslicer:latest
216235
```
@@ -223,7 +242,7 @@ Containers are configured using parameters passed at runtime (such as those abov
223242

224243
| Parameter | Function |
225244
| :----: | --- |
226-
| `3000:3000` | Orca Slicer desktop gui. |
245+
| `3000:3000` | Orca Slicer desktop gui HTTP, must be proxied. |
227246
| `3001:3001` | Orca Slicer desktop gui HTTPS. |
228247

229248
### Environment Variables (`-e`)
@@ -244,7 +263,7 @@ Containers are configured using parameters passed at runtime (such as those abov
244263

245264
| Parameter | Function |
246265
| :-----: | --- |
247-
| `--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. |
266+
| `--shm-size=` | We set this to 1 gig to prevent modern web browsers from crashing |
248267

249268
## Environment variables from files (Docker secrets)
250269

@@ -425,54 +444,63 @@ To help with development, we generate this dependency graph.
425444
custom services -> legacy-services
426445
legacy-services -> ci-service-check
427446
init-migrations -> init-adduser
428-
init-kasmvnc-end -> init-config
429447
init-os-end -> init-config
448+
init-selkies-end -> init-config
430449
init-config -> init-config-end
431450
init-crontab-config -> init-config-end
432451
init-config -> init-crontab-config
433452
init-mods-end -> init-custom-files
434453
init-adduser -> init-device-perms
435454
base -> init-envfile
436-
init-os-end -> init-kasmvnc
437-
init-nginx -> init-kasmvnc-config
438-
init-video -> init-kasmvnc-end
439455
base -> init-migrations
440456
init-config-end -> init-mods
441457
init-mods-package-install -> init-mods-end
442458
init-mods -> init-mods-package-install
443-
init-kasmvnc -> init-nginx
459+
init-selkies -> init-nginx
444460
init-adduser -> init-os-end
445461
init-device-perms -> init-os-end
446462
init-envfile -> init-os-end
463+
init-os-end -> init-selkies
464+
init-nginx -> init-selkies-config
465+
init-video -> init-selkies-end
447466
init-custom-files -> init-services
448-
init-kasmvnc-config -> init-video
467+
init-selkies-config -> init-video
449468
init-services -> svc-cron
450469
svc-cron -> legacy-services
470+
init-services -> svc-dbus
471+
svc-xorg -> svc-dbus
472+
svc-dbus -> legacy-services
451473
init-services -> svc-de
452474
svc-nginx -> svc-de
475+
svc-selkies -> svc-de
476+
svc-xorg -> svc-de
453477
svc-de -> legacy-services
454478
init-services -> svc-docker
455-
svc-de -> svc-docker
456479
svc-docker -> legacy-services
457-
init-services -> svc-kasmvnc
458-
svc-pulseaudio -> svc-kasmvnc
459-
svc-kasmvnc -> legacy-services
460-
init-services -> svc-kclient
461-
svc-kasmvnc -> svc-kclient
462-
svc-kclient -> legacy-services
463480
init-services -> svc-nginx
464-
svc-kclient -> svc-nginx
465481
svc-nginx -> legacy-services
466482
init-services -> svc-pulseaudio
467483
svc-pulseaudio -> legacy-services
484+
init-services -> svc-selkies
485+
svc-nginx -> svc-selkies
486+
svc-pulseaudio -> svc-selkies
487+
svc-xorg -> svc-selkies
488+
svc-selkies -> legacy-services
489+
init-services -> svc-xorg
490+
svc-xorg -> legacy-services
491+
init-services -> svc-xsettingsd
492+
svc-nginx -> svc-xsettingsd
493+
svc-xorg -> svc-xsettingsd
494+
svc-xsettingsd -> legacy-services
468495
}
469496
Base Images: {
470-
"baseimage-kasmvnc:debianbookworm" <- "baseimage-debian:bookworm"
497+
"baseimage-selkies:ubuntunoble" <- "baseimage-ubuntu:noble"
471498
}
472499
"orcaslicer:latest" <- Base Images
473500
```
474501

475502
## Versions
476503

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

0 commit comments

Comments
 (0)