Skip to content

Commit

Permalink
Merge pull request #152 from linuxserver/alpine-xfce-3.20
Browse files Browse the repository at this point in the history
  • Loading branch information
Roxedus authored May 27, 2024
2 parents 987ac30 + 3580e62 commit ec9a55e
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 39 deletions.
3 changes: 2 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM ghcr.io/linuxserver/baseimage-rdesktop:3.19
FROM ghcr.io/linuxserver/baseimage-rdesktop:3.20

# set version label
ARG BUILD_DATE
Expand All @@ -22,6 +22,7 @@ RUN \
xfce4 \
xfce4-pulseaudio-plugin \
xfce4-terminal && \
printf "Linuxserver.io version: ${VERSION}\nBuild-date: ${BUILD_DATE}" > /build_version && \
echo "**** cleanup ****" && \
rm -f \
/etc/xdg/autostart/xfce4-power-manager.desktop \
Expand Down
3 changes: 2 additions & 1 deletion Dockerfile.aarch64
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM ghcr.io/linuxserver/baseimage-rdesktop:arm64v8-3.19
FROM ghcr.io/linuxserver/baseimage-rdesktop:arm64v8-3.20

# set version label
ARG BUILD_DATE
Expand All @@ -22,6 +22,7 @@ RUN \
xfce4 \
xfce4-pulseaudio-plugin \
xfce4-terminal && \
printf "Linuxserver.io version: ${VERSION}\nBuild-date: ${BUILD_DATE}" > /build_version && \
echo "**** cleanup ****" && \
rm -f \
/etc/xdg/autostart/xfce4-power-manager.desktop \
Expand Down
4 changes: 2 additions & 2 deletions Jenkinsfile
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ pipeline {
CI_PORT = '3000'
CI_SSL = 'false'
CI_DELAY = '30'
CI_DOCKERENV = 'TZ=US/Pacific'
CI_AUTH = 'user:password'
CI_DOCKERENV = ''
CI_AUTH = ''
CI_WEBPATH = ''
}
stages {
Expand Down
25 changes: 14 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,27 +92,29 @@ This image provides various versions that are available via tags. Please read th

**The Default USERNAME and PASSWORD is: abc/abc**

**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**
**Unlike our other containers these Desktops are not designed to be upgraded by Docker, you will keep your home directory 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**

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.

**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**

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

```bash
docker exec -it rdesktop 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.

By default we perform all logic for the abc user and we recommend 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 recommend 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.
Many desktop application will need access to a GPU to function properly and even some Desktop Environments have compositor 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.
To leverage hardware acceleration you will need to mount /dev/dri video device inside of the container.
```
--device=/dev/dri:/dev/dri
```
Expand Down Expand Up @@ -148,7 +150,7 @@ services:
- TZ=Etc/UTC
volumes:
- /var/run/docker.sock:/var/run/docker.sock #optional
- /path/to/data:/config #optional
- /path/to/rdesktop/data:/config #optional
ports:
- 3389:3389
devices:
Expand All @@ -168,7 +170,7 @@ docker run -d \
-e TZ=Etc/UTC \
-p 3389:3389 \
-v /var/run/docker.sock:/var/run/docker.sock `#optional` \
-v /path/to/data:/config `#optional` \
-v /path/to/rdesktop/data:/config `#optional` \
--device /dev/dri:/dev/dri `#optional` \
--shm-size="1gb" `#optional` \
--restart unless-stopped \
Expand All @@ -189,7 +191,7 @@ Containers are configured using parameters passed at runtime (such as those abov
| `-v /config` | abc users home directory |
| `--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 |
| `--security-opt seccomp=unconfined` | For Docker Engine only, many modern gui apps need this to function as syscalls are unknown to Docker |

## Environment variables from files (Docker secrets)

Expand Down Expand Up @@ -352,12 +354,13 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64

## Versions

* **27.05.24:** - Rebase to Alpine 3.20 and Fedora 40.
* **17.01.24:** - Sync webtop logic changes rebase to Alpine 3.19 and Fedora 39.
* **18.05.23:** - Rebase all Alpine images to 3.18, deprecate armhf.
* **27.10.22:** - Rebase all Ubuntu images to Jammy 22.04.
* **26.10.22:** - Rebase Alpine xfce to 3.16, migrate to s6v3.
* **05.03.22:** - Organize tags differently to run Ubuntu at latest LTS, make Alpine latest, add docs about GPU accel.
* **05.05.21:** - Reduce default packages to their flavor specific basics.
* **05.04.21:** - Add Alpine flavor.
* **05.05.21:** - Reduce default packages to their flavour specific basics.
* **05.04.21:** - Add Alpine flavour.
* **06.04.20:** - Start PulseAudio in images to support audio
* **28.02.20:** - Initial Releases
5 changes: 2 additions & 3 deletions jenkins-vars.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ external_type: os
release_type: stable
release_tag: latest
ls_branch: master
build_armhf: false
repo_vars:
- BUILD_VERSION_ARG = 'OS_VERSION'
- LS_USER = 'linuxserver'
Expand All @@ -22,6 +21,6 @@ repo_vars:
- CI_PORT = '3000'
- CI_SSL = 'false'
- CI_DELAY = '30'
- CI_DOCKERENV = 'TZ=US/Pacific'
- CI_AUTH = 'user:password'
- CI_DOCKERENV = ''
- CI_AUTH = ''
- CI_WEBPATH = ''
41 changes: 20 additions & 21 deletions readme-vars.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,23 +43,19 @@ development_versions_items:

# container parameters
param_container_name: "{{ project_name }}"
param_usage_include_vols: false
param_usage_include_ports: true
param_ports:
- { external_port: "3389", internal_port: "3389", port_desc: "RDP access port" }
param_usage_include_env: true
param_env_vars:
- { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London"}
# optional variables
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" }
- { vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/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" }
opt_security_opt_param: true
opt_security_opt_param_vars:
- { run_var: "seccomp=unconfined", compose_var: "seccomp:unconfined", desc: "For Docker Engine only, many modern gui apps need this to function as syscalls are unkown to Docker" }
- { run_var: "seccomp=unconfined", compose_var: "seccomp:unconfined", desc: "For Docker Engine only, many modern gui apps need this to function as syscalls are unknown to Docker" }
opt_param_device_map: true
opt_param_devices:
- { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "Add this for GL support (Linux hosts only)" }
Expand All @@ -68,37 +64,39 @@ opt_param_devices:
app_setup_block_enabled: true
app_setup_block: |
**The Default USERNAME and PASSWORD is: abc/abc**
**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**
**Unlike our other containers these Desktops are not designed to be upgraded by Docker, you will keep your home directory 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**
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.
**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**
If you ever lose your password you can always reset it by execing into the container as root:
```
```bash
docker exec -it rdesktop 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.
By default we perform all logic for the abc user and we recommend 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 recommend 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.
Many desktop application will need access to a GPU to function properly and even some Desktop Environments have compositor 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.
To leverage hardware acceleration you will need to mount /dev/dri video device inside of the container.
```
--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
Expand All @@ -107,12 +105,13 @@ app_setup_block: |
# changelog
changelogs:
- { date: "27.05.24:", desc: "Rebase to Alpine 3.20 and Fedora 40." }
- { date: "17.01.24:", desc: "Sync webtop logic changes rebase to Alpine 3.19 and Fedora 39." }
- { date: "18.05.23:", desc: "Rebase all Alpine images to 3.18, deprecate armhf." }
- { date: "27.10.22:", desc: "Rebase all Ubuntu images to Jammy 22.04." }
- { date: "26.10.22:", desc: "Rebase Alpine xfce to 3.16, migrate to s6v3." }
- { date: "05.03.22:", desc: "Organize tags differently to run Ubuntu at latest LTS, make Alpine latest, add docs about GPU accel." }
- { date: "05.05.21:", desc: "Reduce default packages to their flavor specific basics." }
- { date: "05.04.21:", desc: "Add Alpine flavor." }
- { date: "05.05.21:", desc: "Reduce default packages to their flavour specific basics." }
- { date: "05.04.21:", desc: "Add Alpine flavour." }
- { date: "06.04.20:", desc: "Start PulseAudio in images to support audio" }
- { date: "28.02.20:", desc: "Initial Releases" }

0 comments on commit ec9a55e

Please sign in to comment.