tibynx/webtop repository overview

⁠🖥️ Webtop⁠

Linux containers with full desktop environments accessible trough any modern web browser using KasmVNC.

⁠Desktops

To use a desktop, simply change the Docker image tag.

⁠Setup

To set up the container, you can use docker-compose or the docker cli. Unless a parameter is flagged as 'optional', it is mandatory and a value must be provided. This container is using a linuxserver.io base, so you can use their mods⁠ and configurations to enable additional functionality within the container.

⁠docker-compose⁠ (recommended)

---
services:
  webtop:
    image: tibynx/webtop:latest
    container_name: webtop
    security_opt:
      - seccomp:unconfined #optional
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - SUBFOLDER=/ #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
    restart: unless-stopped

⁠docker-cli⁠

docker run -d \
  --name=webtop \
  --security-opt seccomp=unconfined `#optional` \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e SUBFOLDER=/ `#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` \
  --shm-size="1gb" `#optional` \
  --restart unless-stopped \
  tibynx/webtop:latest

⁠Security

By default, this container has no authentication. Configure the optional environment variables CUSTOM_USER and PASSWORD to enable basic HTTP auth. This should only be used to locally secure the container on a local network. If you're exposing this container to the internet, it's recommended to use a reverse proxy or a VPN such as SWAG⁠ or Tailscale.

⁠Config

Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container. Further options can be found on the KasmVNC Base Images⁠ repo.

⁠Updating

This image is not always up to date. To update or install packages, use the desktop's package manager. You can read more about persistent apps below. It is recommended to pull the latest image and redeploy the container once in a while to update your configured mods.

⁠Applications

There are two methods for installing applications inside the container: PRoot Apps (recommended for persistence) and Native Apps.

⁠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, use proot-apps⁠. These are portable applications installed to the user's persistent $HOME directory.

To install an application, use the command line inside the container. A list of supported applications is available here⁠.

proot-apps install filezilla

⁠Native Apps

You can install packages from the system's native repository using the universal-package-install⁠ mod. This method will increase the container's start time and is not persistent. Add the following to your compose.yaml:

  environment:
    - DOCKER_MODS=linuxserver/mods:universal-package-install
    - INSTALL_PACKAGES=libfuse2|git|gdb

⁠Usage

To access the container, navigate to the IP address for your machine with the port you provided at the setup.

• http://yourhost:3000/⁠
• https://yourhost:3001/⁠