From 12af9b20c9ed50ef9d3b0ad3cb5ffe4cc0fb18b4 Mon Sep 17 00:00:00 2001 From: aptalca <541623+aptalca@users.noreply.github.com> Date: Tue, 29 Jul 2025 08:08:46 -0400 Subject: [PATCH] rebase to selkies --- Dockerfile | 6 +-- Jenkinsfile | 4 +- README.md | 126 +++++++++++++++++++++++++++++++++++------------ jenkins-vars.yml | 4 +- readme-vars.yml | 52 ++----------------- 5 files changed, 105 insertions(+), 87 deletions(-) diff --git a/Dockerfile b/Dockerfile index 69a6459..50e6453 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,6 +1,6 @@ # syntax=docker/dockerfile:1 -FROM ghcr.io/linuxserver/baseimage-kasmvnc:debianbookworm +FROM ghcr.io/linuxserver/baseimage-selkies:debianbookworm # set version label ARG BUILD_DATE @@ -15,7 +15,7 @@ ENV TITLE=RawTherapee RUN \ echo "**** add icon ****" && \ curl -o \ - /kclient/public/icon.png \ + /usr/share/selkies/www/icon.png \ https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/rawtherapee-logo.png && \ echo "**** install packages ****" && \ apt-get update && \ @@ -53,5 +53,5 @@ RUN \ COPY /root / # ports and volumes -EXPOSE 3000 +EXPOSE 3001 VOLUME /config diff --git a/Jenkinsfile b/Jenkinsfile index 3624cbf..d3cd50f 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -32,8 +32,8 @@ pipeline { MULTIARCH = 'false' CI = 'true' CI_WEB = 'true' - CI_PORT = '3000' - CI_SSL = 'false' + CI_PORT = '3001' + CI_SSL = 'true' CI_DELAY = '120' CI_DOCKERENV = '' CI_AUTH = '' diff --git a/README.md b/README.md index 611b265..b37cefa 100644 --- a/README.md +++ b/README.md @@ -58,55 +58,116 @@ The architectures supported by this image are: The application can be accessed at: -* http://yourhost:3000/ * https://yourhost:3001/ -### Options in all KasmVNC based GUI containers +### Strict reverse proxies -This container is based on [Docker Baseimage KasmVNC](https://github.com/linuxserver/docker-baseimage-kasmvnc) which means there are additional environment variables and run configurations to enable or disable specific functionality. +This image uses a self-signed certificate by default. This naturally means the scheme is `https`. +If you are using a reverse proxy which validates certificates, you need to [disable this check for the container](https://docs.linuxserver.io/faq#strict-proxy). -#### Optional environment variables +**Modern GUI desktop apps may have compatibility issues with the latest Docker syscall restrictions. You can use Docker with the `--security-opt seccomp=unconfined` setting to allow these syscalls on hosts with older Kernels or libseccomp versions.** -| Variable | Description | -| :----: | --- | -| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. | -| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. | -| CUSTOM_USER | HTTP Basic auth username, abc is default. | -| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth | -| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` | -| TITLE | The page title displayed on the web browser, default "KasmVNC Client". | -| FM_HOME | This is the home directory (landing) for the file manager, default "/config". | -| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. | -| DRINODE | If mounting in /dev/dri for [DRI3 GPU Acceleration](https://www.kasmweb.com/kasmvnc/docs/master/gpu_acceleration.html) allows you to specify the device to use IE `/dev/dri/renderD128` | -| 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 for use as a PWA. | -| NO_FULL | Do not autmatically fullscreen applications when using openbox. | - -#### Optional run configurations +### Security + +>[!WARNING] +>This container provides privileged access to the host system. Do not expose it to the Internet unless you have secured it properly. + +**HTTPS is required for full functionality.** Modern browser features such as WebCodecs, used for video and audio, will not function over an insecure HTTP connection. + +By default, this container has no authentication. The optional `CUSTOM_USER` and `PASSWORD` environment variables enable basic HTTP auth, which is suitable only for securing the container on a trusted local network. For internet exposure, we strongly recommend placing the container behind a reverse proxy, such as [SWAG](https://github.com/linuxserver/docker-swag), with a robust authentication mechanism. + +The web interface includes a terminal with passwordless `sudo` access. Any user with access to the GUI can gain root control within the container, install arbitrary software, and probe your local network. + +### Options in all Selkies-based GUI containers + +This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies), which provides the following environment variables and run configurations to customize its functionality. + +#### Optional Environment Variables | Variable | Description | | :----: | --- | -| `--privileged` | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE `-v /home/user/docker-data:/var/lib/docker`. | -| `-v /var/run/docker.sock:/var/run/docker.sock` | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. | -| `--device /dev/dri:/dev/dri` | Mount a GPU into the container, this can be used in conjunction with the `DRINODE` environment variable to leverage a host video card for GPU accelerated appplications. Only **Open Source** drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) | +| `CUSTOM_PORT` | Internal HTTP port. Defaults to `3000`. | +| `CUSTOM_HTTPS_PORT` | Internal HTTPS port. Defaults to `3001`. | +| `CUSTOM_USER` | Username for HTTP Basic Auth. Defaults to `abc`. | +| `PASSWORD` | Password for HTTP Basic Auth. If unset, authentication is disabled. | +| `SUBFOLDER` | Application subfolder for reverse proxy configurations. Must include leading and trailing slashes, e.g., `/subfolder/`. | +| `TITLE` | Page title displayed in the web browser. Defaults to "Selkies". | +| `START_DOCKER` | If set to `false`, the privileged Docker-in-Docker setup will not start automatically. | +| `DISABLE_IPV6` | Set to `true` to disable IPv6 support in the container. | +| `LC_ALL` | Sets the container's locale, e.g., `fr_FR.UTF-8`. | +| `DRINODE` | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE `/dev/dri/renderD128` | +| `NO_DECOR` | If set, applications will run without window borders, suitable for PWA usage. | +| `NO_FULL` | If set, applications will not be automatically fullscreened. | +| `DISABLE_ZINK` | If set, Zink-related environment variables will not be configured when a video card is detected. | +| `WATERMARK_PNG` | Full path to a watermark PNG file inside the container, e.g., `/usr/share/selkies/www/icon.png`. | +| `WATERMARK_LOCATION` | Integer specifying the watermark location: `1` (Top Left), `2` (Top Right), `3` (Bottom Left), `4` (Bottom Right), `5` (Centered), `6` (Animated). | + +#### Optional Run Configurations + +| Argument | Description | +| :----: | --- | +| `--privileged` | Starts a Docker-in-Docker (DinD) environment. For better performance, mount the Docker data directory from the host, e.g., `-v /path/to/docker-data:/var/lib/docker`. | +| `-v /var/run/docker.sock:/var/run/docker.sock` | Mounts the host's Docker socket to manage host containers from within this container. | +| `--device /dev/dri:/dev/dri` | Mount a GPU into the container, this can be used in conjunction with the `DRINODE` environment variable to leverage a host video card for GPU accelerated applications. Only **Open Source** drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) | ### 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 launch the desktop session in a different language, set the `LC_ALL` environment variable. For example: + +* `-e LC_ALL=zh_CN.UTF-8` - Chinese +* `-e LC_ALL=ja_JP.UTF-8` - Japanese +* `-e LC_ALL=ko_KR.UTF-8` - Korean +* `-e LC_ALL=ar_AE.UTF-8` - Arabic +* `-e LC_ALL=ru_RU.UTF-8` - Russian +* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America) +* `-e LC_ALL=de_DE.UTF-8` - German +* `-e LC_ALL=fr_FR.UTF-8` - French +* `-e LC_ALL=nl_NL.UTF-8` - Netherlands +* `-e LC_ALL=it_IT.UTF-8` - Italian + +### DRI3 GPU Acceleration + +For accelerated apps or games, render devices can be mounted into the container and leveraged by applications using: -To install cjk fonts on startup as an example pass the environment variables: +`--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 | + +The `DRINODE` environment variable can be used to point to a specific GPU. + +DRI3 will work on aarch64 given the correct drivers are installed inside the container for your chipset. + +### Application Management + +There are two methods for installing applications inside the container: PRoot Apps (recommended for persistence) and Native Apps. + +#### PRoot Apps (Persistent) + +Natively installed packages (e.g., via `apt-get install`) will not persist if the container is recreated. To retain applications and their settings across container updates, we recommend using [proot-apps](https://github.com/linuxserver/proot-apps). These are portable applications installed to the user's persistent `$HOME` directory. + +To install an application, use the command line inside the container: ``` --e DOCKER_MODS=linuxserver/mods:universal-package-install --e INSTALL_PACKAGES=fonts-noto-cjk --e LC_ALL=zh_CN.UTF-8 +proot-apps install filezilla ``` -The web interface has the option for "IME Input Mode" in Settings which will allow non english characters to be used from a non en_US keyboard on the client. Once enabled it will perform the same as a local Linux installation set to your locale. +A list of supported applications is available [here](https://github.com/linuxserver/proot-apps?tab=readme-ov-file#supported-apps). -### Lossless mode +#### Native Apps (Non-Persistent) -This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information [here](https://www.kasmweb.com/docs/latest/how_to/lossless.html#technical-background). In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined [here](https://github.com/linuxserver/docker-baseimage-kasmvnc#lossless). +You can install packages from the system's native repository using the [universal-package-install](https://github.com/linuxserver/docker-mods/tree/universal-package-install) mod. This method will increase the container's start time and is not persistent. Add the following to your `compose.yaml`: + +```yaml + environment: + - DOCKER_MODS=linuxserver/mods:universal-package-install + - INSTALL_PACKAGES=libfuse2|git|gdb +``` ## Usage @@ -159,7 +220,7 @@ Containers are configured using parameters passed at runtime (such as those abov | Parameter | Function | | :----: | --- | -| `-p 3000:3000` | RawTherapee desktop gui. | +| `-p 3000:3000` | RawTherapee desktop gui (only for reverse proxy access). | | `-p 3001:3001` | RawTherapee desktop gui HTTPS. | | `-e PUID=1000` | for UserID - see below for explanation | | `-e PGID=1000` | for GroupID - see below for explanation | @@ -329,4 +390,5 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64 ## Versions +* **29.07.25:** - Rebase to selkies. Breaking Change: HTTPS is now required. Either use a reverse proxy with SSL cert or direct connect to port 8181 with HTTPS. * **24.09.24:** - Initial release. diff --git a/jenkins-vars.yml b/jenkins-vars.yml index 3996722..45c48d5 100644 --- a/jenkins-vars.yml +++ b/jenkins-vars.yml @@ -20,8 +20,8 @@ repo_vars: - MULTIARCH = 'false' - CI = 'true' - CI_WEB = 'true' - - CI_PORT = '3000' - - CI_SSL = 'false' + - CI_PORT = '3001' + - CI_SSL = 'true' - CI_DELAY = '120' - CI_DOCKERENV = '' - CI_AUTH = '' diff --git a/readme-vars.yml b/readme-vars.yml index 7fb99a8..9bdac61 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -19,65 +19,20 @@ param_volumes: - {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "User's home directory in the container, stores program settings and files."} param_usage_include_ports: true param_ports: - - {external_port: "3000", internal_port: "3000", port_desc: "RawTherapee desktop gui."} + - {external_port: "3000", internal_port: "3000", port_desc: "RawTherapee desktop gui (only for reverse proxy access)."} - {external_port: "3001", internal_port: "3001", port_desc: "RawTherapee desktop gui HTTPS."} 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 on older hosts as syscalls are unknown to Docker."} +# Selkies blurb settings +selkies_blurb: true # application setup block app_setup_block_enabled: true app_setup_block: | The application can be accessed at: - * http://yourhost:3000/ * https://yourhost:3001/ - ### Options in all KasmVNC based GUI containers - - This container is based on [Docker Baseimage KasmVNC](https://github.com/linuxserver/docker-baseimage-kasmvnc) which means there are additional environment variables and run configurations to enable or disable specific functionality. - - #### Optional environment variables - - | Variable | Description | - | :----: | --- | - | CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. | - | CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. | - | CUSTOM_USER | HTTP Basic auth username, abc is default. | - | PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth | - | SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` | - | TITLE | The page title displayed on the web browser, default "KasmVNC Client". | - | FM_HOME | This is the home directory (landing) for the file manager, default "/config". | - | START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. | - | DRINODE | If mounting in /dev/dri for [DRI3 GPU Acceleration](https://www.kasmweb.com/kasmvnc/docs/master/gpu_acceleration.html) allows you to specify the device to use IE `/dev/dri/renderD128` | - | 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 for use as a PWA. | - | NO_FULL | Do not autmatically fullscreen applications when using openbox. | - - #### Optional run configurations - - | Variable | Description | - | :----: | --- | - | `--privileged` | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE `-v /home/user/docker-data:/var/lib/docker`. | - | `-v /var/run/docker.sock:/var/run/docker.sock` | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. | - | `--device /dev/dri:/dev/dri` | Mount a GPU into the container, this can be used in conjunction with the `DRINODE` environment variable to leverage a host video card for GPU accelerated appplications. Only **Open Source** drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) | - - ### 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: - - ``` - -e DOCKER_MODS=linuxserver/mods:universal-package-install - -e INSTALL_PACKAGES=fonts-noto-cjk - -e LC_ALL=zh_CN.UTF-8 - ``` - - The web interface has the option for "IME Input Mode" in Settings which will allow non english characters to be used from a non en_US keyboard on the client. Once enabled it will perform the same as a local Linux installation set to your locale. - - ### Lossless mode - - This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information [here](https://www.kasmweb.com/docs/latest/how_to/lossless.html#technical-background). In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined [here](https://github.com/linuxserver/docker-baseimage-kasmvnc#lossless). # init diagram init_diagram: | "rawtherapee:latest": { @@ -140,4 +95,5 @@ init_diagram: | "rawtherapee:latest" <- Base Images # changelog changelogs: + - {date: "29.07.25:", desc: "Rebase to selkies. Breaking Change: HTTPS is now required. Either use a reverse proxy with SSL cert or direct connect to port 8181 with HTTPS."} - {date: "24.09.24:", desc: "Initial release."}