From fd3e6197660204a700f519ffdbd49e7026dc8f05 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Fri, 7 Apr 2023 16:08:30 -0500 Subject: [PATCH] Bot Updating Documentation --- images/docker-qdirstat.md | 37 ++++++++++++++++++++++++++++++++++--- 1 file changed, 34 insertions(+), 3 deletions(-) diff --git a/images/docker-qdirstat.md b/images/docker-qdirstat.md index 502e64a97..e016e49c4 100755 --- a/images/docker-qdirstat.md +++ b/images/docker-qdirstat.md @@ -31,17 +31,44 @@ The architectures supported by this image are: | :----: | :----: | ---- | | x86-64 | ✅ | amd64-\ | | arm64 | ✅ | arm64v8-\ | -| armhf | ✅ | arm32v7-\ | +| armhf | ❌ | | ## Application Setup The application 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: +### Options in all KasmVNC based GUI containers -* http://yourhost:3000/?login=true +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. + +#### Optional environment variables + +| 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` | + +#### Optional run configurations + +| 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) | + +### Lossless mode + +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 @@ -65,6 +92,7 @@ services: - /path/to/data:/data ports: - 3000:3000 + - 3001:3001 restart: unless-stopped ``` @@ -77,6 +105,7 @@ docker run -d \ -e PGID=1000 \ -e TZ=Etc/UTC \ -p 3000:3000 \ + -p 3001:3001 \ -v /path/to/config:/config \ -v /path/to/data:/data \ --restart unless-stopped \ @@ -93,6 +122,7 @@ Docker images are configured using parameters passed at runtime (such as those a | Parameter | Function | | :----: | --- | | `3000` | QdirStat desktop gui. | +| `3001` | QdirStat desktop gui HTTPS. | ### Environment Variables (`-e`) @@ -163,6 +193,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Versions +* **03.04.23:** - Rebase to KasmVNC base image. Deprecate armhf build as the new base does not support it. * **16.12.22:** - Rebase to Jammy. * **06.04.22:** - Add xfce terminal. * **13.01.22:** - Compile from source.