diff --git a/ct/immichframe.sh b/ct/immichframe.sh new file mode 100644 index 000000000..d21330cd8 --- /dev/null +++ b/ct/immichframe.sh @@ -0,0 +1,75 @@ +#!/usr/bin/env bash +COMMUNITY_SCRIPTS_URL="${COMMUNITY_SCRIPTS_URL:-https://git.community-scripts.org/community-scripts/ProxmoxVED/raw/branch/main}" +source <(curl -fsSL "$COMMUNITY_SCRIPTS_URL/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" + + CLEAN_INSTALL=1 fetch_and_deploy_gh_release "immichframe" "immichFrame/ImmichFrame" "tarball" "latest" "/tmp/immichframe" + + msg_info "Building Application" + 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 + chown -R immichframe:immichframe /opt/immichframe + msg_ok "Application Built" + + 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}" +echo -e "${INFO}${YW} Configuration file location:${CL}" +echo -e "${TAB}${GATEWAY}${BGN}/opt/immichframe/Config/Settings.yml${CL}" +echo -e "${INFO}${YW} Edit the config file and set ImmichServerUrl and ApiKey before use!${CL}" diff --git a/frontend/public/json/immichframe.json b/frontend/public/json/immichframe.json new file mode 100644 index 000000000..d39425d1b --- /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": null, + "config_path": "/opt/immichframe/Config/Settings.yml", + "website": null, + "logo": "https://github.com/selfhst/icons/blob/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": "info" + } + ] +} \ No newline at end of file diff --git a/install/immichframe-install.sh b/install/immichframe-install.sh new file mode 100644 index 000000000..46b46b076 --- /dev/null +++ b/install/immichframe-install.sh @@ -0,0 +1,99 @@ +#!/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-get 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 "Building Application" +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 +msg_ok "Application Built" + +msg_info "Removing Build Dependencies" +$STD apt-get remove -y dotnet-sdk-8.0 +$STD apt-get autoremove -y +rm -rf /tmp/immichframe +msg_ok "Removed Build Dependencies" + +msg_info "Configuring 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 +msg_ok "Configured ImmichFrame" + +msg_info "Creating immichframe User" +useradd -r -s /sbin/nologin -d /opt/immichframe -M immichframe 2>/dev/null +chown -R immichframe:immichframe /opt/immichframe +msg_ok "User immichframe Created" + +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