readme-vars.yml

---

# project information
project_name: webtop
project_url: "https://github.com/linuxserver/docker-webtop"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/webtop-logo.png"
project_blurb: |
  [{{ project_name|capitalize }}]({{ project_url }}) - Alpine, Ubuntu, Fedora, and Arch based containers containing full desktop environments in officially supported flavors accessible via any modern web browser.
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"

# supported architectures
available_architectures:
  - { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}

# development version
development_versions: true
development_versions_items:
  - { tag: "latest", desc: "XFCE Alpine" }
  - { tag: "ubuntu-xfce", desc: "XFCE Ubuntu" }
  - { tag: "fedora-xfce", desc: "XFCE Fedora" }
  - { tag: "arch-xfce", desc: "XFCE Arch" }
  - { tag: "debian-xfce", desc: "XFCE Debian" }
  - { tag: "alpine-kde", desc: "KDE Alpine" }
  - { tag: "ubuntu-kde", desc: "KDE Ubuntu" }
  - { tag: "fedora-kde", desc: "KDE Fedora" }
  - { tag: "arch-kde", desc: "KDE Arch" }
  - { tag: "debian-kde", desc: "KDE Debian" }
  - { tag: "alpine-mate", desc: "MATE Alpine" }
  - { tag: "ubuntu-mate", desc: "MATE Ubuntu" }
  - { tag: "fedora-mate", desc: "MATE Fedora" }
  - { tag: "arch-mate", desc: "MATE Arch" }
  - { tag: "debian-mate", desc: "MATE Debian" }
  - { tag: "alpine-i3", desc: "i3 Alpine" }
  - { tag: "ubuntu-i3", desc: "i3 Ubuntu" }
  - { tag: "fedora-i3", desc: "i3 Fedora" }
  - { tag: "arch-i3", desc: "i3 Arch" }
  - { tag: "debian-i3", desc: "i3 Debian" }
  - { tag: "alpine-openbox", desc: "Openbox Alpine" }
  - { tag: "ubuntu-openbox", desc: "Openbox Ubuntu" }
  - { tag: "fedora-openbox", desc: "Openbox Fedora" }
  - { tag: "arch-openbox", desc: "Openbox Arch" }
  - { tag: "debian-openbox", desc: "Openbox Debian" }
  - { tag: "alpine-icewm", desc: "IceWM Alpine" }
  - { tag: "ubuntu-icewm", desc: "IceWM Ubuntu" }
  - { tag: "fedora-icewm", desc: "IceWM Fedora" }
  - { tag: "arch-icewm", desc: "IceWM Arch" }
  - { tag: "debian-icewm", desc: "IceWM Debian" }

# container parameters
param_container_name: "{{ project_name }}"
param_usage_include_vols: true
param_volumes:
  - { vol_path: "/config", vol_host_path: "/path/to/data", desc: "abc users home directory" }
param_usage_include_ports: true
param_ports:
  - { external_port: "3000", internal_port: "3000", port_desc: "Web Desktop GUI" }
  - { external_port: "3001", internal_port: "3001", port_desc: "Web Desktop GUI HTTPS" }
param_usage_include_env: true
param_env_vars:
  - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London"}
# optional variables
opt_param_usage_include_env: true
opt_param_env_vars:
  - { env_var: "SUBFOLDER", env_value: "/", desc: "Specify a subfolder to use with reverse proxies, IE `/subfolder/`"}
  - { env_var: "TITLE", env_value: "Webtop", desc: "String which will be used as page/tab title in the web browser." }
opt_param_usage_include_vols: true
opt_param_volumes:
  - { vol_path: "/var/run/docker.sock", vol_host_path: "/var/run/docker.sock", desc: "Docker Socket on the system, if you want to use Docker in the container" }
opt_custom_params:
  - { name: "shm-size", name_compose: "shm_size", value: "1gb",desc: "We set this to 1 gig to prevent modern web browsers from crashing" }
opt_security_opt_param: true
opt_security_opt_param_vars:
  - { run_var: "seccomp=unconfined", compose_var: "seccomp:unconfined", desc: "For Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker." }
opt_param_device_map: true
opt_param_devices:
  - { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "Add this for GL support (Linux hosts only)" }

# application setup block
app_setup_block_enabled: true
app_setup_block: |
  The Webtop can be accessed at:

  * http://yourhost:3000/
  * https://yourhost:3001/
  
  **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**

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

  ### Options in all KasmVNC based GUI containers

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

  ### Language Support - Internationalization

  The [universal internationalization](https://github.com/linuxserver/docker-mods/tree/universal-internationalization) docker mod can be used with any of these variants to provide non english language support. All you need to know is your specific iso-639 code for your your desired language. For example German is `de_DE.UTF-8` Chinese `zh_CN.UTF-8` a full list is here: 

  [https://github.com/linuxserver/docker-mods/tree/universal-internationalization#other-languages](https://github.com/linuxserver/docker-mods/tree/universal-internationalization#other-languages)

  To enable this pass the environment variables:

  ```
  -e DOCKER_MODS=linuxserver/mods:universal-internationalization
  -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 in conjunction with the mod it will perform the same as a local Linux installation set to your locale.

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

# changelog
changelogs:
  - { date: "14.06.23:", desc: "Rebase to Debian Bookworm." }
  - { date: "13.05.23:", desc: "Rebase to Alpine 3.18 and Fedora 38." }
  - { date: "23.03.23:", desc: "Rebase all Webtops to KasmVNC base image." } 
  - { date: "21.10.22:", desc: "Rebase xfce to Alpine 3.16, migrate to s6v3." }
  - { date: "12.03.22:", desc: "Add documentation for mounting in a GPU." }
  - { date: "05.02.22:", desc: "Rebase KDE Ubuntu to Jammy, add new documentation for updated gclient, stop recommending priv mode." }
  - { date: "21.09.21:", desc: "Add Fedora and Arch images, show seccomp settings in readme." }
  - { date: "26.09.21:", desc: "Rebase to Alpine versions to 3.14." }
  - { date: "20.04.21:", desc: "Initial release." }