1M+
The LinuxServer.io team brings you another container release featuring:
Find us at:
Webtop - Alpine, Ubuntu, Fedora, and Arch based containers containing full desktop environments in officially supported flavors accessible via any modern web browser.
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:
| Architecture | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | XFCE Alpine *Wayland Support |
| alpine-i3 | ✅ | i3 Alpine *Wayland Support |
| alpine-kde | ✅ | KDE Alpine *Wayland Only |
| alpine-mate | ✅ | MATE Alpine |
| arch-i3 | ✅ | i3 Arch *Wayland Support |
| arch-kde | ✅ | KDE Arch *Wayland Support |
| arch-mate | ✅ | MATE Arch |
| arch-xfce | ✅ | XFCE Arch *Wayland Support |
| debian-i3 | ✅ | i3 Debian *Wayland Support |
| debian-kde | ✅ | KDE Debian |
| debian-mate | ✅ | MATE Debian |
| debian-xfce | ✅ | XFCE Debian |
| fedora-i3 | ✅ | i3 Fedora *Wayland Support |
| fedora-kde | ✅ | KDE Fedora *Wayland Support |
| fedora-mate | ✅ | MATE Fedora |
| fedora-xfce | ✅ | XFCE Fedora |
| ubuntu-i3 | ✅ | i3 Ubuntu *Wayland Support |
| ubuntu-kde | ✅ | KDE Ubuntu *Wayland Only |
| ubuntu-mate | ✅ | MATE Ubuntu |
| ubuntu-xfce | ✅ | XFCE Ubuntu *Wayland Support |
| dev | ✅ | KDE Ubuntu *Current Selkies Development Head |
The application can be accessed at:
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.
This container is based on Docker Baseimage Selkies, which streams a desktop or single application to your web browser. Only the essentials are covered below, the full platform documentation lives at docs.linuxserver.io/selkies.
Most support issues we see stem from large run configurations assembled from years of forum posts. These containers are designed to work with almost nothing. Start with the minimal command below, confirm it works, then add your options (volumes, env vars, GPU flags) one at a time:
docker run --rm -it \
--shm-size=1gb \
-p 3001:3001 \
lscr.io/linuxserver/webtop:latest bash
Open https://localhost:3001 (note the https) and accept the self signed certificate warning. The trailing bash gives you a shell inside the container, ctrl+d exits and cleans everything up. If a bigger setup misbehaves, return to this command to isolate the problem, see the Quickstart and Troubleshooting guides.
A GPU is optional, the CPU pipeline is fast enough for smooth sessions on modest hardware. When a GPU is mounted into the container it is automatically detected and configured for zero copy rendering and encoding, set AUTO_GPU=false to disable this behavior.
Intel / AMD (open source drivers), one flag is all it takes:
docker run --rm -it \
--shm-size=1gb \
-p 3001:3001 \
--device /dev/dri \
lscr.io/linuxserver/webtop:latest bash
Nvidia (proprietary drivers, not available on Alpine based images):
Requires host driver 580 or newer installed from the .run file downloaded directly from Nvidia. On drivers older than 595.80 you may also need kernel parameters and a dummy plug, see GPU Acceleration before opening an issue.
docker run --rm -it \
--shm-size=1gb \
-p 3001:3001 \
--runtime nvidia \
--gpus all \
--device /dev/nvidia-modeset \
lscr.io/linuxserver/webtop:latest bash
Compose examples, multi GPU selection (DRINODE/DRI_NODE), Unraid notes, and a step by step debugging loop are in the GPU Acceleration guide.
[!WARNING] This container provides privileged access to the host system. Do not expose it to the Internet unless you have secured it properly.
HTTPS is required. Modern browser features used for video and audio (WebCodecs) only work in a secure context. Port 3001 serves HTTPS directly, the HTTP port exists only to sit behind a reverse proxy.
By default there is no authentication. Setting the CUSTOM_USER and PASSWORD environment variables enables HTTP basic auth, which is suitable only for a trusted local network. For internet exposure, place the container behind a reverse proxy with robust authentication, such as SWAG. Keep in mind the web interface includes a terminal with passwordless sudo, anyone who can reach the GUI can gain root inside the container.
Authentication options, sharing link behavior, container isolation, and the lockdown variables for kiosk style deployments are covered in Security and Hardening.
To launch the session in a different language, set the LC_ALL environment variable, e.g. -e LC_ALL=zh_CN.UTF-8 (Chinese), ja_JP.UTF-8 (Japanese), ko_KR.UTF-8 (Korean), ar_AE.UTF-8 (Arabic), ru_RU.UTF-8 (Russian), es_MX.UTF-8 (Spanish Latin America), de_DE.UTF-8 (German), fr_FR.UTF-8 (French), nl_NL.UTF-8 (Dutch), it_IT.UTF-8 (Italian).
This image inherits every capability of the Selkies platform, all documented in depth on the docs site:
SELKIES_* stream, feature, and UI settings with their |locked syntax.proot-apps install filezilla) or native packages at boot with Docker mods.--privileged for an isolated DinD setup, or mount /var/run/docker.sock to manage the host.To help you get started creating a container from this image you can either use docker-compose or the docker cli.
[!NOTE] Unless a parameter is flagged as 'optional', it is mandatory and a value must be provided.
---
services:
webtop:
image: lscr.io/linuxserver/webtop:latest
container_name: webtop
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
volumes:
- /path/to/data:/config
ports:
- 3000:3000
- 3001:3001
shm_size: "1gb"
restart: unless-stopped
docker run -d \
--name=webtop \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-p 3000:3000 \
-p 3001:3001 \
-v /path/to/data:/config \
--shm-size="1gb" \
--restart unless-stopped \
lscr.io/linuxserver/webtop:latest
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.
| Parameter | Function |
|---|---|
-p 3000:3000 | Web Desktop GUI HTTP, must be proxied |
-p 3001:3001 | Web Desktop GUI HTTPS |
-e PUID=1000 | for UserID - see below for explanation |
-e PGID=1000 | for GroupID - see below for explanation |
-e TZ=Etc/UTC | specify a timezone to use, see this list. |
-v /config | abc users home directory |
--shm-size= | Recommended for all desktop images. |
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.
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.
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)
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.
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
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:
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
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
[!TIP] We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
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.
Content type
Image
Digest
sha256:526c8d766…
Size
1.2 GB
Last updated
1 day ago
docker pull linuxserver/webtop:debian-mate-version-c6730073Pulls:
16,676
Last week