aboutsummaryrefslogtreecommitdiff
path: root/src/desktop-lite/README.md
blob: 709ba44b1beddeb268a5cbd218dc34b72f1fdb0f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

# Light-weight Desktop (desktop-lite)

Adds a lightweight Fluxbox based desktop to the container that can be accessed using a VNC viewer or the web. GUI-based commands executed from the built-in VS code terminal will open on the desktop automatically.

## Example Usage

```json
"features": {
        "ghcr.io/devcontainers/features/desktop-lite:1": {
            "version": "latest"
        }
}
```

## Options

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| version | Currently Unused! | string | latest |
| noVncVersion | NoVnc Version | string | 1.2.0 |
| password | Enter a password for desktop connections | string | vscode |
| webPort | Enter a port for the VNC web client | string | 6080 |
| vncPort | Enter a port for the desktop VNC server | string | 5901 |

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/desktop-lite/devcontainer-feature.json)._