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 and Ubuntu 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"}
  - { arch: "{{ arch_armhf }}", tag: "arm32v7-latest"}

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

# container parameters
privileged: "optional"
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" }
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/`"}
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" }

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

  * http://yourhost:3000/

  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:

  * http://yourhost:3000/?login=true

  You can access advanced features of the Guacamole remote desktop using ctrl+alt+shift enabling you to use remote copy/paste or an onscreen keyboard.

  **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 program or Alpine's apk program**

  **The KDE and i3 flavors for Ubuntu need to be run in privileged mode to function properly**

  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. 

# changelog
changelogs:
  - { date: "20.04.21:", desc: "Initial release." }