https://docs.linuxserver.io/images/docker-webtop/ [ ] [ ] Skip to content logo LinuxServer.io webtop ( ) ( ) [ ] Initializing search linuxserver/docker-documentation * Introduction * How to * Container Images * Frequently Asked Questions * Misc logo LinuxServer.io linuxserver/docker-documentation * Introduction * [ ] How to How to + Container Execution + Docker Containers: 101 + Running LinuxServer Containers + Customizing LinuxServer Containers + Docker Compose + Understanding PUID and PGID + Updating our containers + Volumes + Fleet + SWAG + How to get support + Split dns * [*] Container Images Container Images + [*] Images Images o adguardhome-sync o airsonic-advanced o altus o apprise-api o ardour o audacity o babybuddy o bambustudio o bazarr o beets o blender o boinc o bookstack o budge o calibre-web o calibre o calligra o changedetection.io o chromium o code-server o cops o cura o d2-builder o daapd o darktable o davos o ddclient o deluge o digikam o dillinger o diskover o dokuwiki o domoticz o doplarr o doublecommander o duckdns o duplicati o emby o embystat o emulatorjs o endlessh o fail2ban o faster-whisper o feed2toot o ferdium o ffmpeg o filezilla o firefox o fleet o flexget o foldingathome o freecad o freetube o freshrss o gimp o github-desktop o gitqlient o grav o grocy o habridge o headphones o healthchecks o hedgedoc o heimdall o hishtory-server o homeassistant o htpcmanager o inkscape o jackett o jellyfin o kali-linux o kasm o kavita o kdenlive o keepassxc o kicad o kimai o kometa o krita o lazylibrarian o ldap-auth o libreoffice o librespeed o librewolf o lidarr o limnoria o lollypop o lychee o manyfold o mariadb o mastodon o mediaelch o medusa o minetest o minisatip o modmanager o monica o msedge o mstream o mullvad-browser o mylar3 o mysql-workbench o nano-wallet o nano o netbootxyz o netbox o nextcloud o nginx o ngircd o nzbget o nzbhydra2 o obsidian o ombi o openshot o openssh-server o openvscode-server o opera o orcaslicer o oscam o overseerr o pairdrop o phpmyadmin o pidgin o piper o piwigo o planka o plex o projectsend o prowlarr o pwndrop o pydio-cells o pyload-ng o pylon o python o qbittorrent o qdirstat o qemu-static o radarr o raneto o rawtherapee o rdesktop o readarr o remmina o resilio-sync o rsnapshot o rustdesk o sabnzbd o series-troxide o shotcut o sickchill o sickgear o smokeping o snapdrop o snipe-it o socket-proxy o sonarr o speedtest-tracker o spotube o sqlitebrowser o steamos o swag o synclounge o syncthing o syslog-ng o tautulli o thelounge o transmission o tvheadend o ubooquity o ungoogled-chromium o unifi-network-application o vscodium o webcord o webgrabplus o [ ] webtop webtop Table of contents # Supported Architectures # Version Tags # Application Setup @ Security @ Options in all KasmVNC based GUI containers - Optional environment variables - Optional run configurations @ Language Support - Internationalization @ DRI3 GPU Acceleration (KasmVNC interface) @ Nvidia GPU Support (KasmVNC interface) @ Application management - PRoot Apps - Native Apps # Usage @ docker-compose (recommended, click here for more info) @ docker cli (click here for more info) # Parameters @ Ports (-p) @ Environment Variables (-e) @ Volume Mappings (-v) @ Device Mappings (--device) - Miscellaneous Options # Environment variables from files (Docker secrets) # Umask for running applications # User / Group Identifiers # Docker Mods # Support Info # Updating Info @ Via Docker Compose @ Via Docker Run @ Image Update Notifications - Diun (Docker Image Update Notifier) # Building locally # Versions o wikijs o wireguard o wireshark o wps-office o xbackbone o yaak o your_spotify o znc o zotero + [ ] Deprecated Images Deprecated Images o airsonic o baseimage-alpine-python o baseimage-cloud9 o baseimage-guacgui o baseimage-gui o baseimage-mono o baseimage-rdesktop-web o baseimage-rdesktop o booksonic-air o booksonic o cardigann o chevereto o clarkson o cloud9 o codiad o codimd o couchpotato o dillinger o docker-compose o endlessh o gazee o gmail-order-bot o guacd o hydra o hydra2 o ipfs o kanzi o letsencrypt o libresonic o musicbrainz o muximux o mylar o nano-discord-bot o nntp2nntp o openvpn-as o organizr o paperless-ng o paperless-ngx o papermerge o photoshow o pixapop o plex-meta-manager o pydio o pyload o quassel-core o quassel-web o readme-sync o requestrr o rutorrent o scrutiny o shout-irc o sickrage o taisun o tester o unifi-controller * Frequently Asked Questions * [ ] Misc Misc + Awesome LSIO + Finances + Running Containers As A Non-Root User + Running Containers Read-Only + LinuxServer Support Policy Table of contents * Supported Architectures * Version Tags * Application Setup + Security + Options in all KasmVNC based GUI containers o Optional environment variables o Optional run configurations + Language Support - Internationalization + DRI3 GPU Acceleration (KasmVNC interface) + Nvidia GPU Support (KasmVNC interface) + Application management o PRoot Apps o Native Apps * Usage + docker-compose (recommended, click here for more info) + docker cli (click here for more info) * Parameters + Ports (-p) + Environment Variables (-e) + Volume Mappings (-v) + Device Mappings (--device) o Miscellaneous Options * Environment variables from files (Docker secrets) * Umask for running applications * User / Group Identifiers * Docker Mods * Support Info * Updating Info + Via Docker Compose + Via Docker Run + Image Update Notifications - Diun (Docker Image Update Notifier) * Building locally * Versions linuxserver/webtopP Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI Webtop - Alpine, Ubuntu, Fedora, and Arch based containers containing full desktop environments in officially supported flavors accessible via any modern web browser. webtop Supported ArchitecturesP 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- arm64 arm64v8- armhf Version TagsP 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 ubuntu-xfce XFCE Ubuntu fedora-xfce XFCE Fedora arch-xfce XFCE Arch debian-xfce XFCE Debian alpine-kde KDE Alpine ubuntu-kde KDE Ubuntu fedora-kde KDE Fedora arch-kde KDE Arch debian-kde KDE Debian alpine-mate MATE Alpine ubuntu-mate MATE Ubuntu fedora-mate MATE Fedora arch-mate MATE Arch debian-mate MATE Debian alpine-i3 i3 Alpine ubuntu-i3 i3 Ubuntu fedora-i3 i3 Fedora arch-i3 i3 Arch debian-i3 i3 Debian alpine-openbox Openbox Alpine ubuntu-openbox Openbox Ubuntu fedora-openbox Openbox Fedora arch-openbox Openbox Arch debian-openbox Openbox Debian alpine-icewm IceWM Alpine ubuntu-icewm IceWM Ubuntu fedora-icewm IceWM Fedora arch-icewm IceWM Arch debian-icewm IceWM Debian Application SetupP The Webtop can be accessed at: * http://yourhost:3000/ * 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 SecurityP 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, 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 KasmVNC based GUI containersP 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 variablesP 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 for the application if running a SUBFOLDER subfolder reverse proxy, need both slashes IE / subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. If mounting in /dev/dri for DRI3 GPU Acceleration DRINODE allows you to specify the device to use IE /dev/dri /renderD128 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 autmatically fullscreen applications when using openbox. Optional run configurationsP Variable Description Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. --privileged 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/ Mount in the host level Docker socket to either docker.sock:/ interact with it via CLI or use Docker enabled var/run/ applications. docker.sock Mount a GPU into the container, this can be used in --device /dev/ conjunction with the DRINODE environment variable to dri:/dev/dri leverage a host video card for GPU accelerated applications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) Language Support - InternationalizationP 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 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 container 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 (KasmVNC interface)P 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: Driver Description Intel i965 and i915 drivers for Intel iGPU chipsets AMD AMDGPU, Radeon, and ATI drivers for AMD dedicated or APU chipsets NVIDIA nouveau2 drivers only, closed source NVIDIA drivers lack DRI3 support The DRINODE environment variable can be used to point to a specific GPU. Up to date information can be found here Nvidia GPU Support (KasmVNC interface)P 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 Specify the Nvidia runtime which mounts drivers and tools nvidia 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:latest deploy: resources: reservations: devices: - driver: nvidia count: 1 capabilities: [compute,video,graphics,utility] Application managementP PRoot AppsP 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 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 KasmVNC based containers on the fly. 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 AppsP 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 UsageP 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)P --- 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)P 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 ParametersP 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)P Parameter Function 3000:3000 Web Desktop GUI 3001:3001 Web Desktop GUI HTTPS Environment Variables (-e)P 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. SUBFOLDER=/ Specify a subfolder to use with reverse proxies, IE / subfolder/ TITLE= String which will be used as page/tab title in the web Webtop browser. Volume Mappings (-v)P Volume Function /config abc users home directory /var/run/ Docker Socket on the system, if you want to use docker.sock Docker in the container Device Mappings (--device)P Parameter Function /dev/dri Add this for GL support (Linux hosts only) Miscellaneous OptionsP Parameter Function --shm-size= We set this to 1 gig to prevent modern web browsers from crashing --security-opt For Docker Engine only, many modern gui apps need seccomp= this to function on older hosts as syscalls are unconfined unknown to Docker. Environment variables from files (Docker secrets)P 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 applicationsP 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 IdentifiersP 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 ModsP Docker Mods Docker Universal 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 InfoP * 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 InfoP 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 ComposeP * 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 RunP * 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)P Tip We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported. Building locallyP 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. Init dependency graph webtop:latestBase Imagesdocker-modsbaselegacy-servicescustom servicesinit-servicesci-service-checkinit-migrationsinit-adduserinit-kasmvnc-endinit-configinit-os-endinit-config-endinit-crontab-configinit-mods-endinit-custom-filesinit-envfileinit-kasmvncinit-nginxinit-kasmvnc-configinit-videoinit-modsinit-mods-package-installsvc-cronsvc-desvc-nginxsvc-dockersvc-kasmvncsvc-pulseaudiosvc-kclientbaseimage-kasmvnc:alpine321baseimage-alpine:3.21fix-attr +legacy cont-init webtop:latestBase Imagesdocker-modsbaselegacy-servicescustom servicesinit-servicesci-service-checkinit-migrationsinit-adduserinit-kasmvnc-endinit-configinit-os-endinit-config-endinit-crontab-configinit-mods-endinit-custom-filesinit-envfileinit-kasmvncinit-nginxinit-kasmvnc-configinit-videoinit-modsinit-mods-package-installsvc-cronsvc-desvc-nginxsvc-dockersvc-kasmvncsvc-pulseaudiosvc-kclientbaseimage-kasmvnc:alpine321baseimage-alpine:3.21fix-attr +legacy cont-init VersionsP * 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. January 10, 2025 February 7, 2019 Back to top Previous webgrabplus Next wikijs Copyright (c) 2024 LinuxServer.io Made with Material for MkDocs