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
+36-2Lines changed: 36 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,7 +56,37 @@ The architectures supported by this image are:
56
56
57
57
## Application Setup
58
58
59
-
The webui will be accessible at http://SERVERIP:PORT
59
+
The webui will be accessible at http://SERVERIP:3000 or https://SERVERIP:3001
60
+
61
+
### Options in all KasmVNC based GUI containers
62
+
63
+
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.
64
+
65
+
#### Optional environment variables
66
+
67
+
| Variable | Description |
68
+
| :----: | --- |
69
+
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
70
+
| 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 |
73
+
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/`|
74
+
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
75
+
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
76
+
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
77
+
| 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`|
78
+
79
+
#### Optional run configurations
80
+
81
+
| Variable | Description |
82
+
| :----: | --- |
83
+
|`--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`. |
84
+
|`-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. |
85
+
|`--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) |
86
+
87
+
### Lossless mode
88
+
89
+
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).
60
90
61
91
## Usage
62
92
@@ -79,6 +109,7 @@ services:
79
109
- TZ=Europe/London
80
110
ports:
81
111
- 3000:3000
112
+
- 3001:3001
82
113
volumes:
83
114
- /path/to/appdata:/config
84
115
restart: unless-stopped
@@ -94,6 +125,7 @@ docker run -d \
94
125
-e PGID=1000 \
95
126
-e TZ=Europe/London \
96
127
-p 3000:3000 \
128
+
-p 3001:3001 \
97
129
-v /path/to/appdata:/config \
98
130
--restart unless-stopped \
99
131
lscr.io/linuxserver-labs/nomacs:latest
@@ -108,7 +140,8 @@ Container images are configured using parameters passed at runtime (such as thos
108
140
|`-e PUID=1000`| for UserID - see below for explanation |
109
141
|`-e PGID=1000`| for GroupID - see below for explanation |
110
142
|`-e TZ=Europe/London`| Specify a timezone to use EG Europe/London. |
111
-
|`-p 3000`| The webui port. |
143
+
|`-p 3000`| The webui http port. |
144
+
|`-p 3001`| The webui https port. |
112
145
|`-v /config`| The folder on host you'd like the app data to reside in. |
113
146
|`--security-opt seccomp=unconfined`| For Docker Engine only, many modern gui apps need this to function as syscalls are unkown to Docker. |
114
147
@@ -221,5 +254,6 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
221
254
222
255
## Versions
223
256
257
+
***27.03.22:** - Rebase to the new kasmvnc baseimage. Deprecate arm32v7 build as the new base does not support it.
224
258
***10.12.22:** - Add support for AVIF and JPEG XL.
0 commit comments