kopia lustrzana https://github.com/linuxserver/docker-documentation
209 wiersze
12 KiB
Markdown
209 wiersze
12 KiB
Markdown
|
---
|
||
|
|
title: kasm
|
||
|
|
---
|
||
|
|
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
||
|
|
<!-- Please read the https://github.com/linuxserver/docker-kasm/blob/master/.github/CONTRIBUTING.md -->
|
||
|
|
|
||
|
|
# [linuxserver/kasm](https://github.com/linuxserver/docker-kasm)
|
||
|
|
|
||
|
|
[](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fkasm)
|
||
|
|
[](https://github.com/linuxserver/docker-kasm)
|
||
|
|
[](https://github.com/linuxserver/docker-kasm/releases)
|
||
|
|
[](https://github.com/linuxserver/docker-kasm/packages)
|
||
|
|
[](https://gitlab.com/linuxserver.io/docker-kasm/container_registry)
|
||
|
|
[](https://quay.io/repository/linuxserver.io/kasm)
|
||
|
|
[](https://hub.docker.com/r/linuxserver/kasm)
|
||
|
|
[](https://hub.docker.com/r/linuxserver/kasm)
|
||
|
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-kasm/job/master/)
|
||
|
|
[](https://ci-tests.linuxserver.io/linuxserver/kasm/latest/index.html)
|
||
|
|
|
||
|
|
[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.
|
||
|
|
|
||
|
|
The rendering of the graphical-based containers is powered by the open-source project [KasmVNC](https://www.kasmweb.com/kasmvnc.html?utm_campaign=LinuxServer&utm_source=kasmvnc).
|
||
|
|
|
||
|
|
## Supported Architectures
|
||
|
|
|
||
|
|
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
||
|
|
|
||
|
|
Simply pulling `lscr.io/linuxserver/kasm:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
|
||
|
|
|
||
|
|
The architectures supported by this image are:
|
||
|
|
|
||
|
|
| Architecture | Available | Tag |
|
||
|
|
| :----: | :----: | ---- |
|
||
|
|
| x86-64 | ✅ | amd64-\<version tag\> |
|
||
|
|
| arm64 | ✅ | arm64v8-\<version tag\> |
|
||
|
|
| armhf | ❌ | |
|
||
|
|
|
||
|
|
## Version Tags
|
||
|
|
|
||
|
|
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
|
||
|
|
|
||
|
|
| Tag | Available | Description |
|
||
|
|
| :----: | :----: |--- |
|
||
|
|
| latest | ✅ | Stable Kasm releases |
|
||
|
|
| develop | ✅ | Tip of develop |
|
||
|
|
## Application Setup
|
||
|
|
|
||
|
|
This container uses [Docker in Docker](https://www.docker.com/blog/docker-can-now-run-within-docker/) and requires being run in `privileged` mode. This container also requires an initial setup that runs on port 3000.
|
||
|
|
|
||
|
|
**Unlike other containers the web interface port (default 443) needs to be set for the env variable `KASM_PORT` and both the inside and outside port IE for 4443 `KASM_PORT=4443` `-p 4443:4443`**
|
||
|
|
|
||
|
|
**Unraid users due to the DinD storage layer `/opt/` should be mounted directly to a disk IE `/mnt/disk1/appdata/path` or optimally with a cache disk at `/mnt/cache/appdata/path`**
|
||
|
|
|
||
|
|
Access the installation wizard at https://`your ip`:3000 and follow the instructions there. Once setup is complete access https://`your ip`:443 and login with the credentials you entered during setup. The default users are:
|
||
|
|
|
||
|
|
* admin@kasm.local
|
||
|
|
* user@kasm.local
|
||
|
|
|
||
|
|
Currently Synology systems are not supported due to them blocking CPU scheduling in their Kernel.
|
||
|
|
|
||
|
|
### GPU Support
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
### Gamepad support
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
### Persistant profiles
|
||
|
|
|
||
|
|
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).
|
||
|
|
|
||
|
|
### Reverse proxy
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
### Strict reverse proxies
|
||
|
|
|
||
|
|
This image uses a self-signed certificate by default. This naturally means the scheme is `https`.
|
||
|
|
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).
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
|
||
|
|
|
||
|
|
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
---
|
||
|
|
version: "2.1"
|
||
|
|
services:
|
||
|
|
kasm:
|
||
|
|
image: lscr.io/linuxserver/kasm:latest
|
||
|
|
container_name: kasm
|
||
|
|
privileged: true
|
||
|
|
environment:
|
||
|
|
- KASM_PORT=443
|
||
|
|
- DOCKER_HUB_USERNAME=USER #optional
|
||
|
|
- DOCKER_HUB_PASSWORD=PASS #optional
|
||
|
|
- DOCKER_MTU=1500 #optional
|
||
|
|
volumes:
|
||
|
|
- /path/to/data:/opt
|
||
|
|
- /path/to/profiles:/profiles #optional
|
||
|
|
- /dev/input:/dev/input #optional
|
||
|
|
- /run/udev/data:/run/udev/data #optional
|
||
|
|
ports:
|
||
|
|
- 3000:3000
|
||
|
|
- 443:443
|
||
|
|
restart: unless-stopped
|
||
|
|
```
|
||
|
|
|
||
|
|
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
|
||
|
|
|
||
|
|
```bash
|
||
|
|
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
|
||
|
|
|
||
|
|
```
|
||
|
|
|
||
|
|
## Parameters
|
||
|
|
|
||
|
|
Docker images 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.
|
||
|
|
|
||
|
|
### Ports (`-p`)
|
||
|
|
|
||
|
|
| Parameter | Function |
|
||
|
|
| :----: | --- |
|
||
|
|
| `3000` | Kasm Installation wizard. (https) |
|
||
|
|
| `443` | Kasm Workspaces interface. (https) |
|
||
|
|
|
||
|
|
### Environment Variables (`-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. |
|
||
|
|
|
||
|
|
### Volume Mappings (`-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. |
|
||
|
|
|
||
|
|
#### Miscellaneous Options
|
||
|
|
|
||
|
|
| Parameter | Function |
|
||
|
|
| :-----: | --- |
|
||
|
|
|
||
|
|
## Environment variables from files (Docker secrets)
|
||
|
|
|
||
|
|
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||
|
|
|
||
|
|
As an example:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
||
|
|
```
|
||
|
|
|
||
|
|
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
|
||
|
|
|
||
|
|
## Umask for running applications
|
||
|
|
|
||
|
|
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](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
||
|
|
|
||
|
|
## Docker Mods
|
||
|
|
|
||
|
|
[](https://mods.linuxserver.io/?mod=kasm "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
|
||
|
|
|
||
|
|
We publish various [Docker Mods](https://github.com/linuxserver/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.
|
||
|
|
|
||
|
|
## Support Info
|
||
|
|
|
||
|
|
* Shell access whilst the container is running:
|
||
|
|
* `docker exec -it kasm /bin/bash`
|
||
|
|
* To monitor the logs of the container in realtime:
|
||
|
|
* `docker logs -f kasm`
|
||
|
|
* Container version number
|
||
|
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' kasm`
|
||
|
|
* Image version number
|
||
|
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/kasm:latest`
|
||
|
|
|
||
|
|
## Versions
|
||
|
|
|
||
|
|
* **22.08.23:** - Update base image for 1.14.0 release.
|
||
|
|
* **07.04.23:** - Add mod layer for ingesting LSIO images for 1.13.0 release.
|
||
|
|
* **28.03.23:** - Pin compose to 2.5.0 to be in sync with upstream requirements.
|
||
|
|
* **05.11.22:** - Rebase to Jammy, add support for GPUs, add support for Gamepads.
|
||
|
|
* **23.09.22:** - Migrate to s6v3.
|
||
|
|
* **02.07.22:** - Initial Release.
|