diff --git a/ct/headers/immich b/ct/headers/immich new file mode 100644 index 0000000..ab13925 --- /dev/null +++ b/ct/headers/immich @@ -0,0 +1,6 @@ + ____ _ __ + / _/___ ___ ____ ___ (_)____/ /_ + / // __ `__ \/ __ `__ \/ / ___/ __ \ + _/ // / / / / / / / / / / / /__/ / / / +/___/_/ /_/ /_/_/ /_/ /_/_/\___/_/ /_/ + diff --git a/ct/immich.sh b/ct/immich.sh new file mode 100644 index 0000000..56c7ffb --- /dev/null +++ b/ct/immich.sh @@ -0,0 +1,41 @@ +#!/usr/bin/env bash +source <(curl -s https://raw.githubusercontent.com/community-scripts/ProxmoxVED/main/misc/build.func) +# Copyright (c) 2021-2025 community-scripts ORG +# Author: vhsdream +# License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE +# Source: https://immich.app + +APP="immich" +var_tags="${var_tags:-photos}" +var_disk="${var_disk:-12}" +var_cpu="${var_cpu:-4}" +var_ram="${var_ram:-4096}" +var_os="${var_os:-debian}" +var_version="${var_version:-12}" +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/immich ]]; then + msg_error "No ${APP} Installation Found!" + exit + fi + msg_error "Currently we don't provide an update function for ${APP}." + 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}:2283${CL}" diff --git a/frontend/public/json/immich.json b/frontend/public/json/immich.json new file mode 100644 index 0000000..ca884a3 --- /dev/null +++ b/frontend/public/json/immich.json @@ -0,0 +1,43 @@ +{ + "name": "Immich", + "slug": "immich", + "categories": [ + 13 + ], + "date_created": "2025-03-30", + "type": "ct", + "updateable": false, + "privileged": false, + "interface_port": 2283, + "documentation": "https://immich.app/docs/overview/introduction", + "website": "https://immich.app", + "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons/png/immich.png", + "description": "High performance self-hosted photo and video management solution.", + "install_methods": [ + { + "type": "default", + "script": "ct/immich.sh", + "resources": { + "cpu": 4, + "ram": 4096, + "hdd": 12, + "os": "Debian", + "version": "12" + } + } + ], + "default_credentials": { + "username": null, + "password": null + }, + "notes": [ + { + "text": "Change the machine-learning URL to `http://localhost:3003` after installation", + "type": "info" + }, + { + "text": "GPU acceleration is not enabled for this installation", + "type": "info" + } + ] +} diff --git a/install/immich-install.sh b/install/immich-install.sh new file mode 100644 index 0000000..47571b7 --- /dev/null +++ b/install/immich-install.sh @@ -0,0 +1,411 @@ +#!/usr/bin/env bash + +# Copyright (c) 2021-2025 community-scripts ORG +# Author: vhsdream +# License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE +# Source: https://immich.app + +source /dev/stdin <<<"$FUNCTIONS_FILE_PATH" +color +verb_ip6 +catch_errors +setting_up_container +network_check +update_os + +msg_info "Configuring apt and installing base dependencies" +echo "deb http://deb.debian.org/debian testing main contrib" >/etc/apt/sources.list.d/immich.list +{ + echo "Package: *" + echo "Pin: release a=testing" + echo "Pin-Priority: -10" + +} >/etc/apt/preferences.d/immich +$STD apt-get update +$STD apt-get install --no-install-recommends -y \ + git \ + redis \ + python3-venv \ + python3-dev \ + gnupg \ + autoconf \ + build-essential \ + cmake \ + jq \ + libbrotli-dev \ + libde265-dev \ + libexif-dev \ + libexpat1-dev \ + libglib2.0-dev \ + libgsf-1-dev \ + libjpeg62-turbo-dev \ + liblcms2-2 \ + librsvg2-dev \ + libspng-dev \ + meson \ + ninja-build \ + pkg-config \ + cpanminus \ + libde265-0 \ + libexif12 \ + libexpat1 \ + libgcc-s1 \ + libglib2.0-0 \ + libgomp1 \ + libgsf-1-114 \ + liblcms2-2 \ + liblqr-1-0 \ + libltdl7 \ + libmimalloc2.0 \ + libopenexr-3-1-30 \ + libopenjp2-7 \ + librsvg2-2 \ + libspng0 \ + mesa-utils \ + mesa-va-drivers \ + mesa-vulkan-drivers \ + tini \ + zlib1g \ + ocl-icd-libopencl1 \ + intel-media-va-driver +$STD apt-get install -y \ + libgdk-pixbuf-2.0-dev librsvg2-dev libtool +curl -fsSL https://repo.jellyfin.org/jellyfin_team.gpg.key | gpg --dearmor -o /etc/apt/keyrings/jellyfin.gpg +DPKG_ARCHITECTURE="$(dpkg --print-architecture)" +export DPKG_ARCHITECTURE +cat </etc/apt/sources.list.d/jellyfin.sources +Types: deb +URIs: https://repo.jellyfin.org/debian +Suites: bookworm +Components: main +Architectures: ${DPKG_ARCHITECTURE} +Signed-By: /etc/apt/keyrings/jellyfin.gpg +EOF +$STD apt-get update +$STD apt-get install -y jellyfin-ffmpeg7 +ln -s /usr/lib/jellyfin-ffmpeg/ffmpeg /usr/bin/ffmpeg +ln -s /usr/lib/jellyfin-ffmpeg/ffprobe /usr/bin/ffprobe +tmp_dir=$(mktemp -d) +cd $tmp_dir +curl -fsSL https://github.com/intel/intel-graphics-compiler/releases/download/igc-1.0.17193.4/intel-igc-core_1.0.17193.4_amd64.deb -O +curl -fsSL https://github.com/intel/intel-graphics-compiler/releases/download/igc-1.0.17193.4/intel-igc-opencl_1.0.17193.4_amd64.deb -O +curl -fsSL https://github.com/intel/compute-runtime/releases/download/24.26.30049.6/intel-opencl-icd_24.26.30049.6_amd64.deb -O +curl -fsSL https://github.com/intel/compute-runtime/releases/download/24.26.30049.6/libigdgmm12_22.3.20_amd64.deb -O +$STD dpkg -i ./*.deb +msg_ok "Base Dependencies Installed" + +msg_info "Setting up Postgresql Database" +$STD apt-get install -y postgresql-common +echo "YES" | /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh &>/dev/null +$STD apt-get install -y postgresql-17 postgresql-17-pgvector +DB_NAME="immich" +DB_USER="immich" +DB_PASS=$(openssl rand -base64 18 | tr -dc 'a-zA-Z0-9' | head -c18) +$STD sudo -u postgres psql -c "CREATE USER $DB_USER WITH ENCRYPTED PASSWORD '$DB_PASS';" +$STD sudo -u postgres psql -c "CREATE DATABASE $DB_NAME WITH OWNER $DB_USER ENCODING 'UTF8' TEMPLATE template0;" +$STD sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE $DB_NAME to $DB_USER;" +$STD sudo -u postgres psql -c "ALTER USER $DB_USER WITH SUPERUSER;" +{ + echo "${APPLICATION} DB Credentials" + echo "Database User: $DB_USER" + echo "Database Password: $DB_PASS" + echo "Database Name: $DB_NAME" +} >>~/${APPLICATION}.creds +msg_ok "Set up Postgresql Database" + +msg_info "Installing NodeJS" +curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg +echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_22.x nodistro main" >/etc/apt/sources.list.d/nodesource.list +$STD apt-get update +$STD apt-get install -y nodejs +msg_ok "Installed NodeJS" + +msg_info "Installing Packages from Testing Repo" +export APT_LISTCHANGES_FRONTEND=none +export DEBIAN_FRONTEND=noninteractive +$STD apt-get install -t testing --no-install-recommends -y \ + libio-compress-brotli-perl \ + libwebp7 \ + libwebpdemux2 \ + libwebpmux3 \ + libhwy1t64 \ + libdav1d-dev \ + libhwy-dev \ + libwebp-dev +msg_ok "Packages from Testing Repo Installed" + +# Fix default DB collation issue +$STD sudo -u postgres psql -c "ALTER DATABASE postgres REFRESH COLLATION VERSION;" +$STD sudo -u postgres psql -c "ALTER DATABASE $DB_NAME REFRESH COLLATION VERSION;" + +msg_info "Compiling Custom Photo-processing Library (extreme patience)" +STAGING_DIR=/opt/staging +BASE_REPO="https://github.com/immich-app/base-images" +BASE_DIR=${STAGING_DIR}/base-images +SOURCE_DIR=${STAGING_DIR}/image-source +$STD git clone -b main ${BASE_REPO} ${BASE_DIR} # TODO: convert this git clone into a TAG download +mkdir -p ${SOURCE_DIR} + +cd ${STAGING_DIR} +SOURCE=${SOURCE_DIR}/libjxl +JPEGLI_LIBJPEG_LIBRARY_SOVERSION="62" +JPEGLI_LIBJPEG_LIBRARY_VERSION="62.3.0" +: "${LIBJXL_REVISION:=$(jq -cr '.sources[] | select(.name == "libjxl").revision' $BASE_DIR/server/bin/build-lock.json)}" +$STD git clone https://github.com/libjxl/libjxl.git ${SOURCE} +cd ${SOURCE} +$STD git reset --hard "${LIBJXL_REVISION}" +$STD git submodule update --init --recursive --depth 1 --recommend-shallow +$STD git apply ${BASE_DIR}/server/bin/patches/jpegli-empty-dht-marker.patch +$STD git apply ${BASE_DIR}/server/bin/patches/jpegli-icc-warning.patch +mkdir build +cd build +$STD cmake \ + -DCMAKE_BUILD_TYPE=Release \ + -DBUILD_TESTING=OFF \ + -DJPEGXL_ENABLE_DOXYGEN=OFF \ + -DJPEGXL_ENABLE_MANPAGES=OFF \ + -DJPEGXL_ENABLE_PLUGIN_GIMP210=OFF \ + -DJPEGXL_ENABLE_BENCHMARK=OFF \ + -DJPEGXL_ENABLE_EXAMPLES=OFF \ + -DJPEGXL_FORCE_SYSTEM_BROTLI=ON \ + -DJPEGXL_FORCE_SYSTEM_HWY=ON \ + -DJPEGXL_ENABLE_JPEGLI=ON \ + -DJPEGXL_ENABLE_JPEGLI_LIBJPEG=ON \ + -DJPEGXL_INSTALL_JPEGLI_LIBJPEG=ON \ + -DJPEGXL_ENABLE_PLUGINS=ON \ + -DJPEGLI_LIBJPEG_LIBRARY_SOVERSION="${JPEGLI_LIBJPEG_LIBRARY_SOVERSION}" \ + -DJPEGLI_LIBJPEG_LIBRARY_VERSION="${JPEGLI_LIBJPEG_LIBRARY_VERSION}" \ + -DLIBJPEG_TURBO_VERSION_NUMBER=2001005 \ + .. +$STD cmake --build . -- -j"$(nproc)" +$STD cmake --install . +$STD ldconfig /usr/local/lib +$STD make clean +cd ${STAGING_DIR} +rm -rf ${SOURCE}/{build,third_party} + +SOURCE=${SOURCE_DIR}/libheif +: "${LIBHEIF_REVISION:=$(jq -cr '.sources[] | select(.name == "libheif").revision' $BASE_DIR/server/bin/build-lock.json)}" +$STD git clone https://github.com/strukturag/libheif.git ${SOURCE} +cd ${SOURCE} +$STD git reset --hard "${LIBHEIF_REVISION}" +mkdir build +cd build +$STD cmake --preset=release-noplugins \ + -DWITH_DAV1D=ON \ + -DENABLE_PARALLEL_TILE_DECODING=ON \ + -DWITH_LIBSHARPYUV=ON \ + -DWITH_LIBDE265=ON \ + -DWITH_AOM_DECODER=OFF \ + -DWITH_AOM_ENCODER=OFF \ + -DWITH_X265=OFF \ + -DWITH_EXAMPLES=OFF \ + .. +$STD make install +ldconfig /usr/local/lib +$STD make clean +cd ${STAGING_DIR} +rm -rf ${SOURCE}/build + +SOURCE=${SOURCE_DIR}/libraw +: "${LIBRAW_REVISION:=$(jq -cr '.sources[] | select(.name == "libraw").revision' $BASE_DIR/server/bin/build-lock.json)}" +$STD git clone https://github.com/libraw/libraw.git ${SOURCE} +cd ${SOURCE} +$STD git reset --hard "${LIBRAW_REVISION}" +$STD autoreconf --install +$STD ./configure +$STD make -j"$(nproc)" +$STD make install +ldconfig /usr/local/lib +$STD make clean +cd ${STAGING_DIR} + +SOURCE=$SOURCE_DIR/imagemagick +: "${IMAGEMAGICK_REVISION:=$(jq -cr '.sources[] | select(.name == "imagemagick").revision' $BASE_DIR/server/bin/build-lock.json)}" +$STD git clone https://github.com/ImageMagick/ImageMagick.git $SOURCE +cd $SOURCE +$STD git reset --hard "${IMAGEMAGICK_REVISION}" +$STD ./configure --with-modules +$STD make -j"$(nproc)" +$STD make install +ldconfig /usr/local/lib +$STD make clean +cd ${STAGING_DIR} + +SOURCE=$SOURCE_DIR/libvips +: "${LIBVIPS_REVISION:=$(jq -cr '.sources[] | select(.name == "libvips").revision' $BASE_DIR/server/bin/build-lock.json)}" +$STD git clone https://github.com/libvips/libvips.git ${SOURCE} +cd ${SOURCE} +$STD git reset --hard "${LIBVIPS_REVISION}" +$STD meson setup build --buildtype=release --libdir=lib -Dintrospection=disabled -Dtiff=disabled +cd build +$STD ninja install +$STD ldconfig /usr/local/lib +cd ${STAGING_DIR} +rm -rf ${SOURCE}/build +msg_ok "Custom Photo-processing Library Compiled" + +msg_info "Installing ${APPLICATION} (more patience please)" +tmp_file=$(mktemp) +RELEASE=$(curl -s https://api.github.com/repos/immich-app/immich/releases?per_page=1 | grep "tag_name" | awk '{print substr($2, 3, length($2)-4) }') +curl -fsSL "https://github.com/immich-app/immich/archive/refs/tags/v${RELEASE}.zip" -o $tmp_file +unzip -q $tmp_file +INSTALL_DIR="/opt/${APPLICATION}" +UPLOAD_DIR="${INSTALL_DIR}/upload" +SRC_DIR="${INSTALL_DIR}/source" +APP_DIR="${INSTALL_DIR}/app" +ML_DIR="${APP_DIR}/machine-learning" +GEO_DIR="${INSTALL_DIR}/geodata" +mkdir -p ${INSTALL_DIR} +mv ${APPLICATION}-${RELEASE}/ ${SRC_DIR} +mkdir -p {${APP_DIR},${UPLOAD_DIR},${GEO_DIR},${ML_DIR},${INSTALL_DIR}/cache} + +cd ${SRC_DIR}/server +$STD npm ci +$STD npm run build +$STD npm prune --omit=dev --omit=optional +cd ${SRC_DIR}/open-api/typescript-sdk +$STD npm ci +$STD npm run build +cd ${SRC_DIR}/web +$STD npm ci +$STD npm run build +cd ${SRC_DIR} +cp -a server/{node_modules,dist,bin,resources,package.json,package-lock.json,start*.sh} ${APP_DIR}/ +cp -a web/build ${APP_DIR}/www +cp LICENSE ${APP_DIR} +cp ${BASE_DIR}/server/bin/build-lock.json ${APP_DIR} + +cd ${SRC_DIR}/machine-learning +$STD python3 -m venv ${ML_DIR}/ml-venv +( + . ${ML_DIR}/ml-venv/bin/activate + $STD pip3 install uv + $STD uv sync --extra cpu --active +) +cd ${SRC_DIR} +cp -a machine-learning/{ann,start.sh,app} ${ML_DIR} +ln -sf ${APP_DIR}/resources ${INSTALL_DIR} + +cd ${APP_DIR} +grep -Rl /usr/src | xargs -n1 sed -i "s|\/usr/src|$INSTALL_DIR|g" +sed -i "s|\"/cache\"|\"$INSTALL_DIR/cache\"|g" $ML_DIR/app/config.py +grep -RlE "'/build'" | xargs -n1 sed -i "s|'/build'|'$APP_DIR'|g" +ln -s ${UPLOAD_DIR} ${APP_DIR}/upload +ln -s ${UPLOAD_DIR} ${ML_DIR}/upload + +msg_info "Installing Immich CLI" +$STD npm install --build-from-source sharp +rm -rf ${APP_DIR}/node_modules/@img/sharp-{libvips*,linuxmusl-x64} +$STD npm i -g @immich/cli +msg_ok "Installed Immich CLI" + +msg_info "Installing GeoNames data" +cd ${GEO_DIR} +URL_LIST=( + https://download.geonames.org/export/dump/admin1CodesASCII.txt + https://download.geonames.org/export/dump/admin2Codes.txt + https://download.geonames.org/export/dump/cities500.zip + https://raw.githubusercontent.com/nvkelso/natural-earth-vector/v5.1.2/geojson/ne_10m_admin_0_countries.geojson +) +echo "${URL_LIST[@]}" | xargs -n1 -P 8 wget -q +unzip -q cities500.zip +date --iso-8601=seconds | tr -d "\n" >geodata-date.txt +cd ${INSTALL_DIR} +ln -s ${GEO_DIR} ${APP_DIR} +msg_ok "Installed GeoNames data" + +mkdir -p /var/log/immich +touch /var/log/immich/{web.log,ml.log} +echo "${RELEASE}" >/opt/${APPLICATION}_version.txt +msg_ok "Installed ${APPLICATION}" + +msg_info "Creating env file, scripts & services" +cat <${INSTALL_DIR}/.env +TZ=$(cat /etc/timezone) +IMMICH_VERSION=release +IMMICH_ENV=production + +DB_HOSTNAME=localhost +DB_USERNAME=${DB_USER} +DB_PASSWORD=${DB_PASS} +DB_DATABASE_NAME=${DB_NAME} +DB_VECTOR_EXTENSION=pgvector + +REDIS_HOSTNAME=localhost + +MACHINE_LEARNING_CACHE_FOLDER=${INSTALL_DIR}/cache +EOF +cat <${ML_DIR}/start.sh +#!/usr/bin/env bash + +cd ${ML_DIR} +. ml-venv/bin/activate + +: "\${MACHINE_LEARNING_HOST:=127.0.0.1}" +: "\${MACHINE_LEARNING_PORT:=3003}" +: "\${MACHINE_LEARNING_WORKERS:=1}" +: "\${MACHINE_LEARNING_WORKER_TIMEOUT:=120}" + +exec gunicorn app.main:app \ + -k app.config.CustomUvicornWorker \ + -w "\$MACHINE_LEARNING_WORKERS" \ + -b "\$MACHINE_LEARNING_HOST":"\$MACHINE_LEARNING_PORT" \ + -t "\$MACHINE_LEARNING_WORKER_TIMEOUT" \ + --log-config-json log_conf.json \ + --graceful-timeout 0 +EOF +cat </etc/systemd/system/${APPLICATION}-web.service +[Unit] +Description=${APPLICATION} Web Service +After=network.target +Requires=redis-server.service +Requires=postgresql.service +Requires=immich-ml.service + +[Service] +Type=simple +User=root +WorkingDirectory=${APP_DIR} +EnvironmentFile=${INSTALL_DIR}/.env +ExecStart=/usr/bin/node dist/main "\$@" +Restart=on-failure +SyslogIdentifier=immich-web +StandardOutput=append:/var/log/immich/web.log +StandardError=append:/var/log/immich/web.log + +[Install] +WantedBy=multi-user.target +EOF +cat </etc/systemd/system/${APPLICATION}-ml.service +[Unit] +Description=${APPLICATION} Machine-Learning +After=network.target + +[Service] +Type=simple +User=root +WorkingDirectory=${APP_DIR} +EnvironmentFile=${INSTALL_DIR}/.env +ExecStart=${ML_DIR}/start.sh +Restart=on-failure +SyslogIdentifier=immich-machine-learning +StandardOutput=append:/var/log/immich/ml.log +StandardError=append:/var/log/immich/ml.log + +[Install] +WantedBy=multi-user.target +EOF +systemctl enable -q --now ${APPLICATION}-ml.service ${APPLICATION}-web.service +msg_ok "Created env file, scripts and services" + +sed -i "$ a VERSION_ID=12" /etc/os-release # otherwise the motd_ssh function will fail +motd_ssh +customize + +msg_info "Cleaning up" +rm -f $tmp_file +rm -rf $tmp_dir +$STD apt-get -y autoremove +$STD apt-get -y autoclean +msg_ok "Cleaned"