--- title: webtop tags: - Remote Desktop description: "[Webtop](https://github.com/linuxserver/docker-webtop) - Alpine, Ubuntu, Fedora, and Arch based containers containing full desktop environments in officially supported flavors accessible via any modern web browser." --- # [linuxserver/webtop](https://github.com/linuxserver/docker-webtop) [![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fwebtop?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh) [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-webtop.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-webtop) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-webtop.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-webtop/releases) [![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-webtop/packages) [![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-webtop/container_registry) [![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/webtop) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/webtop.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/webtop) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/webtop.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/webtop) [![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-webtop%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-webtop/job/master/) [![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fwebtop%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/webtop/latest/index.html) [Webtop](https://github.com/linuxserver/docker-webtop) - Alpine, Ubuntu, Fedora, and Arch based containers containing full desktop environments in officially supported flavors accessible via any modern web browser. [![webtop](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/webtop-logo.png)](https://github.com/linuxserver/docker-webtop) ## Supported Architectures We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). 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-\ | | arm64 | ✅ | arm64v8-\ | | armhf | ❌ | | ## 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. | Tag | Available | Description | | :----: | :----: |--- | | latest | ✅ | XFCE Alpine | | alpine-i3 | ✅ | i3 Alpine | | alpine-mate | ✅ | MATE Alpine | | arch-i3 | ✅ | i3 Arch | | arch-kde | ✅ | KDE Arch | | arch-mate | ✅ | MATE Arch | | arch-xfce | ✅ | XFCE Arch | | debian-i3 | ✅ | i3 Debian | | debian-kde | ✅ | KDE Debian | | debian-mate | ✅ | MATE Debian | | debian-xfce | ✅ | XFCE Debian | | el-i3 | ✅ | i3 Enterprise Linux | | el-mate | ✅ | MATE Enterprise Linux | | el-xfce | ✅ | XFCE Enterprise Linux | | fedora-i3 | ✅ | i3 Fedora | | fedora-kde | ✅ | KDE Fedora | | fedora-mate | ✅ | MATE Fedora | | fedora-xfce | ✅ | XFCE Fedora | | ubuntu-i3 | ✅ | i3 Ubuntu | | ubuntu-kde | ✅ | KDE Ubuntu | | ubuntu-mate | ✅ | MATE Ubuntu | | ubuntu-xfce | ✅ | XFCE Ubuntu | ## Application Setup The Webtop can be accessed at: * https://yourhost:3001/ **Modern GUI desktop apps have issues with the latest Docker and syscall compatibility, you can use Docker with the `--security-opt seccomp=unconfined` setting to allow these syscalls on hosts with older Kernels or libseccomp** ### Security >[!WARNING] >Do not put this on the Internet if you do not know what you are doing. By default this container has no authentication and the optional environment variables `CUSTOM_USER` and `PASSWORD` to enable basic http auth via the embedded NGINX server should only be used to locally secure the container from unwanted access on a local network. If exposing this to the Internet we recommend putting it behind a reverse proxy, such as [SWAG](https://github.com/linuxserver/docker-swag), and ensuring a secure authentication solution is in place. From the web interface a terminal can be launched and it is configured for passwordless sudo, so anyone with access to it can install and run whatever they want along with probing your local network. ### Options in all Selkies based GUI containers This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies) which means there are additional environment variables and run configurations to enable or disable specific functionality. #### Optional environment variables | Variable | Description | | :----: | --- | | CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. | | CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. | | CUSTOM_USER | HTTP Basic auth username, abc is default. | | PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth | | SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` | | TITLE | The page title displayed on the web browser, default "Selkies". | | START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. | | DISABLE_IPV6 | If set to true or any value this will disable IPv6 | | LC_ALL | Set the Language for the container to run as IE `fr_FR.UTF-8` `ar_AE.UTF-8` | | NO_DECOR | If set the application will run without window borders in openbox for use as a PWA. | | NO_FULL | Do not automatically fullscreen applications when using openbox. | #### Optional run configurations | Variable | Description | | :----: | --- | | `--privileged` | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE `-v /home/user/docker-data:/var/lib/docker`. | | `-v /var/run/docker.sock:/var/run/docker.sock` | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. | ### Language Support - Internationalization The environment variable `LC_ALL` can be used to start this container in a different language than English simply pass for example to launch the Desktop session in French `LC_ALL=fr_FR.UTF-8`. Some supported languages: * `-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 ### Nvidia GPU Support **Nvidia support is not compatible with Alpine based images as Alpine lacks Nvidia drivers** Nvidia support is available by leveraging Zink for OpenGL support. This can be enabled with the following run flags: | Variable | Description | | :----: | --- | | --gpus all | This can be filtered down but for most setups this will pass the one Nvidia GPU on the system | | --runtime nvidia | Specify the Nvidia runtime which mounts drivers and tools in from the host | 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: lscr.io/linuxserver/webtop:ubuntu-xfce deploy: resources: reservations: devices: - driver: nvidia count: 1 capabilities: [compute,video,graphics,utility] ``` ### 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 container 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](https://github.com/linuxserver/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 ofSelkiess based containers on the fly. This can be achieved from the command line with: ``` proot-apps install filezilla ``` PRoot Apps is included in all Selkies based containers, a list of linuxserver.io supported applications is located [HERE](https://github.com/linuxserver/proot-apps?tab=readme-ov-file#supported-apps). #### Native Apps It is possible to install extra packages during container start using [universal-package-install](https://github.com/linuxserver/docker-mods/tree/universal-package-install). It might increase starting time significantly. PRoot is preferred. ```yaml environment: - DOCKER_MODS=linuxserver/mods:universal-package-install - INSTALL_PACKAGES=libfuse2|git|gdb ``` ### 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](https://docs.linuxserver.io/faq#strict-proxy). ## Usage To help you get started creating a container from this image you can either use docker-compose or the docker cli. !!! info Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided. ### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose)) ```yaml --- 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](https://docs.docker.com/engine/reference/commandline/cli/)) ```bash 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 `:` 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`) | Parameter | Function | | :----: | --- | | `3000:3000` | Web Desktop GUI HTTP, must be proxied | | `3001:3001` | Web Desktop GUI HTTPS | ### Environment Variables (`-e`) | Env | Function | | :----: | --- | | `PUID=1000` | for UserID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation | | `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). | | `SUBFOLDER=/` | Specify a subfolder to use with reverse proxies, IE `/subfolder/` | | `TITLE=Webtop` | String which will be used as page/tab title in the web browser. | ### Volume Mappings (`-v`) | Volume | Function | | :----: | --- | | `/config` | abc users home directory | | `/var/run/docker.sock` | Docker Socket on the system, if you want to use Docker in the container | #### Miscellaneous Options | Parameter | Function | | :-----: | --- | | `--shm-size=` | We set this to 1 gig to prevent modern web browsers from crashing | | `--security-opt seccomp=unconfined` | For Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker. | ## Environment variables from files (Docker secrets) You can set any environment variable from a file by using a special prepend `FILE__`. As an example: ```bash -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](https://en.wikipedia.org/wiki/Umask) 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: ```bash id your_user ``` Example output: ```text uid=1000(your_user) gid=1000(your_user) groups=1000(your_user) ``` ## Docker Mods [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=webtop&query=%24.mods%5B%27webtop%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=webtop "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.") We publish various [Docker Mods](https://github.com/linuxserver/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: ```bash docker exec -it webtop /bin/bash ``` * To monitor the logs of the container in realtime: ```bash docker logs -f webtop ``` * Container version number: ```bash docker inspect -f '{{ index .Config.Labels "build_version" }}' webtop ``` * Image version number: ```bash 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](#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: ```bash docker-compose pull ``` * Single image: ```bash docker-compose pull webtop ``` * Update containers: * All containers: ```bash docker-compose up -d ``` * Single container: ```bash docker-compose up -d webtop ``` * You can also remove the old dangling images: ```bash docker image prune ``` ### Via Docker Run * Update the image: ```bash docker pull lscr.io/linuxserver/webtop:latest ``` * Stop the running container: ```bash docker stop webtop ``` * Delete the container: ```bash 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: ```bash docker image prune ``` ### Image Update Notifications - Diun (Docker Image Update Notifier) !!! tip We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported. ## Building locally If you want to make local modifications to these images for development purposes or just to customize the logic: ```bash 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` ```bash 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. ??? info "Init dependency graph" ```d2 "webtop:latest": { docker-mods base { fix-attr +\nlegacy cont-init } docker-mods -> base legacy-services custom services init-services -> legacy-services init-services -> custom services custom services -> legacy-services legacy-services -> ci-service-check init-migrations -> init-adduser init-os-end -> init-config init-selkies-end -> init-config init-config -> init-config-end init-crontab-config -> init-config-end init-config -> init-crontab-config init-mods-end -> init-custom-files init-config-end -> init-deprecate init-adduser -> init-device-perms base -> init-envfile base -> init-migrations init-config-end -> init-mods init-mods-package-install -> init-mods-end init-mods -> init-mods-package-install init-selkies -> init-nginx init-adduser -> init-os-end init-device-perms -> init-os-end init-envfile -> init-os-end init-os-end -> init-selkies init-nginx -> init-selkies-config init-video -> init-selkies-end init-custom-files -> init-services init-deprecate -> init-services init-selkies-config -> init-video init-services -> svc-cron svc-cron -> legacy-services init-services -> svc-de svc-nginx -> svc-de svc-xorg -> svc-de svc-de -> legacy-services init-services -> svc-docker svc-de -> svc-docker svc-docker -> legacy-services init-services -> svc-nginx svc-nginx -> legacy-services init-services -> svc-pulseaudio svc-pulseaudio -> legacy-services init-services -> svc-selkies svc-nginx -> svc-selkies svc-pulseaudio -> svc-selkies svc-xorg -> svc-selkies svc-selkies -> legacy-services init-services -> svc-xorg svc-xorg -> legacy-services } Base Images: { "baseimage-selkies:alpine322" <- "baseimage-alpine:3.22" } "webtop:latest" <- Base Images ``` ## 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.