Bot Updating Documentation

Author: LinuxServer-CI

docs/images/docker-yaak.md

@@ -38,63 +38,75 @@ The architectures supported by this image are:
 
 ## Application Setup
 
-This image sets up the Yaak desktop app and makes its interface available via KasmVNC server in the browser. The interface is available at `http://your-ip:3000` or `https://your-ip:3001`.
+This image sets up the Yaak desktop app and makes its interface available in the browser. The interface is available at `https://your-ip:3001`.
 
-**Modern GUI desktop apps have issues with the latest Docker and syscall compatibility, you can use Docker with the `--security-opt seccomp=unconfined` setting to allow these syscalls on hosts with older Kernels or libseccomp**
+### Strict reverse proxies
+
+This image uses a self-signed certificate by default. This naturally means the scheme is `https`.
+If you are using a reverse proxy which validates certificates, you need to [disable this check for the container](https://docs.linuxserver.io/faq#strict-proxy).
+
+**Modern GUI desktop apps may have compatibility issues with the latest Docker syscall restrictions. You can use Docker with the `--security-opt seccomp=unconfined` setting to allow these syscalls on hosts with older Kernels or libseccomp versions.**
 
 ### Security
 
 !!! warning
 
-    Do not put this on the Internet if you do not know what you are doing.
+    This container provides privileged access to the host system. Do not expose it to the Internet unless you have secured it properly.
 
-By default this container has no authentication and the optional environment variables `CUSTOM_USER` and `PASSWORD` to enable basic http auth via the embedded NGINX server should only be used to locally secure the container from unwanted access on a local network. If exposing this to the Internet we recommend putting it behind a reverse proxy, such as [SWAG](https://github.com/linuxserver/docker-swag), and ensuring a secure authentication solution is in place. From the web interface a terminal can be launched and it is configured for passwordless sudo, so anyone with access to it can install and run whatever they want along with probing your local network.
+**HTTPS is required for full functionality.** Modern browser features such as WebCodecs, used for video and audio, will not function over an insecure HTTP connection.
 
-### Options in all KasmVNC based GUI containers
+By default, this container has no authentication. The optional `CUSTOM_USER` and `PASSWORD` environment variables enable basic HTTP auth, which is suitable only for securing the container on a trusted local network. For internet exposure, we strongly recommend placing the container behind a reverse proxy, such as [SWAG](https://github.com/linuxserver/docker-swag), with a robust authentication mechanism.
 
-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.
+The web interface includes a terminal with passwordless `sudo` access. Any user with access to the GUI can gain root control within the container, install arbitrary software, and probe your local network.
 
-#### Optional environment variables
+### Options in all Selkies-based GUI containers
 
-| 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` |
-| DISABLE_IPV6 | If set to true or any value this will disable IPv6 | 
-| LC_ALL | Set the Language for the container to run as IE `fr_FR.UTF-8` `ar_AE.UTF-8` |
-| NO_DECOR | If set the application will run without window borders in openbox for use as a PWA. |
-| NO_FULL | Do not autmatically fullscreen applications when using openbox. |
-
-#### Optional run configurations
+This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies), which provides the following environment variables and run configurations to customize its functionality.
+
+#### Optional Environment Variables
 
 | 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. |
+| `CUSTOM_PORT` | Internal HTTP port. Defaults to `3000`. |
+| `CUSTOM_HTTPS_PORT` | Internal HTTPS port. Defaults to `3001`. |
+| `CUSTOM_USER` | Username for HTTP Basic Auth. Defaults to `abc`. |
+| `PASSWORD` | Password for HTTP Basic Auth. If unset, authentication is disabled. |
+| `SUBFOLDER` | Application subfolder for reverse proxy configurations. Must include leading and trailing slashes, e.g., `/subfolder/`. |
+| `TITLE` | Page title displayed in the web browser. Defaults to "Selkies". |
+| `START_DOCKER` | If set to `false`, the privileged Docker-in-Docker setup will not start automatically. |
+| `DISABLE_IPV6` | Set to `true` to disable IPv6 support in the container. | 
+| `LC_ALL` | Sets the container's locale, e.g., `fr_FR.UTF-8`. |
+| `DRINODE` | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE `/dev/dri/renderD128` |
+| `NO_DECOR` | If set, applications will run without window borders, suitable for PWA usage. |
+| `NO_FULL` | If set, applications will not be automatically fullscreened. |
+| `DISABLE_ZINK` | If set, Zink-related environment variables will not be configured when a video card is detected. |
+| `WATERMARK_PNG` | Full path to a watermark PNG file inside the container, e.g., `/usr/share/selkies/www/icon.png`. |
+| `WATERMARK_LOCATION` | Integer specifying the watermark location: `1` (Top Left), `2` (Top Right), `3` (Bottom Left), `4` (Bottom Right), `5` (Centered), `6` (Animated). |
+
+#### Optional Run Configurations
+
+| Argument | Description |
+| :----: | --- |
+| `--privileged` | Starts a Docker-in-Docker (DinD) environment. For better performance, mount the Docker data directory from the host, e.g., `-v /path/to/docker-data:/var/lib/docker`. |
+| `-v /var/run/docker.sock:/var/run/docker.sock` | Mounts the host's Docker socket to manage host containers from within this container. |
 | `--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 applications. Only **Open Source** drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
 
 ### Language Support - Internationalization
 
-The environment variable `LC_ALL` can be used to start this container in a different language than English simply pass for example to launch the Desktop session in French `LC_ALL=fr_FR.UTF-8`. Some languages like Chinese, Japanese, or Korean will be missing fonts needed to render properly known as cjk fonts, but others may exist and not be installed inside the container depending on what underlying distribution you are running. We only ensure fonts for Latin characters are present. Fonts can be installed with a mod on startup.
+To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example:
 
-To install cjk fonts on startup as an example pass the environment variables (Alpine base):
+*   `-e LC_ALL=zh_CN.UTF-8` - Chinese
+*   `-e LC_ALL=ja_JP.UTF-8` - Japanese
+*   `-e LC_ALL=ko_KR.UTF-8` - Korean
+*   `-e LC_ALL=ar_AE.UTF-8` - Arabic
+*   `-e LC_ALL=ru_RU.UTF-8` - Russian
+*   `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
+*   `-e LC_ALL=de_DE.UTF-8` - German
+*   `-e LC_ALL=fr_FR.UTF-8` - French
+*   `-e LC_ALL=nl_NL.UTF-8` - Netherlands
+*   `-e LC_ALL=it_IT.UTF-8` - Italian
 
-```
--e DOCKER_MODS=linuxserver/mods:universal-package-install 
--e INSTALL_PACKAGES=font-noto-cjk
--e LC_ALL=zh_CN.UTF-8
-```
-
-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.
-
-### DRI3 GPU Acceleration (KasmVNC interface)
+### DRI3 GPU Acceleration
 
 For accelerated apps or games, render devices can be mounted into the container and leveraged by applications using:
 
@@ -109,29 +121,35 @@ This feature only supports **Open Source** GPU drivers:
 | NVIDIA | nouveau2 drivers only, closed source NVIDIA drivers lack DRI3 support |
 
 The `DRINODE` environment variable can be used to point to a specific GPU.
-Up to date information can be found [here](https://www.kasmweb.com/kasmvnc/docs/master/gpu_acceleration.html)
 
-### Application management
+DRI3 will work on aarch64 given the correct drivers are installed inside the container for your chipset.
+
+### Application Management
+
+There are two methods for installing applications inside the container: PRoot Apps (recommended for persistence) and Native Apps.
+
+#### PRoot Apps (Persistent)
 
-#### PRoot Apps
+Natively installed packages (e.g., via `apt-get install`) will not persist if the container is recreated. To retain applications and their settings across container updates, we recommend using [proot-apps](https://github.com/linuxserver/proot-apps). These are portable applications installed to the user's persistent `$HOME` directory.
 
-If you run system native installations of software IE `sudo apt-get install filezilla` and then upgrade or destroy/re-create the container that software will be removed and the container will be at a clean state. For some users that will be acceptable and they can update their system packages as well using system native commands like `apt-get upgrade`. If you want Docker to handle upgrading the container and retain your applications and settings we have created [proot-apps](https://github.com/linuxserver/proot-apps) which allow portable applications to be installed to persistent storage in the user's `$HOME` directory and they will work in a confined Docker environment out of the box. These applications and their settings will persist upgrades of the base container and can be mounted into different flavors of KasmVNC based containers on the fly. This can be achieved from the command line with:
+To install an application, use the command line inside the container:
 
 ```
 proot-apps install filezilla
 ```
 
-PRoot Apps is included in all KasmVNC based containers, a list of linuxserver.io supported applications is located [HERE](https://github.com/linuxserver/proot-apps?tab=readme-ov-file#supported-apps).
+A list of supported applications is available [here](https://github.com/linuxserver/proot-apps?tab=readme-ov-file#supported-apps).
 
-#### Native Apps
+#### Native Apps (Non-Persistent)
 
-It is possible to install extra packages during container start using [universal-package-install](https://github.com/linuxserver/docker-mods/tree/universal-package-install). It might increase starting time significantly. PRoot is preferred.
+You can install packages from the system's native repository using the [universal-package-install](https://github.com/linuxserver/docker-mods/tree/universal-package-install) mod. This method will increase the container's start time and is not persistent. Add the following to your `compose.yaml`:
 
 ```yaml
   environment:
     - DOCKER_MODS=linuxserver/mods:universal-package-install
     - INSTALL_PACKAGES=libfuse2|git|gdb
 ```
+ 
 
 ## Usage
 
@@ -187,7 +205,7 @@ Containers are configured using parameters passed at runtime (such as those abov
 
 | Parameter | Function |
 | :----: | --- |
-| `3000:3000` | Yaak desktop gui. |
+| `3000:3000` | Yaak desktop gui (for reverse proxy only). |
 | `3001:3001` | Yaak desktop gui HTTPS. |
 
 ### Environment Variables (`-e`)
@@ -389,53 +407,58 @@ To help with development, we generate this dependency graph.
       custom services -> legacy-services
       legacy-services -> ci-service-check
       init-migrations -> init-adduser
-      init-kasmvnc-end -> init-config
       init-os-end -> init-config
+      init-selkies-end -> init-config
       init-config -> init-config-end
       init-crontab-config -> init-config-end
       init-config -> init-crontab-config
       init-mods-end -> init-custom-files
       init-adduser -> init-device-perms
       base -> init-envfile
-      init-os-end -> init-kasmvnc
-      init-nginx -> init-kasmvnc-config
-      init-video -> init-kasmvnc-end
       base -> init-migrations
       init-config-end -> init-mods
       init-mods-package-install -> init-mods-end
       init-mods -> init-mods-package-install
-      init-kasmvnc -> init-nginx
+      init-selkies -> init-nginx
       init-adduser -> init-os-end
       init-device-perms -> init-os-end
       init-envfile -> init-os-end
+      init-os-end -> init-selkies
+      init-nginx -> init-selkies-config
+      init-video -> init-selkies-end
       init-custom-files -> init-services
-      init-kasmvnc-config -> init-video
+      init-selkies-config -> init-video
       init-services -> svc-cron
       svc-cron -> legacy-services
+      init-services -> svc-dbus
+      svc-xorg -> svc-dbus
+      svc-dbus -> legacy-services
       init-services -> svc-de
       svc-nginx -> svc-de
+      svc-selkies -> svc-de
+      svc-xorg -> svc-de
       svc-de -> legacy-services
       init-services -> svc-docker
-      svc-de -> svc-docker
       svc-docker -> legacy-services
-      init-services -> svc-kasmvnc
-      svc-pulseaudio -> svc-kasmvnc
-      svc-kasmvnc -> legacy-services
-      init-services -> svc-kclient
-      svc-kasmvnc -> svc-kclient
-      svc-kclient -> legacy-services
       init-services -> svc-nginx
-      svc-kclient -> svc-nginx
       svc-nginx -> legacy-services
       init-services -> svc-pulseaudio
       svc-pulseaudio -> legacy-services
+      init-services -> svc-selkies
+      svc-nginx -> svc-selkies
+      svc-pulseaudio -> svc-selkies
+      svc-xorg -> svc-selkies
+      svc-selkies -> legacy-services
+      init-services -> svc-xorg
+      svc-xorg -> legacy-services
     }
     Base Images: {
-      "baseimage-kasmvnc:ubuntunoble" <- "baseimage-ubuntu:noble"
+      "baseimage-selkies:ubuntunoble" <- "baseimage-ubuntu:noble"
     }
     "yaak:latest" <- Base Images
     ```
 
 ## Versions
 
+* **29.07.25:** - Rebase to selkies. Breaking Change: HTTPS is now required. Either use a reverse proxy with SSL cert or direct connect to port 8181 with HTTPS.
 * **12.09.24:** - Initial release.