Skip to content

Commit 3506f3f

Browse files
committed
Update readme with new style
1 parent 9c05fb2 commit 3506f3f

File tree

2 files changed

+39
-29
lines changed

2 files changed

+39
-29
lines changed

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,12 @@
44

55
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.
66

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:
813

914
* [KasmVNC](https://www.kasmweb.com/kasmvnc) - The core technology for interacting with a containerized desktop from a web browser.
1015
* [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:
1621

1722
**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**
1823

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).
2025

2126
All application settings are passed via environment variables:
2227

@@ -77,22 +82,22 @@ A list of linuxserver.io supported applications is located [HERE](https://github
7782

7883
### Application containers
7984

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:
8186

8287
```
8388
FROM ghcr.io/linuxserver/baseimage-kasmvnc:alpine320
8489
RUN apk add --no-cache firefox
8590
COPY /root /
8691
```
8792

88-
And we can define the application to start using:
93+
And we can define the application to start using:
8994

9095
```
9196
mkdir -p root/defaults
9297
echo "firefox" > root/defaults/autostart
9398
```
9499

95-
Resulting in a folder that looks like this:
100+
Resulting in a folder that looks like this:
96101

97102
```
98103
├── Dockerfile
@@ -128,7 +133,7 @@ Also included in the init logic is the ability to define application launchers.
128133
</openbox_menu>
129134
```
130135

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`:
132137

133138
```
134139
├── Dockerfile
@@ -143,7 +148,7 @@ This allows users to right click the desktop background to launch the applicatio
143148

144149
### Full Desktop environments
145150

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:
147152

148153
```
149154
├── Dockerfile
@@ -160,14 +165,14 @@ Included in these base images are binary blobs `/kasmbins` and a special init pr
160165

161166
## Docker in Docker (DinD)
162167

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`.
164169

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.
166171
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.
167172

168173
## DRI3 GPU Acceleration
169174

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:
171176

172177
`--device /dev/dri:/dev/dri`
173178

readme-vars.yml

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,15 @@ project_name: baseimage-kasmvnc
55
full_custom_readme: |
66
{% raw -%}
77
# KasmVNC Base Images from LinuxServer
8-
8+
99
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.
1010
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:
1217
1318
* [KasmVNC](https://www.kasmweb.com/kasmvnc) - The core technology for interacting with a containerized desktop from a web browser.
1419
* [Kclient](https://github.com/linuxserver/kclient) - NodeJS Iframe wrapper for KasmVNC providing audio and file access.
@@ -17,13 +22,13 @@ full_custom_readme: |
1722
* [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.
1823
1924
# Options
20-
25+
2126
**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**
2227
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).
2429
2530
All application settings are passed via environment variables:
26-
31+
2732
| Variable | Description |
2833
| :----: | --- |
2934
| 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: |
5661
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.
5762
5863
# Available Distros
59-
64+
6065
All base images are built for x86_64 and aarch64 platforms.
61-
66+
6267
| Distro | Current Tag |
6368
| :----: | --- |
6469
| Alpine | alpine321 |
@@ -81,22 +86,22 @@ full_custom_readme: |
8186
8287
### Application containers
8388
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:
8590
8691
```
8792
FROM ghcr.io/linuxserver/baseimage-kasmvnc:alpine320
8893
RUN apk add --no-cache firefox
8994
COPY /root /
9095
```
9196
92-
And we can define the application to start using:
97+
And we can define the application to start using:
9398
9499
```
95100
mkdir -p root/defaults
96101
echo "firefox" > root/defaults/autostart
97102
```
98103
99-
Resulting in a folder that looks like this:
104+
Resulting in a folder that looks like this:
100105
101106
```
102107
├── Dockerfile
@@ -132,7 +137,7 @@ full_custom_readme: |
132137
</openbox_menu>
133138
```
134139
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`:
136141
137142
```
138143
├── Dockerfile
@@ -141,13 +146,13 @@ full_custom_readme: |
141146
└── autostart
142147
└── menu.xml
143148
```
144-
149+
145150
This allows users to right click the desktop background to launch the application.
146151
147152
148153
### 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:
151156
152157
```
153158
├── Dockerfile
@@ -164,14 +169,14 @@ full_custom_readme: |
164169
165170
## Docker in Docker (DinD)
166171
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`.
168173
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.
170175
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.
171176
172177
## 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:
175180
176181
`--device /dev/dri:/dev/dri`
177182
@@ -222,7 +227,7 @@ full_custom_readme: |
222227
count: 1
223228
capabilities: [compute,video,graphics,utility]
224229
```
225-
230+
226231
The following line is only in this repo for loop testing:
227232
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
228233
{%- endraw %}

0 commit comments

Comments
 (0)