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 application can be accessed at:

• https://yourhost:3001/

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.

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¶

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.

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, with a robust authentication mechanism.

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.

Options in all Selkies-based GUI containers¶

This container is based on Docker Baseimage Selkies, which provides the following environment variables and run configurations to customize its functionality.

Optional Environment Variables¶

Optional Run Configurations¶

Language Support - Internationalization¶

To launch the desktop session in a different language, set the LC_ALL environment variable. For example:

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

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.

DRI3 will work on aarch64 given the correct drivers are installed inside the container for your chipset.

Nvidia GPU Support¶

Note: Nvidia support is not available for Alpine-based images.

Nvidia GPU support is available by leveraging Zink for OpenGL. When a compatible Nvidia GPU is passed through, it will also be automatically utilized for hardware-accelerated video stream encoding (using the x264enc full-frame profile), significantly reducing CPU load.

Enable Nvidia support with the following runtime flags:

For Docker Compose, you must first configure the Nvidia runtime as the default on the host:

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

Then, assign the GPU to the service in your compose.yaml:

services:
  webtop:
    image: lscr.io/linuxserver/webtop:latest
    deploy:
      resources:
        reservations:
          devices:
            - driver: nvidia
              count: 1
              capabilities: [compute,video,graphics,utility]

Application Management¶

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

PRoot Apps (Persistent)¶

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

To install an application, use the command line inside the container:

proot-apps install filezilla

A list of supported applications is available here.

Native Apps (Non-Persistent)¶

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 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
    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` \
  --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)¶

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 and vice versa using lscr.io/linuxserver/qemu-static

docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

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

To help with development, we generate this dependency graph.

Versions¶

• 17.06.25: - Rebase all images to Selkies, drop openbox and icewm, bump Alpine to 3.22, bump Fedora to 42.
• 10.01.25: - Rebase Fedora to 41.
• 06.12.24: - Rebase Alpine to 3.21.
• 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.