Bot Updating Documentation

2023-04-07 21:01:26 -05:00 · 2023-04-07 21:01:26 -05:00 · 445835773f
commit 445835773f
--- a/images/docker-webtop.md
+++ b/images/docker-webtop.md
@ -31,7 +31,7 @@ The architectures supported by this image are:
 | :----: | :----: | ---- |
 | x86-64 | ✅ | amd64-\<version tag\> |
 | arm64 | ✅ | arm64v8-\<version tag\> |
-| armhf | ✅ | arm32v7-\<version tag\> |
+| armhf | ❌ | |

 ## Version Tags

@ -43,91 +43,72 @@ This image provides various versions that are available via tags. Please read th
 | ubuntu-xfce | ✅ | XFCE Ubuntu |
 | fedora-xfce | ✅ | XFCE Fedora |
 | arch-xfce | ✅ | XFCE Arch |
+| debian-xfce | ✅ | XFCE Debian |
 | alpine-kde | ✅ | KDE Alpine |
 | ubuntu-kde | ✅ | KDE Ubuntu |
 | fedora-kde | ✅ | KDE Fedora |
 | arch-kde | ✅ | KDE Arch |
+| debian-kde | ✅ | KDE Debian |
 | alpine-mate | ✅ | MATE Alpine |
 | ubuntu-mate | ✅ | MATE Ubuntu |
 | fedora-mate | ✅ | MATE Fedora |
 | arch-mate | ✅ | MATE Arch |
+| debian-mate | ✅ | MATE Debian |
 | alpine-i3 | ✅ | i3 Alpine |
 | ubuntu-i3 | ✅ | i3 Ubuntu |
 | fedora-i3 | ✅ | i3 Fedora |
 | arch-i3 | ✅ | i3 Arch |
+| debian-i3 | ✅ | i3 Debian |
 | alpine-openbox | ✅ | Openbox Alpine |
 | ubuntu-openbox | ✅ | Openbox Ubuntu |
 | fedora-openbox | ✅ | Openbox Fedora |
 | arch-openbox | ✅ | Openbox Arch |
+| debian-openbox | ✅ | Openbox Debian |
 | alpine-icewm | ✅ | IceWM Alpine |
 | ubuntu-icewm | ✅ | IceWM Ubuntu |
 | fedora-icewm | ✅ | IceWM Fedora |
 | arch-icewm | ✅ | IceWM Arch |
+| debian-icewm | ✅ | IceWM Debian |
 ## Application Setup

 The Webtop can be accessed at:

 * http://yourhost:3000/
+* https://yourhost:3001/

-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:
+**Modern GUI desktop apps (including some flavors terminals) have issues with the latest Docker and syscall compatibility, you can use Docker with the `--security-opt seccomp=unconfined` setting to allow these syscalls**

-* http://yourhost:3000/?login=true
+**Unlike our other containers these Desktops are not designed to be upgraded by Docker, you will keep your home directoy but anything you installed system level will be lost if you upgrade an existing container. To keep packages up to date instead use Ubuntu/Debians's own apt, Alpine's apk, Fedora's dnf, or Arch's pacman program**

-You can also force login on the '/' path without this parameter by passing the environment variable `-e AUTO_LOGIN=false`.
+### Options in all KasmVNC based GUI containers

-You can access advanced features of the Guacamole remote desktop using ctrl+alt+shift enabling you to use remote copy/paste, an onscreen keyboard, or a baked in file manager. This can also be accessed by clicking the small circle on the left side of the screen.
+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.

-**Modern GUI desktop apps (including some flavors terminals) have issues with the latest Docker and syscall compatibility, you can use Docker with the `--security-opt seccomp=unconfined` setting to allow these syscalls or try [podman](https://podman.io/) as they have updated their codebase to support them**
+#### Optional environment variables

-**Unlike our other containers these Desktops are not designed to be upgraded by Docker, you will keep your home directoy but anything you installed system level will be lost if you upgrade an existing container. To keep packages up to date instead use Ubuntu's own apt, Alpine's apk, Fedora's dnf, or Arch's pacman program**
+| Variable | Description |
+| :----: | --- |
+| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
+| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
+| CUSTOM_USER | HTTP Basic auth username, abc is default. |
+| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
+| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` |
+| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
+| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
+| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
+| 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` |

-#### Keyboard Layouts
+#### Optional run configurations

-This should match the layout on the computer you are accessing the container from.
+| Variable | Description |
+| :----: | --- |
+| `--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`. |
+| `-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. |
+| `--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) |

