From 4c01eecd57ddcdee871b9ccf67bf6f498018f958 Mon Sep 17 00:00:00 2001 From: thelamer Date: Wed, 21 Apr 2021 20:48:48 -0700 Subject: [PATCH] use correct readme-vars --- Jenkinsfile | 8 +++--- README.md | 65 +++++++++++++++++++++++++++++-------------------- readme-vars.yml | 62 +++++++++++++++++++++++++++------------------- 3 files changed, 80 insertions(+), 55 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index 790181f0..7e876c2a 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -391,7 +391,7 @@ pipeline { --label \"org.opencontainers.image.licenses=GPL-3.0-only\" \ --label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \ --label \"org.opencontainers.image.title=Webtop\" \ - --label \"org.opencontainers.image.description=[Webtop](http://xrdp.org/) - Ubuntu based containers containing full desktop environments in officially supported flavors accessible via RDP. \" \ + --label \"org.opencontainers.image.description=[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. \" \ --no-cache --pull -t ${IMAGE}:${META_TAG} \ --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ." } @@ -418,7 +418,7 @@ pipeline { --label \"org.opencontainers.image.licenses=GPL-3.0-only\" \ --label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \ --label \"org.opencontainers.image.title=Webtop\" \ - --label \"org.opencontainers.image.description=[Webtop](http://xrdp.org/) - Ubuntu based containers containing full desktop environments in officially supported flavors accessible via RDP. \" \ + --label \"org.opencontainers.image.description=[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. \" \ --no-cache --pull -t ${IMAGE}:amd64-${META_TAG} \ --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ." } @@ -445,7 +445,7 @@ pipeline { --label \"org.opencontainers.image.licenses=GPL-3.0-only\" \ --label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \ --label \"org.opencontainers.image.title=Webtop\" \ - --label \"org.opencontainers.image.description=[Webtop](http://xrdp.org/) - Ubuntu based containers containing full desktop environments in officially supported flavors accessible via RDP. \" \ + --label \"org.opencontainers.image.description=[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. \" \ --no-cache --pull -f Dockerfile.armhf -t ${IMAGE}:arm32v7-${META_TAG} \ --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ." sh "docker tag ${IMAGE}:arm32v7-${META_TAG} ghcr.io/linuxserver/lsiodev-buildcache:arm32v7-${COMMIT_SHA}-${BUILD_NUMBER}" @@ -479,7 +479,7 @@ pipeline { --label \"org.opencontainers.image.licenses=GPL-3.0-only\" \ --label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \ --label \"org.opencontainers.image.title=Webtop\" \ - --label \"org.opencontainers.image.description=[Webtop](http://xrdp.org/) - Ubuntu based containers containing full desktop environments in officially supported flavors accessible via RDP. \" \ + --label \"org.opencontainers.image.description=[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. \" \ --no-cache --pull -f Dockerfile.aarch64 -t ${IMAGE}:arm64v8-${META_TAG} \ --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ." sh "docker tag ${IMAGE}:arm64v8-${META_TAG} ghcr.io/linuxserver/lsiodev-buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER}" diff --git a/README.md b/README.md index 9add51ab..1d02c2e3 100644 --- a/README.md +++ b/README.md @@ -39,9 +39,9 @@ Find us at: [![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%2Fubuntu-i3%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-webtop/job/ubuntu-i3/) [![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](http://xrdp.org/) - Ubuntu based containers containing full desktop environments in officially supported flavors accessible via RDP. +[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://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/rdesktop.png)](http://xrdp.org/) +[![webtop](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/webtop-logo.png)](https://github.com/linuxserver/docker-webtop) ## Supported Architectures @@ -63,30 +63,38 @@ This image provides various versions that are available via tags. `latest` tag u | Tag | Description | | :----: | --- | -| latest | XFCE Focal | -| xfce-bionic | XFCE Bionic | -| kde-focal | KDE Focal | -| kde-bionic | KDE Bionic | -| lxde-focal | LXDE Focal | -| lxde-bionic | LXDE Bionic | -| budgie-focal | Budgie Focal | -| budgie-bionic | Budgie Bionic | -| mate-focal | MATE Focal | -| mate-bionic | MATE Bionic | -| kylin-focal | Kylin Focal | -| kylin-bionic | Kylin Bionic | +| latest | XFCE Alpine | +| ubuntu-xfce | XFCE Ubuntu | +| alpine-kde | KDE Alpine | +| ubuntu-kde | KDE Ubuntu | +| alpine-mate | MATE Alpine | +| ubuntu-mate | MATE Ubuntu | +| alpine-i3 | i3 Alpine | +| ubuntu-i3 | i3 Ubuntu | +| alpine-openbox | Openbox Alpine | +| ubuntu-openbox | Openbox Ubuntu | +| alpine-icewm | IceWM Alpine | +| ubuntu-icewm | IceWM Ubuntu | ## Application Setup -**The Default USERNAME and PASSWORD is: abc/abc** +The Webtop can be accessed at: -**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** +* 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 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** + +**The KDE and i3 flavors for Ubuntu need to be run in privileged mode to function properly** -You will need a Remote Desktop client to access this container [Wikipedia List](https://en.wikipedia.org/wiki/Comparison_of_remote_desktop_software), by default it listens on 3389, but you can change that port to whatever you wish on the host side IE `3390:3389`. -The first thing you should do when you login to the container is to change the abc users password by issuing the `passwd` command. If you ever lose your password you can always reset it by execing into the container as root: ``` -docker exec -it rdesktop passwd abc +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. @@ -106,15 +114,17 @@ services: webtop: image: ghcr.io/linuxserver/webtop container_name: webtop + privileged: true #optional environment: - PUID=1000 - PGID=1000 - TZ=Europe/London volumes: + - /path/to/data:/config - /var/run/docker.sock:/var/run/docker.sock #optional - - /path/to/data:/config #optional ports: - - 3389:3389 + - 3000:3000 + shm_size: "1gb" #optional restart: unless-stopped ``` @@ -123,12 +133,14 @@ services: ```bash docker run -d \ --name=webtop \ + --privileged `#optional` \ -e PUID=1000 \ -e PGID=1000 \ -e TZ=Europe/London \ - -p 3389:3389 \ + -p 3000:3000 \ + -v /path/to/data:/config \ -v /var/run/docker.sock:/var/run/docker.sock `#optional` \ - -v /path/to/data:/config `#optional` \ + --shm-size="1gb" `#optional` \ --restart unless-stopped \ ghcr.io/linuxserver/webtop ``` @@ -139,12 +151,13 @@ Container images are configured using parameters passed at runtime (such as thos | Parameter | Function | | :----: | --- | -| `-p 3389` | RDP access port | +| `-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 | -| `-v /var/run/docker.sock` | Docker Socket on the system, if you want to use Docker in the container | | `-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 | +| `--shm-size=` | We set this to 1 gig to prevent modern web browsers from crashing | ## Environment variables from files (Docker secrets) @@ -255,4 +268,4 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64 ## Versions -* **28.02.20:** - Initial Releases +* **20.04.21:** - Initial release. diff --git a/readme-vars.yml b/readme-vars.yml index 4d10ac6e..b0f13bf5 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -2,10 +2,10 @@ # project information project_name: webtop -project_url: "http://xrdp.org/" -project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/rdesktop.png" +project_url: "https://github.com/linuxserver/docker-webtop" +project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/webtop-logo.png" project_blurb: | - [{{ project_name|capitalize }}]({{ project_url }}) - Ubuntu based containers containing full desktop environments in officially supported flavors accessible via RDP. + [{{ project_name|capitalize }}]({{ project_url }}) - Alpine and Ubuntu based containers containing full desktop environments in officially supported flavors accessible via any modern web browser. project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}" # supported architectures @@ -17,25 +17,28 @@ available_architectures: # development version development_versions: true development_versions_items: - - { tag: "latest", desc: "XFCE Focal" } - - { tag: "xfce-bionic", desc: "XFCE Bionic" } - - { tag: "kde-focal", desc: "KDE Focal" } - - { tag: "kde-bionic", desc: "KDE Bionic" } - - { tag: "lxde-focal", desc: "LXDE Focal" } - - { tag: "lxde-bionic", desc: "LXDE Bionic" } - - { tag: "budgie-focal", desc: "Budgie Focal" } - - { tag: "budgie-bionic", desc: "Budgie Bionic" } - - { tag: "mate-focal", desc: "MATE Focal" } - - { tag: "mate-bionic", desc: "MATE Bionic" } - - { tag: "kylin-focal", desc: "Kylin Focal" } - - { tag: "kylin-bionic", desc: "Kylin Bionic" } + - { tag: "latest", desc: "XFCE Alpine" } + - { tag: "ubuntu-xfce", desc: "XFCE Ubuntu" } + - { tag: "alpine-kde", desc: "KDE Alpine" } + - { tag: "ubuntu-kde", desc: "KDE Ubuntu" } + - { tag: "alpine-mate", desc: "MATE Alpine" } + - { tag: "ubuntu-mate", desc: "MATE Ubuntu" } + - { tag: "alpine-i3", desc: "i3 Alpine" } + - { tag: "ubuntu-i3", desc: "i3 Ubuntu" } + - { tag: "alpine-openbox", desc: "Openbox Alpine" } + - { tag: "ubuntu-openbox", desc: "Openbox Ubuntu" } + - { tag: "alpine-icewm", desc: "IceWM Alpine" } + - { tag: "ubuntu-icewm", desc: "IceWM Ubuntu" } # container parameters +privileged: "optional" param_container_name: "{{ project_name }}" -param_usage_include_vols: false +param_usage_include_vols: true +param_volumes: + - { vol_path: "/config", vol_host_path: "/path/to/data", desc: "abc users home directory" } param_usage_include_ports: true param_ports: - - { external_port: "3389", internal_port: "3389", port_desc: "RDP access port" } + - { external_port: "3000", internal_port: "3000", port_desc: "Web Desktop GUI" } param_usage_include_env: true param_env_vars: - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London"} @@ -43,24 +46,33 @@ param_env_vars: opt_param_usage_include_vols: true opt_param_volumes: - { vol_path: "/var/run/docker.sock", vol_host_path: "/var/run/docker.sock", desc: "Docker Socket on the system, if you want to use Docker in the container" } - - { vol_path: "/config", vol_host_path: "/path/to/data", desc: "abc users home directory" } +opt_custom_params: + - { name: "shm-size", name_compose: "shm_size", value: "1gb",desc: "We set this to 1 gig to prevent modern web browsers from crashing" } # application setup block app_setup_block_enabled: true app_setup_block: | - **The Default USERNAME and PASSWORD is: abc/abc** + 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 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** + + **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 program** - - You will need a Remote Desktop client to access this container [Wikipedia List](https://en.wikipedia.org/wiki/Comparison_of_remote_desktop_software), by default it listens on 3389, but you can change that port to whatever you wish on the host side IE `3390:3389`. - The first thing you should do when you login to the container is to change the abc users password by issuing the `passwd` command. If you ever lose your password you can always reset it by execing into the container as root: ``` - docker exec -it rdesktop passwd abc + 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. # changelog changelogs: - - { date: "28.02.20:", desc: "Initial Releases" } + - { date: "20.04.21:", desc: "Initial release." }