You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+94-32Lines changed: 94 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,55 +58,116 @@ The architectures supported by this image are:
58
58
59
59
The application can be accessed at:
60
60
61
-
*http://yourhost:3000/
62
61
*https://yourhost:3001/
63
62
64
-
### Options in all KasmVNC based GUI containers
63
+
### Strict reverse proxies
65
64
66
-
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.
65
+
This image uses a self-signed certificate by default. This naturally means the scheme is `https`.
66
+
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).
67
67
68
-
#### Optional environment variables
68
+
**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.**
69
69
70
-
| Variable | Description |
71
-
| :----: | --- |
72
-
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
73
-
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
76
-
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/`|
77
-
| TITLE |The page title displayed on the web browser, default "KasmVNC Client". |
78
-
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
79
-
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
80
-
| 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`|
81
-
| LC_ALL | Set the Language for the container to run as IE `fr_FR.UTF-8``ar_AE.UTF-8`|
82
-
| NO_DECOR | If set the application will run without window borders for use as a PWA. |
83
-
| NO_FULL | Do not autmatically fullscreen applications when using openbox. |
84
-
85
-
#### Optional run configurations
70
+
### Security
71
+
72
+
>[!WARNING]
73
+
>This container provides privileged access to the host system. Do not expose it to the Internet unless you have secured it properly.
74
+
75
+
**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.
76
+
77
+
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.
78
+
79
+
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.
80
+
81
+
### Options in all Selkies-based GUI containers
82
+
83
+
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.
84
+
85
+
#### Optional Environment Variables
86
86
87
87
| Variable | Description |
88
88
| :----: | --- |
89
-
|`--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`. |
90
-
|`-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. |
91
-
|`--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 appplications. Only **Open Source** drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
89
+
|`CUSTOM_PORT`| Internal HTTP port. Defaults to `3000`. |
90
+
|`CUSTOM_HTTPS_PORT`| Internal HTTPS port. Defaults to `3001`. |
91
+
|`CUSTOM_USER`| Username for HTTP Basic Auth. Defaults to `abc`. |
92
+
|`PASSWORD`| Password for HTTP Basic Auth. If unset, authentication is disabled. |
93
+
|`SUBFOLDER`| Application subfolder for reverse proxy configurations. Must include leading and trailing slashes, e.g., `/subfolder/`. |
94
+
|`TITLE`| Page title displayed in the web browser. Defaults to "Selkies". |
95
+
|`START_DOCKER`| If set to `false`, the privileged Docker-in-Docker setup will not start automatically. |
96
+
|`DISABLE_IPV6`| Set to `true` to disable IPv6 support in the container. |
97
+
|`LC_ALL`| Sets the container's locale, e.g., `fr_FR.UTF-8`. |
98
+
|`DRINODE`| If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE `/dev/dri/renderD128`|
99
+
|`NO_DECOR`| If set, applications will run without window borders, suitable for PWA usage. |
100
+
|`NO_FULL`| If set, applications will not be automatically fullscreened. |
101
+
|`DISABLE_ZINK`| If set, Zink-related environment variables will not be configured when a video card is detected. |
102
+
|`WATERMARK_PNG`| Full path to a watermark PNG file inside the container, e.g., `/usr/share/selkies/www/icon.png`. |
|`--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`. |
110
+
|`-v /var/run/docker.sock:/var/run/docker.sock`| Mounts the host's Docker socket to manage host containers from within this container. |
111
+
|`--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) |
92
112
93
113
### Language Support - Internationalization
94
114
95
-
The environment variable `LC_ALL` can be used to start this image 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. We only ensure fonts for Latin characters are present. Fonts can be installed with a mod on startup.
115
+
To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example:
The `DRINODE` environment variable can be used to point to a specific GPU.
143
+
144
+
DRI3 will work on aarch64 given the correct drivers are installed inside the container for your chipset.
145
+
146
+
### Application Management
147
+
148
+
There are two methods for installing applications inside the container: PRoot Apps (recommended for persistence) and Native Apps.
149
+
150
+
#### PRoot Apps (Persistent)
151
+
152
+
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.
153
+
154
+
To install an application, use the command line inside the container:
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.
160
+
A list of supported applications is available [here](https://github.com/linuxserver/proot-apps?tab=readme-ov-file#supported-apps).
106
161
107
-
###Lossless mode
162
+
#### Native Apps (Non-Persistent)
108
163
109
-
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information [here](https://www.kasmweb.com/docs/latest/how_to/lossless.html#technical-background). In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined [here](https://github.com/linuxserver/docker-baseimage-kasmvnc#lossless).
164
+
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`:
|`-e PUID=1000`| for UserID - see below for explanation |
165
226
|`-e PGID=1000`| for GroupID - see below for explanation |
@@ -329,4 +390,5 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
329
390
330
391
## Versions
331
392
393
+
***29.07.25:** - Rebase to selkies. Breaking Change: HTTPS is now required. Either use a reverse proxy with SSL cert or direct connect to port 8181 with HTTPS.
Copy file name to clipboardExpand all lines: readme-vars.yml
+4-48Lines changed: 4 additions & 48 deletions
Original file line number
Diff line number
Diff line change
@@ -19,65 +19,20 @@ param_volumes:
19
19
- {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "User's home directory in the container, stores program settings and files."}
- {run_var: "seccomp=unconfined", compose_var: "seccomp:unconfined", desc: "For Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker."}
27
+
# Selkies blurb settings
28
+
selkies_blurb: true
27
29
# application setup block
28
30
app_setup_block_enabled: true
29
31
app_setup_block: |
30
32
The application can be accessed at:
31
33
32
-
* http://yourhost:3000/
33
34
* https://yourhost:3001/
34
35
35
-
### Options in all KasmVNC based GUI containers
36
-
37
-
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.
38
-
39
-
#### Optional environment variables
40
-
41
-
| Variable | Description |
42
-
| :----: | --- |
43
-
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
44
-
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
47
-
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` |
48
-
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
49
-
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
50
-
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
51
-
| 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` |
52
-
| LC_ALL | Set the Language for the container to run as IE `fr_FR.UTF-8` `ar_AE.UTF-8` |
53
-
| NO_DECOR | If set the application will run without window borders for use as a PWA. |
54
-
| NO_FULL | Do not autmatically fullscreen applications when using openbox. |
55
-
56
-
#### Optional run configurations
57
-
58
-
| Variable | Description |
59
-
| :----: | --- |
60
-
| `--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`. |
61
-
| `-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. |
62
-
| `--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 appplications. Only **Open Source** drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
63
-
64
-
### Language Support - Internationalization
65
-
66
-
The environment variable `LC_ALL` can be used to start this image 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. We only ensure fonts for Latin characters are present. Fonts can be installed with a mod on startup.
67
-
68
-
To install cjk fonts on startup as an example pass the environment variables:
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.
77
-
78
-
### Lossless mode
79
-
80
-
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information [here](https://www.kasmweb.com/docs/latest/how_to/lossless.html#technical-background). In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined [here](https://github.com/linuxserver/docker-baseimage-kasmvnc#lossless).
81
36
# init diagram
82
37
init_diagram: |
83
38
"rawtherapee:latest": {
@@ -140,4 +95,5 @@ init_diagram: |
140
95
"rawtherapee:latest" <- Base Images
141
96
# changelog
142
97
changelogs:
98
+
- {date: "29.07.25:", desc: "Rebase to selkies. Breaking Change: HTTPS is now required. Either use a reverse proxy with SSL cert or direct connect to port 8181 with HTTPS."}
0 commit comments