linuxserver/webtop¶

Webtop - Alpine, Ubuntu, Fedora, and Arch based containers containing full desktop environments in officially supported flavors accessible via any modern web browser.

Supported Architectures¶

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/webtop:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Version Tags¶

This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.

Application Setup¶

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

Application management¶

PRoot Apps¶

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 Webtop 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 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 Webtop containers on the fly facilitating virtual "Distro Hopping". IE if you are running the alpine-mate Webtop you will be able to use the same /config directory mounted into the arch-kde Webtop and retain the same applications and settings as long as they were installed with proot-apps install. This can be achieved from the command line with:

proot-apps install filezilla

PRoot Apps is included in all KasmVNC based containers, a list of linuxserver.io supported applications is located HERE.

Native Apps¶

It is possible to install extra packages during container start using universal-package-install. It might increase starting time significantly. PRoot is preferred.

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

Options in all KasmVNC based GUI containers¶

This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.

Optional environment variables¶

Optional run configurations¶

Language Support - Internationalization¶

The environment variable LC_ALL can be used to start Webtop 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 Webtop 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 install cjk fonts on startup as an example pass the environment variables (Alpine base):

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

For accelerated apps or games, render devices can be mounted into the container and leveraged by applications using:

--device /dev/dri:/dev/dri

This feature only supports Open Source GPU drivers:

The DRINODE environment variable can be used to point to a specific GPU. Up to date information can be found here

Display Compositing (desktop effects)¶

When using this image in tandem with a supported video card, compositing will function albeit with a performance hit when syncing the frames with pixmaps for the applications using it. This can greatly increase app compatibility if the application in question requires compositing, but requires a real GPU to be mounted into the container. By default we disable compositing at a DE level for performance reasons on our downstream images, but it can be enabled by the user and programs using compositing will still function even if the DE has it disabled in its settings. When building desktop images be sure you understand that with it enabled by default only users that have a compatible GPU mounted in will be able to use your image.

Nvidia GPU Support¶

Nvidia is not compatible with Alpine based images

Nvidia support is available by leveraging Zink for OpenGL support. This can be enabled with the following run flags:

The compose syntax is slightly different for this as you will need to set nvidia as the default runtime:

sudo nvidia-ctk runtime configure --runtime=docker --set-as-default
sudo service docker restart

And to assign the GPU in compose:

services:
  webtop:
    image: linuxserver/webtop:debian-kde
    deploy:
      resources:
        reservations:
          devices:
            - driver: nvidia
              count: 1
              capabilities: [compute,video,graphics,utility]

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

Usage¶

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

docker-compose (recommended, click here for more info)¶

---
services:
  webtop:
    image: lscr.io/linuxserver/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 (click here for more info)¶

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 \
  lscr.io/linuxserver/webtop:latest

Parameters¶

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.

Ports (-p)¶

Environment Variables (-e)¶

Volume Mappings (-v)¶

Device Mappings (--device)¶

Miscellaneous Options¶

Environment variables from files (Docker secrets)¶

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.

Umask for running applications¶

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers¶

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods¶

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info¶

• Shell access whilst the container is running:

  docker exec -it webtop /bin/bash
  

• To monitor the logs of the container in realtime:

  docker logs -f webtop
  

• Container version number:

  docker inspect -f '{{ index .Config.Labels "build_version" }}' webtop
  

• Image version number:

  docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/webtop:latest
  

Updating Info¶

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose¶

• Update images:

  • All images:

    docker-compose pull
    

  • Single image:

    docker-compose pull webtop
    

• Update containers:

  • All containers:

    docker-compose up -d
    

  • Single container:

    docker-compose up -d webtop
    

• You can also remove the old dangling images:

  docker image prune
  

Via Docker Run¶

• Update the image:

  docker pull lscr.io/linuxserver/webtop:latest
  

• Stop the running container:

  docker stop webtop
  

• Delete the container:

  docker rm webtop
  

• Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)

• You can also remove the old dangling images:

  docker image prune
  

Image Update Notifications - Diun (Docker Image Update Notifier)¶

Building locally¶

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-webtop.git
cd docker-webtop
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/webtop:latest .

The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static

docker run --rm --privileged multiarch/qemu-user-static:register --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions¶

• 26.09.24: - Swap from firefox to chromium on Alpine images.
• 23.05.24: - Rebase Alpine to 3.20, document Nvidia support.
• 22.04.24: - Rebase Ubuntu to Noble.
• 16.04.24: - Add docs on PRoot Apps.
• 14.04.24: - Rebase Fedora to 40.
• 11.02.24: - Add PWA icons and title variants properly.
• 06.02.24: - Update Readme about native language support.
• 29.12.23: - Rebase Alpine to 3.19 and swap back to Firefox.
• 07.11.23: - Rebase Fedora to 39.
• 14.06.23: - Rebase to Debian Bookworm.
• 13.05.23: - Rebase to Alpine 3.18 and Fedora 38.
• 23.03.23: - Rebase all Webtops to KasmVNC base image.
• 21.10.22: - Rebase xfce to Alpine 3.16, migrate to s6v3.
• 12.03.22: - Add documentation for mounting in a GPU.
• 05.02.22: - Rebase KDE Ubuntu to Jammy, add new documentation for updated gclient, stop recommending priv mode.
• 21.09.21: - Add Fedora and Arch images, show seccomp settings in readme.
• 26.09.21: - Rebase to Alpine versions to 3.14.
• 20.04.21: - Initial release.