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
+8-91Lines changed: 8 additions & 91 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,12 +59,10 @@ The architectures supported by this image are:
59
59
60
60
## Application Setup
61
61
62
-
The Kali Linux image can be accessed at:
62
+
The application can be accessed at:
63
63
64
-
*http://yourhost:3000/
65
64
*https://yourhost:3001/
66
65
67
-
**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**
68
66
69
67
### Security
70
68
@@ -73,68 +71,7 @@ The Kali Linux image can be accessed at:
73
71
74
72
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.
75
73
76
-
### Options in all KasmVNC based GUI containers
77
-
78
-
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.
79
-
80
-
#### Optional environment variables
81
-
82
-
| Variable | Description |
83
-
| :----: | --- |
84
-
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
85
-
| 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 |
88
-
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/`|
89
-
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
90
-
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
91
-
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
92
-
| 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`|
93
-
| DISABLE_IPV6 | If set to true or any value this will disable IPv6 |
94
-
| LC_ALL | Set the Language for the container to run as IE `fr_FR.UTF-8``ar_AE.UTF-8`|
95
-
| NO_DECOR | If set the application will run without window borders in openbox for use as a PWA. |
96
-
| NO_FULL | Do not autmatically fullscreen applications when using openbox. |
97
-
98
-
#### Optional run configurations
99
-
100
-
| Variable | Description |
101
-
| :----: | --- |
102
-
|`--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`. |
103
-
|`-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. |
104
-
|`--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) |
105
-
106
-
### Language Support - Internationalization
107
-
108
-
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.
109
-
110
-
To install cjk fonts on startup as an example pass the environment variables (Alpine base):
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.
119
-
120
-
### DRI3 GPU Acceleration (KasmVNC interface)
121
-
122
-
For accelerated apps or games, render devices can be mounted into the container and leveraged by applications using:
123
-
124
-
`--device /dev/dri:/dev/dri`
125
-
126
-
This feature only supports **Open Source** GPU drivers:
127
-
128
-
| Driver | Description |
129
-
| :----: | --- |
130
-
| Intel | i965 and i915 drivers for Intel iGPU chipsets |
131
-
| AMD | AMDGPU, Radeon, and ATI drivers for AMD dedicated or APU chipsets |
The `DRINODE` environment variable can be used to point to a specific GPU.
135
-
Up to date information can be found [here](https://www.kasmweb.com/kasmvnc/docs/master/gpu_acceleration.html)
136
-
137
-
### Nvidia GPU Support (KasmVNC interface)
74
+
### Nvidia GPU Support
138
75
139
76
**Nvidia support is not compatible with Alpine based images as Alpine lacks Nvidia drivers**
140
77
@@ -156,8 +93,8 @@ And to assign the GPU in compose:
156
93
157
94
```
158
95
services:
159
-
kali-linux:
160
-
image: lscr.io/linuxserver/kali-linux:latest
96
+
webtop:
97
+
image: lscr.io/linuxserver/suyu:latest
161
98
deploy:
162
99
resources:
163
100
reservations:
@@ -167,27 +104,10 @@ services:
167
104
capabilities: [compute,video,graphics,utility]
168
105
```
169
106
170
-
### Application management
171
-
172
-
#### PRoot Apps
173
-
174
-
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:
107
+
### Strict reverse proxies
175
108
176
-
```
177
-
proot-apps install filezilla
178
-
```
179
-
180
-
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).
181
-
182
-
#### Native Apps
183
-
184
-
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.
This image uses a self-signed certificate by default. This naturally means the scheme is `https`.
110
+
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).
@@ -260,7 +177,6 @@ Containers are configured using parameters passed at runtime (such as those abov
260
177
|`-e TITLE=Kali Linux`| String which will be used as page/tab title in the web browser. |
261
178
|`-v /config`| abc users home directory |
262
179
|`-v /var/run/docker.sock`| Docker Socket on the system, if you want to use Docker in the container |
263
-
|`--device /dev/dri`| Add this for GL support (Linux hosts only) |
264
180
|`--shm-size=`| We set this to 1 gig to prevent modern web browsers from crashing |
265
181
|`--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
182
@@ -426,5 +342,6 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
Copy file name to clipboardExpand all lines: readme-vars.yml
+44-75Lines changed: 44 additions & 75 deletions
Original file line number
Diff line number
Diff line change
@@ -37,87 +37,56 @@ opt_custom_params:
37
37
opt_security_opt_param: true
38
38
opt_security_opt_param_vars:
39
39
- {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."}
40
-
opt_param_device_map: true
41
-
opt_param_devices:
42
-
- {device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "Add this for GL support (Linux hosts only)"}
>Do not put this on the Internet if you do not know what you are doing.
52
+
53
+
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.
54
+
55
+
### Nvidia GPU Support
56
+
57
+
**Nvidia support is not compatible with Alpine based images as Alpine lacks Nvidia drivers**
58
+
59
+
Nvidia support is available by leveraging Zink for OpenGL support. This can be enabled with the following run flags:
60
+
61
+
| Variable | Description |
62
+
| :----: | --- |
63
+
| --gpus all | This can be filtered down but for most setups this will pass the one Nvidia GPU on the system |
64
+
| --runtime nvidia | Specify the Nvidia runtime which mounts drivers and tools in from the host |
65
+
66
+
The compose syntax is slightly different for this as you will need to set nvidia as the default runtime:
0 commit comments