The LinuxServer.io team brings you another container release featuring:

regular and timely application updates
easy user mappings (PGID, PUID)
custom base image with s6 overlay
weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
regular security updates

Find us at:

Blog - all the things you can do with our containers including How-To guides, opinions and much more!
Discord - realtime support / chat with the community and the team.
Discourse - post on our community forum.
Fleet - an online web interface which displays all of our maintained images.
GitHub - view the source for all of our repositories.
Open Collective - please consider helping us by either donating or contributing to our budget

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:

Architecture	Available	Tag
x86-64	✅	amd64-<version tag>
arm64	✅	arm64v8-<version tag>
armhf	✅	arm32v7-<version tag>

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
ubuntu-xfce	✅	XFCE Ubuntu
fedora-xfce	✅	XFCE Fedora
arch-xfce	✅	XFCE Arch
alpine-kde	✅	KDE Alpine
ubuntu-kde	✅	KDE Ubuntu
fedora-kde	✅	KDE Fedora
arch-kde	✅	KDE Arch
alpine-mate	✅	MATE Alpine
ubuntu-mate	✅	MATE Ubuntu
fedora-mate	✅	MATE Fedora
arch-mate	✅	MATE Arch
alpine-i3	✅	i3 Alpine
ubuntu-i3	✅	i3 Ubuntu
fedora-i3	✅	i3 Fedora
arch-i3	✅	i3 Arch
alpine-openbox	✅	Openbox Alpine
ubuntu-openbox	✅	Openbox Ubuntu
fedora-openbox	✅	Openbox Fedora
arch-openbox	✅	Openbox Arch
alpine-icewm	✅	IceWM Alpine
ubuntu-icewm	✅	IceWM Ubuntu
fedora-icewm	✅	IceWM Fedora
arch-icewm	✅	IceWM Arch

Application Setup

The Webtop can be accessed at:

http://yourhost:3000/

By default the user/pass is abc/abc, if you change your password or want to login manually to the GUI session for any reason use the following link:

http://yourhost:3000/?login=true

You can also force login on the '/' path without this parameter by passing the environment variable -e AUTO_LOGIN=false.

You can access advanced features of the Guacamole remote desktop using ctrl+alt+shift enabling you to use remote copy/paste, an onscreen keyboard, or a baked in file manager. This can also be accessed by clicking the small circle on the left side of the screen.

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 or try podman as they have updated their codebase to support them

Unlike our other containers these Desktops are not designed to be upgraded by Docker, you will keep your home directoy but anything you installed system level will be lost if you upgrade an existing container. To keep packages up to date instead use Ubuntu's own apt, Alpine's apk, Fedora's dnf, or Arch's pacman program

Keyboard Layouts

This should match the layout on the computer you are accessing the container from.

The keyboard layouts available for use are:

da-dk-qwerty- Danish keyboard
de-ch-qwertz- Swiss German keyboard (qwertz)
de-de-qwertz- German keyboard (qwertz) - OSK available
en-gb-qwerty- English (UK) keyboard
en-us-qwerty- English (US) keyboard - OSK available DEFAULT
es-es-qwerty- Spanish keyboard - OSK available
fr-ch-qwertz- Swiss French keyboard (qwertz)
fr-fr-azerty- French keyboard (azerty) - OSK available
it-it-qwerty- Italian keyboard - OSK available
ja-jp-qwerty- Japanese keyboard
pt-br-qwerty- Portuguese Brazilian keyboard
sv-se-qwerty- Swedish keyboard
tr-tr-qwerty- Turkish-Q keyboard

If you ever lose your password you can always reset it by execing into the container as root:

docker exec -it webtop passwd abc

By default we perform all logic for the abc user and we reccomend using that user only in the container, but new users can be added as long as there is a startwm.sh executable script in their home directory. All of these containers are configured with passwordless sudo, we make no efforts to secure or harden these containers and we do not reccomend ever publishing their ports to the public Internet.

Hardware Acceleration (Ubuntu Container Only)

Many desktop application will need access to a GPU to function properly and even some Desktop Environments have compisitor effects that will not function without a GPU. This is not a hard requirement and all base images will function without a video device mounted into the container.

Intel/ATI/AMD

To leverage hardware acceleration you will need to mount /dev/dri video device inside of the conainer.

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

We will automatically ensure the abc user inside of the container has the proper permissions to access this device.

Nvidia

Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here: https://github.com/NVIDIA/nvidia-docker

We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-docker is installed on your host you will need to re/create the docker container with the nvidia container runtime --runtime=nvidia and add an environment variable -e NVIDIA_VISIBLE_DEVICES=all (can also be set to a specific gpu's UUID, this can be discovered by running nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv ). NVIDIA automatically mounts the GPU and drivers from your host into the container.

Arm Devices

Best effort is made to install tools to allow mounting in /dev/dri on Arm devices. In most cases if /dev/dri exists on the host it should just work. If running a Raspberry Pi 4 be sure to enable dtoverlay=vc4-fkms-v3d in your usercfg.txt.

Usage

Here are some example snippets to help you get started creating a container.

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

---
version: "2.1"
services:
  webtop:
    image: lscr.io/linuxserver/webtop:latest
    container_name: webtop
    security_opt:
      - seccomp:unconfined #optional
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
      - SUBFOLDER=/ #optional
      - KEYBOARD=en-us-qwerty #optional
    volumes:
      - /path/to/data:/config
      - /var/run/docker.sock:/var/run/docker.sock #optional
    ports:
      - 3000:3000
    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=Europe/London \
  -e SUBFOLDER=/ `#optional` \
  -e KEYBOARD=en-us-qwerty `#optional` \
  -p 3000:3000 \
  -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

Container images 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`	Web Desktop GUI
`-e PUID=1000`	for UserID - see below for explanation
`-e PGID=1000`	for GroupID - see below for explanation
`-e TZ=Europe/London`	Specify a timezone to use EG Europe/London
`-e SUBFOLDER=/`	Specify a subfolder to use with reverse proxies, IE `/subfolder/`
`-e KEYBOARD=en-us-qwerty`	See the keyboard layouts section for more information and options.
`-v /config`	abc users home directory
`-v /var/run/docker.sock`	Docker Socket on the system, if you want to use Docker in the container
`--device /dev/dri`	Add this for GL support (Linux hosts only)
`--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 as syscalls are unkown 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:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword 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 user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

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 (ie. nextcloud, plex), 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 all images: docker-compose pull
- or update a single image: docker-compose pull webtop
Let compose update all containers as necessary: docker-compose up -d
- or update a 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

Via Watchtower auto-updater (only use if you don't remember the original parameters)

Pull the latest image at its tag and replace it with the same env variables in one run:

docker run --rm \
-v /var/run/docker.sock:/var/run/docker.sock \
containrrr/watchtower \
--run-once webtop

You can also remove the old dangling images: docker image prune

Note: We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using Docker Compose.

Image Update Notifications - Diun (Docker Image Update Notifier)

We recommend 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:

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

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.

isabella232 / docker-webtop Goto Github PK

docker-webtop's Introduction