You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
modules/kasmvnc/README.md

38 lines
1.1 KiB
Markdown

---
display_name: KasmVNC
description: A modern open source VNC server
icon: ../.icons/kasmvnc.svg
maintainer_github: coder
verified: true
tags: [helper, vnc, desktop]
---
# KasmVNC
Automatically install [KasmVNC](https://kasmweb.com/kasmvnc) in a workspace, and create an app to access it via the dashboard. Add latest version of KasmVNC with [`lxde`](https://www.lxde.org/) desktop environment:
```tf
module "kasmvnc" {
source = "registry.coder.com/modules/kasmvnc/coder"
version = "1.0.15"
agent_id = coder_agent.example.id
}
```
> **Note:** This module only works on debian-based workspaces. It is recommended to use an image with a desktop environment pre-installed to speed up the installation process.
## Examples
1. Add specific version of KasmVNC with [`mate`](https://mate-desktop.org/) desktop environment and custom port:
```tf
module "kasmvnc" {
source = "registry.coder.com/modules/kasmvnc/coder"
agent_id = coder_agent.example.id
version = "1.0.15"
kasm_version = "1.3.1"
desktop_environment = "mate"
port = 6080
}
```