diff --git a/Dockerfile b/Dockerfile index eab8c77a..c4a2fc7c 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,4 @@ -FROM ghcr.io/linuxserver/baseimage-rdesktop:3.20 +FROM ghcr.io/linuxserver/baseimage-rdesktop:alpine320 # set version label ARG BUILD_DATE diff --git a/Dockerfile.aarch64 b/Dockerfile.aarch64 index 69e35e16..b745ad65 100644 --- a/Dockerfile.aarch64 +++ b/Dockerfile.aarch64 @@ -1,4 +1,4 @@ -FROM ghcr.io/linuxserver/baseimage-rdesktop:arm64v8-3.20 +FROM ghcr.io/linuxserver/baseimage-rdesktop:arm64v8-alpine320 # set version label ARG BUILD_DATE diff --git a/README.md b/README.md index eff5c3e7..d77ce058 100644 --- a/README.md +++ b/README.md @@ -67,26 +67,32 @@ This image provides various versions that are available via tags. Please read th | ubuntu-xfce | ✅ | XFCE Ubuntu | | fedora-xfce | ✅ | XFCE Fedora | | arch-xfce | ✅ | XFCE Arch | +| debian-xfce | ✅ | XFCE Debian | | alpine-kde | ✅ | KDE Alpine | | ubuntu-kde | ✅ | KDE Ubuntu | | fedora-kde | ✅ | KDE Fedora | | arch-kde | ✅ | KDE Arch | +| debian-kde | ✅ | KDE Debian | | alpine-mate | ✅ | MATE Alpine | | ubuntu-mate | ✅ | MATE Ubuntu | | fedora-mate | ✅ | MATE Fedora | | arch-mate | ✅ | MATE Arch | +| debian-mate | ✅ | MATE Debian | | alpine-i3 | ✅ | i3 Alpine | | ubuntu-i3 | ✅ | i3 Ubuntu | | fedora-i3 | ✅ | i3 Fedora | | arch-i3 | ✅ | i3 Arch | +| debian-i3 | ✅ | i3 Debian | | alpine-openbox | ✅ | Openbox Alpine | | ubuntu-openbox | ✅ | Openbox Ubuntu | | fedora-openbox | ✅ | Openbox Fedora | | arch-openbox | ✅ | Openbox Arch | +| debian-openbox | ✅ | Openbox Debian | | alpine-icewm | ✅ | IceWM Alpine | | ubuntu-icewm | ✅ | IceWM Ubuntu | | fedora-icewm | ✅ | IceWM Fedora | | arch-icewm | ✅ | IceWM Arch | +| debian-icewm | ✅ | IceWM Debian | ## Application Setup @@ -108,27 +114,80 @@ docker exec -it rdesktop passwd abc 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) +## Options -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. +All application settings are passed via environment variables: -### Intel/ATI/AMD +| Variable | Description | +| :----: | --- | +| LC_ALL | Set the Language for the container to run as IE `fr_FR.UTF-8` `ar_AE.UTF-8` | +| NO_DECOR | If set the application will run without window borders. (Decor can be enabled and disabled with Ctrl+Shift+d) | +| NO_FULL | Do not autmatically fullscreen applications when using openbox. | + +### Language Support - Internationalization + +The environment variable `LC_ALL` can be used to start this image in a different language than English simply pass for example to launch the Desktop session in French `LC_ALL=fr_FR.UTF-8`. Some languages like Chinese, Japanese, or Korean will be missing fonts needed to render properly known as cjk fonts, but others may exist and not be installed. We only ensure fonts for Latin characters are present. Fonts can be installed with a mod on startup. + +To install cjk fonts on startup as an example pass the environment variables(Debian): -To leverage hardware acceleration you will need to mount /dev/dri video device inside of the container. ``` ---device=/dev/dri:/dev/dri +-e DOCKER_MODS=linuxserver/mods:universal-package-install +-e INSTALL_PACKAGES=fonts-noto-cjk +-e LC_ALL=zh_CN.UTF-8 ``` -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 +## PRoot Apps -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. +All images include [proot-apps](https://github.com/linuxserver/proot-apps) which allow portable applications to be installed to persistent storage in the user's `$HOME` directory. These applications and their settings will persist upgrades of the base container and can be mounted into different flavors of rdesktop containers. IE if you are running an Alpine based container you will be able to use the same `/config` directory mounted into an Ubuntu based container and retain the same applications and settings as long as they were installed with `proot-apps install`. -### Arm Devices +A list of linuxserver.io supported applications is located [HERE](https://github.com/linuxserver/proot-apps?tab=readme-ov-file#supported-apps). -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. +## Open Source GPU Acceleration + +For accelerated apps or games, render devices can be mounted into the container and leveraged by applications using: + +`--device /dev/dri:/dev/dri` + +This feature only supports **Open Source** GPU drivers: + +| Driver | Description | +| :----: | --- | +| Intel | i965 and i915 drivers for Intel iGPU chipsets | +| AMD | AMDGPU, Radeon, and ATI drivers for AMD dedicated or APU chipsets | +| NVIDIA | nouveau2 drivers only, closed source NVIDIA drivers lack DRI3 support | + +## Nvidia GPU Support + +**Nvidia is not compatible with Alpine based images** + +Nvidia support is available by leveraging Zink for OpenGL support. This can be enabled with the following run flags: + +| Variable | Description | +| :----: | --- | +| --gpus all | This can be filtered down but for most setups this will pass the one Nvidia GPU on the system | +| --runtime nvidia | Specify the Nvidia runtime which mounts drivers and tools in from the host | + +The compose syntax is slightly different for this as you will need to set nvidia as the default runtime: + +``` +sudo nvidia-ctk runtime configure --runtime=docker --set-as-default +sudo service docker restart +``` + +And to assign the GPU in compose: + +``` +services: + myimage: + image: myname/myimage:mytag + deploy: + resources: + reservations: + devices: + - driver: nvidia + count: 1 + capabilities: [compute,video,graphics,utility] +``` ## Usage @@ -354,6 +413,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64 ## Versions +* **06.08.24:** - Refresh all images using new bases, add Debian, bump Ubuntu to Noble. * **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. diff --git a/readme-vars.yml b/readme-vars.yml index 0e889752..84c9b45c 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -20,26 +20,32 @@ development_versions_items: - { tag: "ubuntu-xfce", desc: "XFCE Ubuntu" } - { tag: "fedora-xfce", desc: "XFCE Fedora" } - { tag: "arch-xfce", desc: "XFCE Arch" } + - { tag: "debian-xfce", desc: "XFCE Debian" } - { tag: "alpine-kde", desc: "KDE Alpine" } - { tag: "ubuntu-kde", desc: "KDE Ubuntu" } - { tag: "fedora-kde", desc: "KDE Fedora" } - { tag: "arch-kde", desc: "KDE Arch" } + - { tag: "debian-kde", desc: "KDE Debian" } - { tag: "alpine-mate", desc: "MATE Alpine" } - { tag: "ubuntu-mate", desc: "MATE Ubuntu" } - { tag: "fedora-mate", desc: "MATE Fedora" } - { tag: "arch-mate", desc: "MATE Arch" } + - { tag: "debian-mate", desc: "MATE Debian" } - { tag: "alpine-i3", desc: "i3 Alpine" } - { tag: "ubuntu-i3", desc: "i3 Ubuntu" } - { tag: "fedora-i3", desc: "i3 Fedora" } - { tag: "arch-i3", desc: "i3 Arch" } + - { tag: "debian-i3", desc: "i3 Debian" } - { tag: "alpine-openbox", desc: "Openbox Alpine" } - { tag: "ubuntu-openbox", desc: "Openbox Ubuntu" } - { tag: "fedora-openbox", desc: "Openbox Fedora" } - { tag: "arch-openbox", desc: "Openbox Arch" } + - { tag: "debian-openbox", desc: "Openbox Debian" } - { tag: "alpine-icewm", desc: "IceWM Alpine" } - { tag: "ubuntu-icewm", desc: "IceWM Ubuntu" } - { tag: "fedora-icewm", desc: "IceWM Fedora" } - { tag: "arch-icewm", desc: "IceWM Arch" } + - { tag: "debian-icewm", desc: "IceWM Debian" } # container parameters param_container_name: "{{ project_name }}" @@ -81,30 +87,84 @@ app_setup_block: | 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) + ## Options - 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. + All application settings are passed via environment variables: - ### Intel/ATI/AMD + | Variable | Description | + | :----: | --- | + | LC_ALL | Set the Language for the container to run as IE `fr_FR.UTF-8` `ar_AE.UTF-8` | + | NO_DECOR | If set the application will run without window borders. (Decor can be enabled and disabled with Ctrl+Shift+d) | + | NO_FULL | Do not autmatically fullscreen applications when using openbox. | + + ### Language Support - Internationalization + + The environment variable `LC_ALL` can be used to start this image in a different language than English simply pass for example to launch the Desktop session in French `LC_ALL=fr_FR.UTF-8`. Some languages like Chinese, Japanese, or Korean will be missing fonts needed to render properly known as cjk fonts, but others may exist and not be installed. We only ensure fonts for Latin characters are present. Fonts can be installed with a mod on startup. + + To install cjk fonts on startup as an example pass the environment variables(Debian): - To leverage hardware acceleration you will need to mount /dev/dri video device inside of the container. ``` - --device=/dev/dri:/dev/dri + -e DOCKER_MODS=linuxserver/mods:universal-package-install + -e INSTALL_PACKAGES=fonts-noto-cjk + -e LC_ALL=zh_CN.UTF-8 ``` - 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 + ## PRoot Apps - 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. + All images include [proot-apps](https://github.com/linuxserver/proot-apps) which allow portable applications to be installed to persistent storage in the user's `$HOME` directory. These applications and their settings will persist upgrades of the base container and can be mounted into different flavors of rdesktop containers. IE if you are running an Alpine based container you will be able to use the same `/config` directory mounted into an Ubuntu based container and retain the same applications and settings as long as they were installed with `proot-apps install`. - ### Arm Devices + A list of linuxserver.io supported applications is located [HERE](https://github.com/linuxserver/proot-apps?tab=readme-ov-file#supported-apps). - 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. + ## Open Source GPU Acceleration + + For accelerated apps or games, render devices can be mounted into the container and leveraged by applications using: + + `--device /dev/dri:/dev/dri` + + This feature only supports **Open Source** GPU drivers: + + | Driver | Description | + | :----: | --- | + | Intel | i965 and i915 drivers for Intel iGPU chipsets | + | AMD | AMDGPU, Radeon, and ATI drivers for AMD dedicated or APU chipsets | + | NVIDIA | nouveau2 drivers only, closed source NVIDIA drivers lack DRI3 support | + + ## Nvidia GPU Support + + **Nvidia is not compatible with Alpine based images** + + Nvidia support is available by leveraging Zink for OpenGL support. This can be enabled with the following run flags: + + | Variable | Description | + | :----: | --- | + | --gpus all | This can be filtered down but for most setups this will pass the one Nvidia GPU on the system | + | --runtime nvidia | Specify the Nvidia runtime which mounts drivers and tools in from the host | + + The compose syntax is slightly different for this as you will need to set nvidia as the default runtime: + + ``` + sudo nvidia-ctk runtime configure --runtime=docker --set-as-default + sudo service docker restart + ``` + + And to assign the GPU in compose: + + ``` + services: + myimage: + image: myname/myimage:mytag + deploy: + resources: + reservations: + devices: + - driver: nvidia + count: 1 + capabilities: [compute,video,graphics,utility] + ``` # changelog changelogs: + - { date: "06.08.24:", desc: "Refresh all images using new bases, add Debian, bump Ubuntu to Noble." } - { 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." } diff --git a/root/defaults/startwm.sh b/root/defaults/startwm.sh index 9019e260..0c8540a7 100755 --- a/root/defaults/startwm.sh +++ b/root/defaults/startwm.sh @@ -1,8 +1,34 @@ #!/bin/bash -/startpulse.sh & -if [ -f "${HOME}"/.config/xfce4/xfconf/xfce-perchannel-xml/xfwm4.xml ]; then - sed -i \ - '/use_compositing/c ' \ - "${HOME}"/.config/xfce4/xfconf/xfce-perchannel-xml/xfwm4.xml + +# Combine env +/usr/bin/with-contenv /usr/bin/env | sed 's/^/export /g' > /defaults/env.sh +source /defaults/env.sh +rm /defaults/env.sh + +# Enable Nvidia GPU support if detected +if which nvidia-smi; then + export LIBGL_KOPPER_DRI2=1 + export MESA_LOADER_DRIVER_OVERRIDE=zink + export GALLIUM_DRIVER=zink fi + +# Start Pulseaudio +/startpulse.sh & + +# Disable compositing +setterm blank 0 +setterm powerdown 0 +if [ ! -f "${HOME}"/.config/xfce4/xfconf/xfce-perchannel-xml/xfwm4.xml ]; then + mkdir -p "${HOME}"/.config/xfce4/xfconf/xfce-perchannel-xml/ +cat <> "${HOME}"/.config/xfce4/xfconf/xfce-perchannel-xml/xfwm4.xml + + + + + + +EOT +fi + +# Launch DE /usr/bin/xfce4-session > /dev/null 2>&1