Bot Updating Documentation

pull/45/head
LinuxServer-CI 2021-10-01 19:52:59 +02:00
rodzic 146a44e6c4
commit 07e43b288c
1 zmienionych plików z 27 dodań i 7 usunięć

Wyświetl plik

@ -10,18 +10,19 @@ title: 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 and Ubuntu based containers containing full desktop environments in officially supported flavors accessible via any modern web browser.
[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.
## 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/).
Simply pulling `ghcr.io/linuxserver/webtop` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
Simply pulling `lscr.io/linuxserver/webtop` 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:
@ -39,16 +40,28 @@ This image provides various versions that are available via tags. `latest` tag u
| :----: | --- |
| latest | XFCE Alpine |
| ubuntu-xfce | XFCE Ubuntu |
| fedora-xfce | XFCE Fedora |
| arch-xfce | Arch Fedora |
| 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
@ -62,9 +75,11 @@ By default the user/pass is abc/abc, if you change your password or want to logi
You can access advanced features of the Guacamole remote desktop using ctrl+alt+shift enabling you to use remote copy/paste or an onscreen keyboard.
**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 program or Alpine's apk program**
**Modern GUI desktop apps (including some flavors terminals) have issues with the latest Docker and syscall compatibility, you can use Docker with the seccomp unconfined setting to allow these syscalls or try [podman](https://podman.io/) as they have updated their codebase to support them**
**The KDE and i3 flavors for Ubuntu need to be run in privileged mode to function properly**
**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**
**The KDE Ubuntu container needs to be run in privileged mode to function properly, in general the Ubuntu KDE container while functional is not reccomended, please try a different KDE distro if possible**
If you ever lose your password you can always reset it by execing into the container as root:
```
@ -84,9 +99,11 @@ To help you get started creating a container from this image you can either use
version: "2.1"
services:
webtop:
image: ghcr.io/linuxserver/webtop
image: lscr.io/linuxserver/webtop
container_name: webtop
privileged: true #optional
security_opt:
- seccomp:unconfined #optional
environment:
- PUID=1000
- PGID=1000
@ -107,6 +124,7 @@ services:
docker run -d \
--name=webtop \
--privileged `#optional` \
--security-opt seccomp=unconfined `#optional` \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
@ -116,7 +134,7 @@ docker run -d \
-v /var/run/docker.sock:/var/run/docker.sock `#optional` \
--shm-size="1gb" `#optional` \
--restart unless-stopped \
ghcr.io/linuxserver/webtop
lscr.io/linuxserver/webtop
```
## Parameters
@ -150,6 +168,7 @@ Docker images are configured using parameters passed at runtime (such as those a
| 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 as syscalls are unkown to Docker (try this before privileged) |
## Environment variables from files (Docker secrets)
@ -196,9 +215,10 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
* Container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' webtop`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/webtop`
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/webtop`
## Versions
* **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.