You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-10Lines changed: 15 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,12 @@
4
4
5
5
The purpose of these images is to provide a full featured web native Linux desktop experience for any Linux application or desktop environment. These images replace our old base images at [Rdesktop Web](https://github.com/linuxserver/docker-baseimage-rdesktop-web) for greatly increased performance, fidelity, and feature set. They ship with passwordless sudo to allow easy package installation, testing, and customization. By default they have no logic to mount out anything but the users home directory, meaning on image updates anything outside of `/config` will be lost.
6
6
7
-
These images contain the following services:
7
+
- Support for using our base images in your own projects is provided on a Reasonable Endeavours basis, please see our [Support Policy](https://www.linuxserver.io/supportpolicy) for details.
8
+
- There is no `latest` tag for any of our base images, by design. We often make breaking changes between versions, and we don't publish release notes like we do for the downstream images.
9
+
- If you're intending to distribute an image using one of our bases, please read our [docs on container branding](https://docs.linuxserver.io/general/container-branding/) first.
10
+
- Images are supported for as long as the upstream release on which they are based, after which we will stop building new base images for that version.
11
+
12
+
These images contain the following services:
8
13
9
14
*[KasmVNC](https://www.kasmweb.com/kasmvnc) - The core technology for interacting with a containerized desktop from a web browser.
10
15
*[Kclient](https://github.com/linuxserver/kclient) - NodeJS Iframe wrapper for KasmVNC providing audio and file access.
@@ -16,7 +21,7 @@ These images contain the following services:
16
21
17
22
**Authentication for these containers is included as a convenience and to keep in sync with the previous xrdp containers they replace. We use bash to substitute in settings user/password and some strings might break that. In general this authentication mechanism should be used to keep the kids out not the internet**
18
23
19
-
If you are looking for a robust secure application gateway please check out [SWAG](https://github.com/linuxserver/docker-swag).
24
+
If you are looking for a robust secure application gateway please check out [SWAG](https://github.com/linuxserver/docker-swag).
20
25
21
26
All application settings are passed via environment variables:
22
27
@@ -77,22 +82,22 @@ A list of linuxserver.io supported applications is located [HERE](https://github
77
82
78
83
### Application containers
79
84
80
-
Included in these base images is a simple [Openbox DE](http://openbox.org/) and the accompanying logic needed to launch a single application. Lets look at the bare minimum needed to create an application container starting with a Dockerfile:
85
+
Included in these base images is a simple [Openbox DE](http://openbox.org/) and the accompanying logic needed to launch a single application. Lets look at the bare minimum needed to create an application container starting with a Dockerfile:
81
86
82
87
```
83
88
FROM ghcr.io/linuxserver/baseimage-kasmvnc:alpine320
84
89
RUN apk add --no-cache firefox
85
90
COPY /root /
86
91
```
87
92
88
-
And we can define the application to start using:
93
+
And we can define the application to start using:
89
94
90
95
```
91
96
mkdir -p root/defaults
92
97
echo "firefox" > root/defaults/autostart
93
98
```
94
99
95
-
Resulting in a folder that looks like this:
100
+
Resulting in a folder that looks like this:
96
101
97
102
```
98
103
├── Dockerfile
@@ -128,7 +133,7 @@ Also included in the init logic is the ability to define application launchers.
128
133
</openbox_menu>
129
134
```
130
135
131
-
Simply create this file and add it to your defaults folder as `menu.xml`:
136
+
Simply create this file and add it to your defaults folder as `menu.xml`:
132
137
133
138
```
134
139
├── Dockerfile
@@ -143,7 +148,7 @@ This allows users to right click the desktop background to launch the applicatio
143
148
144
149
### Full Desktop environments
145
150
146
-
When building an application container we are leveraging the Openbox DE to handle window management, but it is also possible to completely replace the DE that is launched on container init using the `startwm.sh` script, located again in defaults:
151
+
When building an application container we are leveraging the Openbox DE to handle window management, but it is also possible to completely replace the DE that is launched on container init using the `startwm.sh` script, located again in defaults:
147
152
148
153
```
149
154
├── Dockerfile
@@ -160,14 +165,14 @@ Included in these base images are binary blobs `/kasmbins` and a special init pr
160
165
161
166
## Docker in Docker (DinD)
162
167
163
-
These base images include an installation of Docker that can be used in two ways. The simple method is simply leveraging the Docker/Docker Compose cli bins to manage the host level Docker installation by mounting in `-v /var/run/docker.sock:/var/run/docker.sock`.
168
+
These base images include an installation of Docker that can be used in two ways. The simple method is simply leveraging the Docker/Docker Compose cli bins to manage the host level Docker installation by mounting in `-v /var/run/docker.sock:/var/run/docker.sock`.
164
169
165
-
The base images can also run an isolated in container DinD setup simply by passing `--privileged` to the container when launching. If for any reason the application needs privilege but Docker is not wanted the `-e START_DOCKER=false` can be set at runtime or in the Dockerfile.
170
+
The base images can also run an isolated in container DinD setup simply by passing `--privileged` to the container when launching. If for any reason the application needs privilege but Docker is not wanted the `-e START_DOCKER=false` can be set at runtime or in the Dockerfile.
166
171
In container Docker (DinD) will most likely use the fuse-overlayfs driver for storage which is not as fast as native overlay2. To increase perormance the `/var/lib/docker/` directory in the container can be mounted out to a Linux host and will use overlay2. Keep in mind Docker runs as root and the contents of this directory will not respect the PUID/PGID environment variables available on all LinuxServer.io containers.
167
172
168
173
## DRI3 GPU Acceleration
169
174
170
-
For accelerated apps or games, render devices can be mounted into the container and leveraged by applications using:
175
+
For accelerated apps or games, render devices can be mounted into the container and leveraged by applications using:
Copy file name to clipboardExpand all lines: readme-vars.yml
+24-19Lines changed: 24 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -5,10 +5,15 @@ project_name: baseimage-kasmvnc
5
5
full_custom_readme: |
6
6
{% raw -%}
7
7
# KasmVNC Base Images from LinuxServer
8
-
8
+
9
9
The purpose of these images is to provide a full featured web native Linux desktop experience for any Linux application or desktop environment. These images replace our old base images at [Rdesktop Web](https://github.com/linuxserver/docker-baseimage-rdesktop-web) for greatly increased performance, fidelity, and feature set. They ship with passwordless sudo to allow easy package installation, testing, and customization. By default they have no logic to mount out anything but the users home directory, meaning on image updates anything outside of `/config` will be lost.
10
10
11
-
These images contain the following services:
11
+
- Support for using our base images in your own projects is provided on a Reasonable Endeavours basis, please see our [Support Policy](https://www.linuxserver.io/supportpolicy) for details.
12
+
- There is no `latest` tag for any of our base images, by design. We often make breaking changes between versions, and we don't publish release notes like we do for the downstream images.
13
+
- If you're intending to distribute an image using one of our bases, please read our [docs on container branding](https://docs.linuxserver.io/general/container-branding/) first.
14
+
- Images are supported for as long as the upstream release on which they are based, after which we will stop building new base images for that version.
15
+
16
+
These images contain the following services:
12
17
13
18
* [KasmVNC](https://www.kasmweb.com/kasmvnc) - The core technology for interacting with a containerized desktop from a web browser.
14
19
* [Kclient](https://github.com/linuxserver/kclient) - NodeJS Iframe wrapper for KasmVNC providing audio and file access.
@@ -17,13 +22,13 @@ full_custom_readme: |
17
22
* [PulseAudio](https://www.freedesktop.org/wiki/Software/PulseAudio/) - Sound subsystem used to capture audio from the active desktop session and send it to the browser via the Kclient helper application.
18
23
19
24
# Options
20
-
25
+
21
26
**Authentication for these containers is included as a convenience and to keep in sync with the previous xrdp containers they replace. We use bash to substitute in settings user/password and some strings might break that. In general this authentication mechanism should be used to keep the kids out not the internet**
22
27
23
-
If you are looking for a robust secure application gateway please check out [SWAG](https://github.com/linuxserver/docker-swag).
28
+
If you are looking for a robust secure application gateway please check out [SWAG](https://github.com/linuxserver/docker-swag).
24
29
25
30
All application settings are passed via environment variables:
26
-
31
+
27
32
| Variable | Description |
28
33
| :----: | --- |
29
34
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
@@ -56,9 +61,9 @@ full_custom_readme: |
56
61
The web interface has the option for "IME Input Mode" in Settings which will allow non english characters to be used from a non en_US keyboard on the client. Once enabled it will perform the same as a local Linux installation set to your locale.
57
62
58
63
# Available Distros
59
-
64
+
60
65
All base images are built for x86_64 and aarch64 platforms.
61
-
66
+
62
67
| Distro | Current Tag |
63
68
| :----: | --- |
64
69
| Alpine | alpine321 |
@@ -81,22 +86,22 @@ full_custom_readme: |
81
86
82
87
### Application containers
83
88
84
-
Included in these base images is a simple [Openbox DE](http://openbox.org/) and the accompanying logic needed to launch a single application. Lets look at the bare minimum needed to create an application container starting with a Dockerfile:
89
+
Included in these base images is a simple [Openbox DE](http://openbox.org/) and the accompanying logic needed to launch a single application. Lets look at the bare minimum needed to create an application container starting with a Dockerfile:
85
90
86
91
```
87
92
FROM ghcr.io/linuxserver/baseimage-kasmvnc:alpine320
88
93
RUN apk add --no-cache firefox
89
94
COPY /root /
90
95
```
91
96
92
-
And we can define the application to start using:
97
+
And we can define the application to start using:
93
98
94
99
```
95
100
mkdir -p root/defaults
96
101
echo "firefox" > root/defaults/autostart
97
102
```
98
103
99
-
Resulting in a folder that looks like this:
104
+
Resulting in a folder that looks like this:
100
105
101
106
```
102
107
├── Dockerfile
@@ -132,7 +137,7 @@ full_custom_readme: |
132
137
</openbox_menu>
133
138
```
134
139
135
-
Simply create this file and add it to your defaults folder as `menu.xml`:
140
+
Simply create this file and add it to your defaults folder as `menu.xml`:
136
141
137
142
```
138
143
├── Dockerfile
@@ -141,13 +146,13 @@ full_custom_readme: |
141
146
└── autostart
142
147
└── menu.xml
143
148
```
144
-
149
+
145
150
This allows users to right click the desktop background to launch the application.
146
151
147
152
148
153
### Full Desktop environments
149
-
150
-
When building an application container we are leveraging the Openbox DE to handle window management, but it is also possible to completely replace the DE that is launched on container init using the `startwm.sh` script, located again in defaults:
154
+
155
+
When building an application container we are leveraging the Openbox DE to handle window management, but it is also possible to completely replace the DE that is launched on container init using the `startwm.sh` script, located again in defaults:
151
156
152
157
```
153
158
├── Dockerfile
@@ -164,14 +169,14 @@ full_custom_readme: |
164
169
165
170
## Docker in Docker (DinD)
166
171
167
-
These base images include an installation of Docker that can be used in two ways. The simple method is simply leveraging the Docker/Docker Compose cli bins to manage the host level Docker installation by mounting in `-v /var/run/docker.sock:/var/run/docker.sock`.
172
+
These base images include an installation of Docker that can be used in two ways. The simple method is simply leveraging the Docker/Docker Compose cli bins to manage the host level Docker installation by mounting in `-v /var/run/docker.sock:/var/run/docker.sock`.
168
173
169
-
The base images can also run an isolated in container DinD setup simply by passing `--privileged` to the container when launching. If for any reason the application needs privilege but Docker is not wanted the `-e START_DOCKER=false` can be set at runtime or in the Dockerfile.
174
+
The base images can also run an isolated in container DinD setup simply by passing `--privileged` to the container when launching. If for any reason the application needs privilege but Docker is not wanted the `-e START_DOCKER=false` can be set at runtime or in the Dockerfile.
170
175
In container Docker (DinD) will most likely use the fuse-overlayfs driver for storage which is not as fast as native overlay2. To increase perormance the `/var/lib/docker/` directory in the container can be mounted out to a Linux host and will use overlay2. Keep in mind Docker runs as root and the contents of this directory will not respect the PUID/PGID environment variables available on all LinuxServer.io containers.
171
176
172
177
## DRI3 GPU Acceleration
173
-
174
-
For accelerated apps or games, render devices can be mounted into the container and leveraged by applications using:
178
+
179
+
For accelerated apps or games, render devices can be mounted into the container and leveraged by applications using:
175
180
176
181
`--device /dev/dri:/dev/dri`
177
182
@@ -222,7 +227,7 @@ full_custom_readme: |
222
227
count: 1
223
228
capabilities: [compute,video,graphics,utility]
224
229
```
225
-
230
+
226
231
The following line is only in this repo for loop testing:
227
232
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
0 commit comments