Skip to content

Commit fdb4520

Browse files
Bot Updating Documentation
1 parent fef8518 commit fdb4520

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

docs/images/docker-kasm.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ The rendering of the graphical-based containers is powered by the open-source pr
2020
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/kasm.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/kasm)
2121
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/kasm.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/kasm)
2222
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-kasm%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-kasm/job/master/)
23-
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fkasm%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/kasm/latest/index.html)
2423

2524
[Kasm](https://www.kasmweb.com/?utm_campaign=LinuxServer&utm_source=listing) Workspaces is a docker container streaming platform for delivering browser-based access to desktops, applications, and web services. Kasm uses devops-enabled Containerized Desktop Infrastructure (CDI) to create on-demand, disposable, docker containers that are accessible via web browser. Example use-cases include Remote Browser Isolation (RBI), Data Loss Prevention (DLP), Desktop as a Service (DaaS), Secure Remote Access Services (RAS), and Open Source Intelligence (OSINT) collections.
2625

@@ -56,25 +55,27 @@ Access the installation wizard at https://`your ip`:3000 and follow the instruct
5655

5756
Currently Synology systems are not supported due to them blocking CPU scheduling in their Kernel.
5857

59-
### Updating KASM
58+
### Upgrading KASM
6059

61-
In order to update kasm, first make sure you are using the latest docker image, and then perform the in app update in the admin panel. Docker image update and recreation of container alone won't update kasm.
60+
In order to upgrade Kasm, first make sure you are using the latest docker image, and then perform the in app update from the installation wizard. Docker image update and recreation of container alone won't upgrade Kasm.
61+
62+
Following the upgrade, you will need to update any workspace image tags to match the new version.
6263

6364
### GPU Support
6465

65-
During installation an option will be presented to force all Workspace containers to mount in and use a specific GPU. If using an NVIDIA GPU you will need to pass `-e NVIDIA_VISIBLE_DEVICES=all` or `--gpus all` and have the [NVIDIA Container Runtime](https://github.com/NVIDIA/nvidia-container-runtime) installed on the host. Also if using NVIDIA, Kasm Workspaces has [native NVIDIA support](https://www.kasmweb.com/docs/latest/how_to/gpu.html) so you can optionally opt to simply use that instead of he manual override during installation.
66+
During installation an option will be presented to force all Workspace containers to mount in and use a specific GPU. If using an NVIDIA GPU you will need to pass `-e NVIDIA_VISIBLE_DEVICES=all` or `--gpus all` and have the [NVIDIA Container Toolkit](https://github.com/NVIDIA/nvidia-container-toolkit) installed on the host. Also if using NVIDIA, Kasm Workspaces has [native NVIDIA support](https://docs.kasm.com/docs/latest/how-to/gpu/index.html) so you can optionally opt to simply use that instead of he manual override during installation.
6667

6768
### Gamepad support
6869

69-
In order to properly create virtual Gamepads you will need to mount from your host `/dev/input` and `/run/udev/data`. Please see [HERE](https://www.kasmweb.com/docs/develop/guide/gamepad_passthrough.html) for instructions on enabling gamepad support.
70+
In order to properly create virtual Gamepads you will need to mount from your host `/dev/input` and `/run/udev/data`. Please see [HERE](https://docs.kasm.com/docs/latest/guide/gamepad_passthrough/index.html) for instructions on enabling gamepad support.
7071

7172
### Persistant profiles
7273

73-
In order to use persistant profiles in Workspaces you will need to mount in a folder to use from your host to `/profiles`. From there when configuring a workspace you can set the `Persistant Profile Path` to IE `/profiles/ubuntu-focal/{username}/`, more infomation can be found [HERE](https://www.kasmweb.com/docs/latest/how_to/persistent_profiles.html).
74+
In order to use persistant profiles in Workspaces you will need to mount in a folder to use from your host to `/profiles`. From there when configuring a workspace you can set the `Persistant Profile Path` to IE `/profiles/ubuntu-focal/{username}/`, more infomation can be found [HERE](https://docs.kasm.com/docs/latest/guide/persistent_data/persistent_profiles).
7475

7576
### Reverse proxy
7677

77-
A sample for [SWAG](https://github.com/linuxserver/docker-swag) can be found [here](https://raw.githubusercontent.com/linuxserver/reverse-proxy-confs/master/kasm.subdomain.conf.sample). Post installation you will need to modify the "Proxy Port" setting under the default zone to 0 as outlined [here](https://www.kasmweb.com/docs/latest/how_to/reverse_proxy.html#update-zones) to launch Workspaces sessions.
78+
A sample for [SWAG](https://github.com/linuxserver/docker-swag) can be found [here](https://raw.githubusercontent.com/linuxserver/reverse-proxy-confs/master/kasm.subdomain.conf.sample). Post installation you will need to modify the "Proxy Port" setting under the default zone to 0 as outlined [here](https://docs.kasm.com/docs/latest/how-to/reverse_proxy/index.html#update-zones) to launch Workspaces sessions.
7879

7980
### Strict reverse proxies
8081

@@ -113,6 +114,7 @@ services:
113114
ports:
114115
- 3000:3000
115116
- 443:443
117+
stop_grace_period: "90s" #optional
116118
restart: unless-stopped
117119
```
118120
@@ -133,6 +135,7 @@ docker run -d \
133135
-v /path/to/kasm/profiles:/profiles `#optional` \
134136
-v /dev/input:/dev/input `#optional` \
135137
-v /run/udev/data:/run/udev/data `#optional` \
138+
--stop-timeout="90s" `#optional` \
136139
--restart unless-stopped \
137140
lscr.io/linuxserver/kasm:latest
138141
```
@@ -170,6 +173,7 @@ Containers are configured using parameters passed at runtime (such as those abov
170173

171174
| Parameter | Function |
172175
| :-----: | --- |
176+
| `--stop-timeout=` | Increase container shutdown delay to give Kasm services time to stop cleanly. |
173177
| `--security-opt apparmor=rootlesskit` | Some hosts require this on top of privileged for namespacing to work properly inside the DinD layer. |
174178

175179
## Environment variables from files (Docker secrets)
@@ -352,11 +356,11 @@ To help with development, we generate this dependency graph.
352356
init-custom-files -> init-services
353357
init-services -> svc-cron
354358
svc-cron -> legacy-services
355-
init-config-kasm -> svc-docker
356359
init-services -> svc-docker
357360
svc-docker -> legacy-services
358-
init-config-kasm -> svc-kasm-wizard
359-
init-services -> svc-kasm-wizard
361+
svc-docker -> svc-kasm
362+
svc-kasm -> legacy-services
363+
svc-docker -> svc-kasm-wizard
360364
svc-kasm-wizard -> legacy-services
361365
}
362366
Base Images: {
@@ -367,6 +371,7 @@ To help with development, we generate this dependency graph.
367371

368372
## Versions
369373

374+
* **16.04.26:** - Update for 1.18.1 release. Use rolling service images. Bump docker to v29.
370375
* **13.11.25:** - Pin docker to v28 to avoid API deprecation issues.
371376
* **22.10.25:** - Update for 1.18.0 release.
372377
* **08.06.25:** - Deprecate develop branch.

0 commit comments

Comments
 (0)