Skip to content

Commit 8d5fdf6

Browse files
thelamerthelamer
committed
rebase to new jammy kasmvnc image
1 parent 4b074d5 commit 8d5fdf6

File tree

4 files changed

+75
-5
lines changed

4 files changed

+75
-5
lines changed

‎Dockerfile

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FROM ghcr.io/linuxserver/baseimage-rdesktop-web:jammy
1+
FROM ghcr.io/linuxserver/baseimage-kasmvnc:ubuntujammy
22

33
# set version label
44
ARG BUILD_DATE
@@ -9,6 +9,9 @@ LABEL maintainer="thelamer"
99

1010
ARG DEBIAN_FRONTEND="noninteractive"
1111

12+
# title
13+
ENV TITLE=MySQL-Workbench
14+
1215
RUN \
1316
echo "**** install packages ****" && \
1417
apt-get update && \

‎README.md

+33-2
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,37 @@ The architectures supported by this image are:
6363
The application can be accessed at:
6464

6565
* http://yourhost:3000/
66+
* https://yourhost:3001/
6667

67-
By default the user/pass is abc/abc, if you change your password or want to login manually to the GUI session for any reason use the following link:
68+
### Options in all KasmVNC based GUI containers
6869

69-
* http://yourhost:3000/?login=true
70+
This container is based on [Docker Baseimage KasmVNC](https://github.com/linuxserver/docker-baseimage-kasmvnc) which means there are additional environment variables and run configurations to enable or disable specific functionality.
71+
72+
#### Optional environment variables
73+
74+
| Variable | Description |
75+
| :----: | --- |
76+
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
77+
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
78+
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
79+
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
80+
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` |
81+
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
82+
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
83+
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
84+
| DRINODE | If mounting in /dev/dri for [DRI3 GPU Acceleration](https://www.kasmweb.com/kasmvnc/docs/master/gpu_acceleration.html) allows you to specify the device to use IE `/dev/dri/renderD128` |
85+
86+
#### Optional run configurations
87+
88+
| Variable | Description |
89+
| :----: | --- |
90+
| `--privileged` | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE `-v /home/user/docker-data:/var/lib/docker`. |
91+
| `-v /var/run/docker.sock:/var/run/docker.sock` | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
92+
| `--device /dev/dri:/dev/dri` | Mount a GPU into the container, this can be used in conjunction with the `DRINODE` environment variable to leverage a host video card for GPU accelerated appplications. Only **Open Source** drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
93+
94+
### Lossless mode
95+
96+
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information [here](https://www.kasmweb.com/docs/latest/how_to/lossless.html#technical-background). In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined [here](https://github.com/linuxserver/docker-baseimage-kasmvnc#lossless).
7097

7198
## Usage
7299

@@ -89,6 +116,7 @@ services:
89116
- /path/to/config:/config
90117
ports:
91118
- 3000:3000
119+
- 3001:3001
92120
cap_add:
93121
- IPC_LOCK
94122
restart: unless-stopped
@@ -103,6 +131,7 @@ docker run -d \
103131
-e PGID=1000 \
104132
-e TZ=Etc/UTC \
105133
-p 3000:3000 \
134+
-p 3001:3001 \
106135
-v /path/to/config:/config \
107136
--cap-add="IPC_LOCK" \
108137
--restart unless-stopped \
@@ -117,6 +146,7 @@ Container images are configured using parameters passed at runtime (such as thos
117146
| Parameter | Function |
118147
| :----: | --- |
119148
| `-p 3000` | Mysql Workbench desktop gui. |
149+
| `-p 3001` | Mysql Workbench desktop gui HTTPS. |
120150
| `-e PUID=1000` | for UserID - see below for explanation |
121151
| `-e PGID=1000` | for GroupID - see below for explanation |
122152
| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
@@ -232,6 +262,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
232262

233263
## Versions
234264

265+
* **18.03.23:** - Rebase to KasmVNC base image.
235266
* **15.09.22:** - Migrate to s6v3.
236267
* **26.07.22:** - Rebase on jammy.
237268
* **20.04.21:** - Rebase on focal.

‎readme-vars.yml

+31-2
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ param_volumes:
2727
param_usage_include_ports: true
2828
param_ports:
2929
- { external_port: "3000", internal_port: "3000", port_desc: "Mysql Workbench desktop gui." }
30+
- { external_port: "3001", internal_port: "3001", port_desc: "Mysql Workbench desktop gui HTTPS." }
3031
custom_params:
3132
- { name: "cap-add", name_compose: "cap_add", value: ["IPC_LOCK"], desc: "Required for keyring functionality", array: "true" }
3233
# application setup block
@@ -35,13 +36,41 @@ app_setup_block: |
3536
The application can be accessed at:
3637
3738
* http://yourhost:3000/
39+
* https://yourhost:3001/
3840
39-
By default the user/pass is abc/abc, if you change your password or want to login manually to the GUI session for any reason use the following link:
41+
### Options in all KasmVNC based GUI containers
4042
41-
* http://yourhost:3000/?login=true
43+
This container is based on [Docker Baseimage KasmVNC](https://github.com/linuxserver/docker-baseimage-kasmvnc) which means there are additional environment variables and run configurations to enable or disable specific functionality.
44+
45+
#### Optional environment variables
46+
47+
| Variable | Description |
48+
| :----: | --- |
49+
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
50+
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
51+
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
52+
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
53+
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` |
54+
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
55+
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
56+
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
57+
| DRINODE | If mounting in /dev/dri for [DRI3 GPU Acceleration](https://www.kasmweb.com/kasmvnc/docs/master/gpu_acceleration.html) allows you to specify the device to use IE `/dev/dri/renderD128` |
58+
59+
#### Optional run configurations
60+
61+
| Variable | Description |
62+
| :----: | --- |
63+
| `--privileged` | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE `-v /home/user/docker-data:/var/lib/docker`. |
64+
| `-v /var/run/docker.sock:/var/run/docker.sock` | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
65+
| `--device /dev/dri:/dev/dri` | Mount a GPU into the container, this can be used in conjunction with the `DRINODE` environment variable to leverage a host video card for GPU accelerated appplications. Only **Open Source** drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
66+
67+
### Lossless mode
68+
69+
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information [here](https://www.kasmweb.com/docs/latest/how_to/lossless.html#technical-background). In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined [here](https://github.com/linuxserver/docker-baseimage-kasmvnc#lossless).
4270
4371
# changelog
4472
changelogs:
73+
- { date: "18.03.23:", desc: "Rebase to KasmVNC base image." }
4574
- { date: "15.09.22:", desc: "Migrate to s6v3." }
4675
- { date: "26.07.22:", desc: "Rebase on jammy." }
4776
- { date: "20.04.21:", desc: "Rebase on focal." }

‎root/defaults/menu.xml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<openbox_menu xmlns="http://openbox.org/3.4/menu">
3+
<menu id="root-menu" label="MENU">
4+
<item label="xterm" icon="/usr/share/pixmaps/xterm-color_48x48.xpm"><action name="Execute"><command>/usr/bin/xterm</command></action></item>
5+
<item label="MySQL Workbench" icon="/usr/share/icons/hicolor/48x48/apps/mysql-workbench.png"><action name="Execute"><command>/usr/bin/mysql-workbench</command></action></item>
6+
</menu>
7+
</openbox_menu>

0 commit comments

Comments
 (0)