-The keyboard layouts available for use are:
-* da-dk-qwerty- Danish keyboard
-* de-ch-qwertz- Swiss German keyboard (qwertz)
-* de-de-qwertz- German keyboard (qwertz) - **OSK available**
-* en-gb-qwerty- English (UK) keyboard
-* en-us-qwerty- English (US) keyboard - **OSK available** **DEFAULT**
-* es-es-qwerty- Spanish keyboard - **OSK available**
-* fr-ch-qwertz- Swiss French keyboard (qwertz)
-* fr-fr-azerty- French keyboard (azerty) - **OSK available**
-* it-it-qwerty- Italian keyboard - **OSK available**
-* ja-jp-qwerty- Japanese keyboard
-* pt-br-qwerty- Portuguese Brazilian keyboard
-* sv-se-qwerty- Swedish keyboard
-* tr-tr-qwerty- Turkish-Q keyboard
+### Lossless mode

-If you ever lose your password you can always reset it by execing into the container as root:
-```
-docker exec -it webtop passwd abc
-```
-By default we perform all logic for the abc user and we reccomend using that user only in the container, but new users can be added as long as there is a `startwm.sh` executable script in their home directory.
-All of these containers are configured with passwordless sudo, we make no efforts to secure or harden these containers and we do not reccomend ever publishing their ports to the public Internet.
-
-## Hardware Acceleration (Ubuntu Container Only)
-
-Many desktop application will need access to a GPU to function properly and even some Desktop Environments have compisitor effects that will not function without a GPU. This is not a hard requirement and all base images will function without a video device mounted into the container.
-
-### Intel/ATI/AMD
-
-To leverage hardware acceleration you will need to mount /dev/dri video device inside of the conainer.
-```
--device=/dev/dri:/dev/dri
-```
-We will automatically ensure the abc user inside of the container has the proper permissions to access this device.
-### Nvidia
-
-Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here:
-https://github.com/NVIDIA/nvidia-docker
-
-We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-docker is installed on your host you will need to re/create the docker container with the nvidia container runtime `--runtime=nvidia` and add an environment variable `-e NVIDIA_VISIBLE_DEVICES=all` (can also be set to a specific gpu's UUID, this can be discovered by running `nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv` ). NVIDIA automatically mounts the GPU and drivers from your host into the container.
-
-### Arm Devices
-
-Best effort is made to install tools to allow mounting in /dev/dri on Arm devices. In most cases if /dev/dri exists on the host it should just work. If running a Raspberry Pi 4 be sure to enable `dtoverlay=vc4-fkms-v3d` in your usercfg.txt.
+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).

 ## Usage

@ -149,13 +130,13 @@ services:
      - PGID=1000
      - TZ=Etc/UTC
      - SUBFOLDER=/ #optional
-      - KEYBOARD=en-us-qwerty #optional
      - TITLE=Webtop #optional
    volumes:
      - /path/to/data:/config
      - /var/run/docker.sock:/var/run/docker.sock #optional
    ports:
      - 3000:3000
+      - 3001:3001
    devices:
      - /dev/dri:/dev/dri #optional
    shm_size: "1gb" #optional
@ -172,9 +153,9 @@ docker run -d \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e SUBFOLDER=/ `#optional` \
-  -e KEYBOARD=en-us-qwerty `#optional` \
  -e TITLE=Webtop `#optional` \
  -p 3000:3000 \
+  -p 3001:3001 \
  -v /path/to/data:/config \
  -v /var/run/docker.sock:/var/run/docker.sock `#optional` \
  --device /dev/dri:/dev/dri `#optional` \
@ -193,6 +174,7 @@ Docker images are configured using parameters passed at runtime (such as those a
 | Parameter | Function |
 | :----: | --- |
 | `3000` | Web Desktop GUI |
+| `3001` | Web Desktop GUI HTTPS |

 ### Environment Variables (`-e`)

@ -202,7 +184,6 @@ Docker images are configured using parameters passed at runtime (such as those a
 | `PGID=1000` | for GroupID - see below for explanation |
 | `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
 | `SUBFOLDER=/` | Specify a subfolder to use with reverse proxies, IE `/subfolder/` |
-| `KEYBOARD=en-us-qwerty` | See the keyboard layouts section for more information and options. |
 | `TITLE=Webtop` | String which will be used as page/tab title in the web browser. |

 ### Volume Mappings (`-v`)
@ -274,6 +255,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to

 ## Versions

+* **23.03.23:** - Rebase all Webtops to KasmVNC base image.
 * **21.10.22:** - Rebase xfce to Alpine 3.16, migrate to s6v3.
 * **12.03.22:** - Add documentation for mounting in a GPU.
 * **05.02.22:** - Rebase KDE Ubuntu to Jammy, add new documentation for updated gclient, stop recommending priv mode.