From 2bb60e2cecd6612778241ea9a5ac16b065ebfa93 Mon Sep 17 00:00:00 2001
From: "push-app-to-main[bot]"
 <203845782+push-app-to-main[bot]@users.noreply.github.com>
Date: Sat, 7 Mar 2026 23:46:36 +0100
Subject: [PATCH] ImmichFrame (#12653)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: push-app-to-main[bot] <203845782+push-app-to-main[bot]@users.noreply.github.com>
Co-authored-by: CanbiZ (MickLesk) <47820557+MickLesk@users.noreply.github.com>
Co-authored-by: MickLesk <mickey.leskowitz@gmail.com>
Co-authored-by: Slaviša Arežina <58952836+tremor021@users.noreply.github.com>
Co-authored-by: Tobias <96661824+CrazyWolf13@users.noreply.github.com>
---
 ct/immichframe.sh                     | 81 ++++++++++++++++++++++++++
 frontend/public/json/immichframe.json | 40 +++++++++++++
 install/immichframe-install.sh        | 84 +++++++++++++++++++++++++++
 3 files changed, 205 insertions(+)
 create mode 100644 ct/immichframe.sh
 create mode 100644 frontend/public/json/immichframe.json
 create mode 100644 install/immichframe-install.sh

diff --git a/ct/immichframe.sh b/ct/immichframe.sh
new file mode 100644
index 000000000..bbd10a835
--- /dev/null
+++ b/ct/immichframe.sh
@@ -0,0 +1,81 @@
+#!/usr/bin/env bash
+source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func)
+# Copyright (c) 2021-2026 community-scripts ORG
+# Author: Thiago Canozzo Lahr (tclahr)
+# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
+# Source: https://github.com/immichFrame/ImmichFrame
+
+APP="ImmichFrame"
+var_tags="${var_tags:-photos;slideshow}"
+var_cpu="${var_cpu:-1}"
+var_ram="${var_ram:-1024}"
+var_disk="${var_disk:-8}"
+var_os="${var_os:-debian}"
+var_version="${var_version:-13}"
+var_unprivileged="${var_unprivileged:-1}"
+
+header_info "$APP"
+variables
+color
+catch_errors
+
+function update_script() {
+  header_info
+  check_container_storage
+  check_container_resources
+
+  if [[ ! -d /opt/immichframe ]]; then
+    msg_error "No ${APP} Installation Found!"
+    exit
+  fi
+
+  if check_for_gh_release "immichframe" "immichFrame/ImmichFrame"; then
+    msg_info "Stopping Service"
+    systemctl stop immichframe
+    msg_ok "Stopped Service"
+
+    msg_info "Backing up Configuration"
+    cp -r /opt/immichframe/Config /tmp/immichframe_config.bak
+    msg_ok "Backed up Configuration"
+
+    CLEAN_INSTALL=1 fetch_and_deploy_gh_release "immichframe" "immichFrame/ImmichFrame" "tarball" "latest" "/tmp/immichframe"
+
+    msg_info "Setting up ImmichFrame"
+    cd /tmp/immichframe
+    $STD dotnet publish ImmichFrame.WebApi/ImmichFrame.WebApi.csproj \
+      --configuration Release \
+      --runtime linux-x64 \
+      --self-contained false \
+      --output /opt/immichframe
+
+    cd /tmp/immichframe/immichFrame.Web
+    $STD npm ci --silent
+    $STD npm run build
+    rm -rf /opt/immichframe/wwwroot/*
+    cp -r build/* /opt/immichframe/wwwroot
+    rm -rf /tmp/immichframe
+    msg_ok "Setup ImmichFrame"
+
+    msg_info "Restoring Configuration"
+    cp -r /tmp/immichframe_config.bak/* /opt/immichframe/Config/
+    rm -rf /tmp/immichframe_config.bak
+    chown -R immichframe:immichframe /opt/immichframe
+    msg_ok "Restored Configuration"
+
+
+    msg_info "Starting Service"
+    systemctl start immichframe
+    msg_ok "Started Service"
+    msg_ok "Updated successfully!"
+  fi
+  exit
+}
+
+start
+build_container
+description
+
+msg_ok "Completed successfully!\n"
+echo -e "${CREATING}${GN}${APP} setup has been successfully initialized!${CL}"
+echo -e "${INFO}${YW} Access it using the following URL:${CL}"
+echo -e "${TAB}${GATEWAY}${BGN}http://${IP}:8080${CL}"
diff --git a/frontend/public/json/immichframe.json b/frontend/public/json/immichframe.json
new file mode 100644
index 000000000..1d3575bcd
--- /dev/null
+++ b/frontend/public/json/immichframe.json
@@ -0,0 +1,40 @@
+{
+  "name": "ImmichFrame",
+  "slug": "immichframe",
+  "categories": [
+    13
+  ],
+  "date_created": "2026-02-26",
+  "type": "ct",
+  "updateable": true,
+  "privileged": false,
+  "interface_port": 8080,
+  "documentation": "https://immichframe.dev/docs/overview",
+  "config_path": "/opt/immichframe/Config/Settings.yml",
+  "website": "https://immichframe.dev/",
+  "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/immich-frame.webp",
+  "description": "ImmichFrame is a digital photo frame web application that connects to your Immich server and displays your photos as a fullscreen slideshow.",
+  "install_methods": [
+    {
+      "type": "default",
+      "script": "ct/immichframe.sh",
+      "resources": {
+        "cpu": 1,
+        "ram": 1024,
+        "hdd": 8,
+        "os": "Debian",
+        "version": "13"
+      }
+    }
+  ],
+  "default_credentials": {
+    "username": null,
+    "password": null
+  },
+  "notes": [
+    {
+      "text": "After installation, edit `/opt/immichframe/Config/Settings.yml` and set ImmichServerUrl and ApiKey. Then restart the service with `systemctl restart immichframe`.",
+      "type": "warning"
+    }
+  ]
+}
\ No newline at end of file
diff --git a/install/immichframe-install.sh b/install/immichframe-install.sh
new file mode 100644
index 000000000..c90dbeb6e
--- /dev/null
+++ b/install/immichframe-install.sh
@@ -0,0 +1,84 @@
+#!/usr/bin/env bash
+
+# Copyright (c) 2021-2026 community-scripts ORG
+# Author: Thiago Canozzo Lahr (tclahr)
+# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
+# Source: https://github.com/immichFrame/ImmichFrame
+
+source /dev/stdin <<<"$FUNCTIONS_FILE_PATH"
+color
+verb_ip6
+catch_errors
+setting_up_container
+network_check
+update_os
+
+msg_info "Installing Dependencies"
+setup_deb822_repo \
+  "microsoft" \
+  "https://packages.microsoft.com/keys/microsoft-2025.asc" \
+  "https://packages.microsoft.com/debian/13/prod/" \
+  "trixie" \
+  "main"
+$STD apt install -y \
+  libicu-dev \
+  libssl-dev \
+  gettext-base \
+  dotnet-sdk-8.0 \
+  aspnetcore-runtime-8.0
+msg_ok "Installed Dependencies"
+
+NODE_VERSION="22" setup_nodejs
+fetch_and_deploy_gh_release "immichframe" "immichFrame/ImmichFrame" "tarball" "latest" "/tmp/immichframe"
+
+msg_info "Setting up ImmichFrame"
+mkdir -p /opt/immichframe
+cd /tmp/immichframe
+$STD dotnet publish ImmichFrame.WebApi/ImmichFrame.WebApi.csproj \
+  --configuration Release \
+  --runtime linux-x64 \
+  --self-contained false \
+  --output /opt/immichframe
+cd /tmp/immichframe/immichFrame.Web
+$STD npm ci
+$STD npm run build
+cp -r build/* /opt/immichframe/wwwroot
+$STD apt remove -y dotnet-sdk-8.0
+$STD apt autoremove -y
+rm -rf /tmp/immichframe
+mkdir -p /opt/immichframe/Config
+curl -fsSL "https://raw.githubusercontent.com/immichFrame/ImmichFrame/main/docker/Settings.example.yml" -o /opt/immichframe/Config/Settings.yml
+useradd -r -s /sbin/nologin -d /opt/immichframe -M immichframe
+chown -R immichframe:immichframe /opt/immichframe
+msg_ok "Setup ImmichFrame"
+
+msg_info "Creating Service"
+cat <<EOF >/etc/systemd/system/immichframe.service
+[Unit]
+Description=ImmichFrame Digital Photo Frame
+After=network.target
+
+[Service]
+Type=simple
+User=immichframe
+Group=immichframe
+WorkingDirectory=/opt/immichframe
+ExecStart=/usr/bin/dotnet /opt/immichframe/ImmichFrame.WebApi.dll
+Environment=ASPNETCORE_URLS=http://0.0.0.0:8080
+Environment=ASPNETCORE_ENVIRONMENT=Production
+Environment=DOTNET_CONTENTROOT=/opt/immichframe
+Restart=always
+RestartSec=5
+StandardOutput=journal
+StandardError=journal
+SyslogIdentifier=immichframe
+
+[Install]
+WantedBy=multi-user.target
+EOF
+systemctl enable -q --now immichframe
+msg_ok "Created Service"
+
+motd_ssh
+customize
+cleanup_lxc