docker-documentation/images/docker-webtop.md

247 wiersze
13 KiB
Markdown
Czysty Zwykły widok Historia

2021-04-22 16:54:02 +00:00
---
title: webtop
---
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read the https://github.com/linuxserver/docker-webtop/blob/master/.github/CONTRIBUTING.md -->
# [linuxserver/webtop](https://github.com/linuxserver/docker-webtop)
2021-12-19 09:37:14 +00:00
[![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/gateway/linuxserver-ci/docker/linuxserver%2Fwebtop)
2021-04-22 16:54:02 +00:00
[![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)
2021-10-01 17:52:59 +00:00
[![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)
2021-04-22 16:54:02 +00:00
[![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)
2022-02-06 22:30:11 +00:00
[Webtop](https://github.com/linuxserver/gclient) - Alpine, Ubuntu, Fedora, and Arch based containers containing full desktop environments in officially supported flavors accessible via any modern web browser.
2021-04-22 16:54:02 +00:00
## Supported Architectures
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
2021-10-01 17:52:59 +00:00
Simply pulling `lscr.io/linuxserver/webtop` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2021-04-22 16:54:02 +00:00
The architectures supported by this image are:
| Architecture | Tag |
| :----: | --- |
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
## Version Tags
This image provides various versions that are available via tags. `latest` tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
| Tag | Description |
| :----: | --- |
| latest | XFCE Alpine |
| ubuntu-xfce | XFCE Ubuntu |
2021-10-01 17:52:59 +00:00
| fedora-xfce | XFCE Fedora |
2021-10-05 01:48:27 +00:00
| arch-xfce | XFCE Arch |
2021-04-22 16:54:02 +00:00
| alpine-kde | KDE Alpine |
| ubuntu-kde | KDE Ubuntu |
2021-10-01 17:52:59 +00:00
| fedora-kde | KDE Fedora |
| arch-kde | KDE Arch |
2021-04-22 16:54:02 +00:00
| alpine-mate | MATE Alpine |
| ubuntu-mate | MATE Ubuntu |
2021-10-01 17:52:59 +00:00
| fedora-mate | MATE Fedora |
| arch-mate | MATE Arch |
2021-04-22 16:54:02 +00:00
| alpine-i3 | i3 Alpine |
| ubuntu-i3 | i3 Ubuntu |
2021-10-01 17:52:59 +00:00
| fedora-i3 | i3 Fedora |
| arch-i3 | i3 Arch |
2021-04-22 16:54:02 +00:00
| alpine-openbox | Openbox Alpine |
| ubuntu-openbox | Openbox Ubuntu |
2021-10-01 17:52:59 +00:00
| fedora-openbox | Openbox Fedora |
| arch-openbox | Openbox Arch |
2021-04-22 16:54:02 +00:00
| alpine-icewm | IceWM Alpine |
| ubuntu-icewm | IceWM Ubuntu |
2021-10-01 17:52:59 +00:00
| fedora-icewm | IceWM Fedora |
| arch-icewm | IceWM Arch |
2021-04-22 16:54:02 +00:00
## 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
2022-02-06 22:30:11 +00:00
You can also force login on the '/' path without this parameter by passing the environment variable `-e AUTO_LOGIN=false`.
2021-04-22 16:54:02 +00:00
2022-02-06 22:30:11 +00:00
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](https://podman.io/) as they have updated their codebase to support them**
2021-04-22 16:54:02 +00:00
2021-10-01 17:52:59 +00:00
**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**
2022-02-06 22:30:11 +00:00
#### 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
2021-04-22 16:54:02 +00:00
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.
## Usage
2021-07-04 09:24:11 +00:00
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
2021-04-22 16:54:02 +00:00
2021-07-04 09:24:11 +00:00
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
2021-04-22 16:54:02 +00:00
```yaml
---
version: "2.1"
services:
webtop:
2021-10-01 17:52:59 +00:00
image: lscr.io/linuxserver/webtop
2021-04-22 16:54:02 +00:00
container_name: webtop
2021-10-01 17:52:59 +00:00
security_opt:
- seccomp:unconfined #optional
2021-04-22 16:54:02 +00:00
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
2021-06-26 00:33:03 +00:00
- SUBFOLDER=/ #optional
2022-02-06 22:30:11 +00:00
- KEYBOARD=en-us-qwerty #optional
2021-04-22 16:54:02 +00:00
volumes:
- /path/to/data:/config
- /var/run/docker.sock:/var/run/docker.sock #optional
ports:
- 3000:3000
shm_size: "1gb" #optional
restart: unless-stopped
```
2021-07-04 09:24:11 +00:00
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
2021-04-22 16:54:02 +00:00
```bash
docker run -d \
--name=webtop \
2021-10-01 17:52:59 +00:00
--security-opt seccomp=unconfined `#optional` \
2021-04-22 16:54:02 +00:00
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
2021-06-26 00:33:03 +00:00
-e SUBFOLDER=/ `#optional` \
2022-02-06 22:30:11 +00:00
-e KEYBOARD=en-us-qwerty `#optional` \
2021-04-22 16:54:02 +00:00
-p 3000:3000 \
-v /path/to/data:/config \
-v /var/run/docker.sock:/var/run/docker.sock `#optional` \
--shm-size="1gb" `#optional` \
--restart unless-stopped \
2021-10-01 17:52:59 +00:00
lscr.io/linuxserver/webtop
2021-04-22 16:54:02 +00:00
```
## Parameters
Docker 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.
### Ports (`-p`)
| Parameter | Function |
| :----: | --- |
| `3000` | Web Desktop GUI |
### Environment Variables (`-e`)
| Env | Function |
| :----: | --- |
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
2021-06-26 00:33:03 +00:00
| `SUBFOLDER=/` | Specify a subfolder to use with reverse proxies, IE `/subfolder/` |
2022-02-06 22:30:11 +00:00
| `KEYBOARD=en-us-qwerty` | See the keyboard layouts section for more information and options. |
2021-04-22 16:54:02 +00:00
### 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 |
2022-02-06 22:30:11 +00:00
| `--security-opt seccomp=unconfined` | For Docker Engine only, many modern gui apps need this to function as syscalls are unkown to Docker. |
2021-04-22 16:54:02 +00:00
## 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__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](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 user` as below:
```bash
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
## 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:
* `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
2021-10-01 17:52:59 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/webtop`
2021-04-22 16:54:02 +00:00
## Versions
2022-02-06 22:30:11 +00:00
* **05.02.22:** - Rebase KDE Ubuntu to Jammy, add new documentation for updated gclient, stop recommending priv mode.
2021-10-01 17:52:59 +00:00
* **21.09.21:** - Add Fedora and Arch images, show seccomp settings in readme.
2021-09-26 14:37:11 +00:00
* **26.09.21:** - Rebase to Alpine versions to 3.14.
2021-04-22 16:54:02 +00:00
* **20.04.21:** - Initial release.