docker run -d \
--name=kasm \
--privileged \
- -e KASM_PORT=443 \
- -e DOCKER_HUB_USERNAME=USER `#optional` \
- -e DOCKER_HUB_PASSWORD=PASS `#optional` \
- -e DOCKER_MTU=1500 `#optional` \
- -p 3000:3000 \
- -p 443:443 \
- -v /path/to/data:/opt \
- -v /path/to/profiles:/profiles `#optional` \
- -v /dev/input:/dev/input `#optional` \
- -v /run/udev/data:/run/udev/data `#optional` \
- --restart unless-stopped \
- lscr.io/linuxserver/kasm:latest
-Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.
-p)¶| Parameter | Function |
|---|---|
3000 | Kasm Installation wizard. (https) |
443 | Kasm Workspaces interface. (https) |
-e)¶| Env | Function |
|---|---|
KASM_PORT=443 | Specify the port you bind to the outside for Kasm Workspaces. |
DOCKER_HUB_USERNAME=USER | Optionally specify a DockerHub Username to pull private images. |
DOCKER_HUB_PASSWORD=PASS | Optionally specify a DockerHub password to pull private images. |
DOCKER_MTU=1500 | Optionally specify the mtu options passed to dockerd. |
-v)¶| Volume | Function |
|---|---|
/opt | Docker and installation storage. |
/profiles | Optionally specify a path for persistent profile storage. |
/dev/input | Optional for gamepad support. |
/run/udev/data | Optional for gamepad support. |
| Parameter | Function |
|---|---|
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
-e FILE__MYVAR=/run/secrets/mysecretvariable
+ --security-opt apparmor=rootlesskit `#optional` \
+ -e KASM_PORT=443 \
+ -e DOCKER_HUB_USERNAME=USER `#optional` \
+ -e DOCKER_HUB_PASSWORD=PASS `#optional` \
+ -e DOCKER_MTU=1500 `#optional` \
+ -p 3000:3000 \
+ -p 443:443 \
+ -v /path/to/data:/opt \
+ -v /path/to/profiles:/profiles `#optional` \
+ -v /dev/input:/dev/input `#optional` \
+ -v /run/udev/data:/run/udev/data `#optional` \
+ --restart unless-stopped \
+ lscr.io/linuxserver/kasm:latest
+Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.
-p)¶| Parameter | Function |
|---|---|
3000 | Kasm Installation wizard. (https) |
443 | Kasm Workspaces interface. (https) |
-e)¶| Env | Function |
|---|---|
KASM_PORT=443 | Specify the port you bind to the outside for Kasm Workspaces. |
DOCKER_HUB_USERNAME=USER | Optionally specify a DockerHub Username to pull private images. |
DOCKER_HUB_PASSWORD=PASS | Optionally specify a DockerHub password to pull private images. |
DOCKER_MTU=1500 | Optionally specify the mtu options passed to dockerd. |
-v)¶| Volume | Function |
|---|---|
/opt | Docker and installation storage. |
/profiles | Optionally specify a path for persistent profile storage. |
/dev/input | Optional for gamepad support. |
/run/udev/data | Optional for gamepad support. |
| Parameter | Function |
|---|---|
--security-opt apparmor=rootlesskit | Some hosts require this on top of privileged for namespacing to work properly inside the DinD layer. |
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
Shell access whilst the container is running:
To monitor the logs of the container in realtime:
Container version number:
docker inspect -f '{{ index .Config.Labels "build_version" }}' kasm
@@ -54,4 +57,4 @@
--pull \
-t lscr.io/linuxserver/kasm:latest .
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.