mirror of https://github.com/alexbelgium/hassio-addons.git synced 2026-01-10 09:51:02 +01:00

Files

Alexandre 8e4f8e1c1d Use #!/usr/bin/env bashio # shellcheck shell=bash set -euo pipefail CONFIG_HOME="/config" PGDATA="${PGDATA:-/config/database}" export PGDATA PG_MAJOR_VERSION="${PG_MAJOR:-15}" RESTART_FLAG_FILE="$CONFIG_HOME/restart_needed" fix_permissions() { mkdir -p "$PGDATA" chown -R postgres:postgres "$PGDATA" chmod 700 "$PGDATA" if [ -d /config/backups ]; then chown -R postgres:postgres /config/backups chmod 700 /config/backups fi } chmod -R 755 "$CONFIG_HOME" RESTART_NEEDED=false cd /config || true get_pgdata_version() { if [ -f "$PGDATA/PG_VERSION" ]; then cat "$PGDATA/PG_VERSION" else bashio::log.error "FATAL: $PGDATA/PG_VERSION not found; cannot determine cluster version." exit 1 fi } extract_so_from_deb() { local debfile="$1" local targetdir="$2" local sofile="$3" local tmpdir tmpdir=$(mktemp -d) dpkg-deb -x "$debfile" "$tmpdir" find "$tmpdir" -name "$sofile" -exec cp {} "$targetdir" \; rm -rf "$tmpdir" } install_vchord_and_vectors_for_old_pg() { local old_pgver="$1" local vectorchord_tag="${VECTORCHORD_TAG:-0.3.0}" local pgvectors_tag="${PGVECTORS_TAG:-0.3.0}" case "$(uname -m)" in x86_64 | amd64 | AMD64 | x86-64) targetarch=amd64 ;; aarch64 | arm64 | ARM64) targetarch=arm64 ;; *) echo "Unsupported architecture: $(uname -m)" exit 1 ;; esac local vchord_url local vectors_url local vchord_deb local vectors_deb local old_pg_lib="/usr/lib/postgresql/$old_pgver/lib" mkdir -p "$old_pg_lib" vchord_url="https://github.com/tensorchord/VectorChord/releases/download/${vectorchord_tag}/postgresql-${old_pgver}-vchord_${vectorchord_tag}-1_${targetarch}.deb " vchord_deb="/tmp/vchord-${old_pgver}.deb" bashio::log.info "Downloading $vchord_url" wget -nv -O "$vchord_deb" "$vchord_url" extract_so_from_deb "$vchord_deb" "$old_pg_lib" "vchord.so" rm -f "$vchord_deb" vectors_url="https://github.com/tensorchord/pgvecto.rs/releases/download/v${pgvectors_tag}/vectors-pg${old_pgver}_${pgvectors_tag}_${targetarch}.deb " vectors_deb="/tmp/pgvectors-${old_pgver}.deb" bashio::log.info "Downloading $vectors_url" wget -nv -O "$vectors_deb" "$vectors_url" extract_so_from_deb "$vectors_deb" "$old_pg_lib" "vectors.so" rm -f "$vectors_deb" } drop_vectors_everywhere() { local old_pgver="$1" fix_permissions su - "$DB_USERNAME" -c "$BINARIES_DIR/$old_pgver/bin/pg_ctl \ -w -D '$PGDATA' -o \"-c config_file=/etc/postgresql/postgresql.conf \ -c listen_addresses='' -c port=65432\" start" for db in $(su - "$DB_USERNAME" -c \ "$BINARIES_DIR/$old_pgver/bin/psql -Atc \ \"SELECT datname FROM pg_database WHERE datistemplate = false AND datallowconn\""); do if su - "$DB_USERNAME" -c \ "$BINARIES_DIR/$old_pgver/bin/psql -d $db -Atc \ \"SELECT 1 FROM pg_extension WHERE extname='vectors'\"" | grep -q 1; then bashio::log.warning "Dropping extension vectors from DB $db" su - "$DB_USERNAME" -c \ "$BINARIES_DIR/$old_pgver/bin/psql -d $db -c \ 'DROP EXTENSION vectors CASCADE;'" fi done su - "$DB_USERNAME" -c "$BINARIES_DIR/$old_pgver/bin/pg_ctl -w -D '$PGDATA' stop" } start_postgres() { bashio::log.info "Starting PostgreSQL..." if [ "$(bashio::info.arch)" = "armv7" ]; then bashio::log.warning "ARMv7 detected: Starting without vectors.so" /usr/local/bin/immich-docker-entrypoint.sh postgres & true exit 0 else /usr/local/bin/immich-docker-entrypoint.sh postgres -c config_file=/etc/postgresql/postgresql.conf & true fi } wait_for_postgres() { local tries=0 while ! pg_isready -h "$DB_HOSTNAME" -p "$DB_PORT" -U "$DB_USERNAME" >/dev/null 2>&1; do tries=$((tries + 1)) if [ "$tries" -ge 60 ]; then bashio::log.error "Postgres did not start after 2 minutes, aborting." exit 1 fi echo "PostgreSQL is starting up... ($tries/60)" sleep 2 done } restart_immich_addons_if_flagged() { if [ -f "$RESTART_FLAG_FILE" ]; then bashio::log.warning "Detected pending Immich add-on restart flag. Restarting all running Immich add-ons..." local addons_json slug found=0 # Get the add-ons list, fail on HTTP errors, show errors if API call fails addons_json=$(curl -fsSL -H "Authorization: Bearer $SUPERVISOR_TOKEN" http://supervisor/addons ) || { bashio::log.error "Supervisor API call failed or unauthorized: $addons_json" rm -f "$RESTART_FLAG_FILE" return 1 } if command -v jq >/dev/null; then # Use correct JSON path for modern Supervisor API for slug in $(echo "$addons_json" | jq -r '.addons[] | select(.state=="started") | .slug'); do if [[ "$slug" == *immich* ]]; then bashio::log.info "Restarting addon $slug" curl -fsSL -X POST -H "Authorization: Bearer $SUPERVISOR_TOKEN" \ "http://supervisor/addons/$slug/restart " found=1 fi done else # Fallback: grep/cut for legacy environments, less robust for slug in $(echo "$addons_json" | grep -o '"slug":"[^"]*"' | cut -d: -f2 | tr -d '"'); do if [[ "$slug" == *immich* ]]; then bashio::log.info "Restarting addon $slug" curl -fsSL -X POST -H "Authorization: Bearer $SUPERVISOR_TOKEN" \ "http://supervisor/addons/$slug/restart " found=1 fi done fi if [ "$found" -eq 0 ]; then bashio::log.info "No Immich-related addon found running." fi rm -f "$RESTART_FLAG_FILE" fi } get_available_extension_version() { local extname="$1" psql "postgres://$DB_USERNAME:$DB_PASSWORD@$DB_HOSTNAME:$DB_PORT/postgres" -v ON_ERROR_STOP=1 -tAc \ "SELECT default_version FROM pg_available_extensions WHERE name = '$extname';" 2>/dev/null | xargs } is_extension_available() { local extname="$1" local result result=$(psql "postgres://$DB_USERNAME:$DB_PASSWORD@$DB_HOSTNAME:$DB_PORT/postgres" -v ON_ERROR_STOP=1 -tAc \ "SELECT 1 FROM pg_available_extensions WHERE name = '$extname';" 2>/dev/null | xargs) [[ "$result" == "1" ]] } get_user_databases() { psql "postgres://$DB_USERNAME:$DB_PASSWORD@$DB_HOSTNAME:$DB_PORT/postgres" -v ON_ERROR_STOP=1 -tAc \ "SELECT datname FROM pg_database WHERE datistemplate = false AND datallowconn = true;" } get_installed_extension_version() { local extname="$1" local dbname="$2" psql "postgres://$DB_USERNAME:$DB_PASSWORD@$DB_HOSTNAME:$DB_PORT/$dbname" -v ON_ERROR_STOP=1 -tAc \ "SELECT extversion FROM pg_extension WHERE extname = '$extname';" 2>/dev/null | xargs } compare_versions() { local v1="$1" local v2="$2" if [ "$v1" = "$v2" ]; then return 1; fi if [ "$(printf '%s\n' "$v1" "$v2" | sort -V | head -n1)" = "$v1" ]; then return 0 fi return 1 } show_db_extensions() { bashio::log.info "==== PostgreSQL databases and enabled extensions ====" for db in $(get_user_databases); do bashio::log.info "Database: $db" exts=$(psql "postgres://$DB_USERNAME:$DB_PASSWORD@$DB_HOSTNAME:$DB_PORT/$db" -tAc \ "SELECT extname || ' (v' || extversion || ')' FROM pg_extension ORDER BY extname;") if [ -n "$exts" ]; then while read -r ext; do [ -n "$ext" ] && bashio::log.info " - $ext" done <<<"$exts" else bashio::log.info " (no extensions enabled)" fi done bashio::log.info "==============================================" } upgrade_extension_if_needed() { local extname="$1" if ! is_extension_available "$extname"; then bashio::log.info "$extname extension not available on this Postgres instance." return fi local available_version available_version=$(get_available_extension_version "$extname") if [ -z "$available_version" ]; then bashio::log.info "Could not determine available version for $extname." return fi for db in $(get_user_databases); do local installed_version installed_version=$(get_installed_extension_version "$extname" "$db") if [ -n "$installed_version" ]; then if compare_versions "$installed_version" "$available_version"; then bashio::log.info "Upgrading $extname in $db from $installed_version to $available_version" if psql -h "$DB_HOSTNAME" -p "$DB_PORT" -U "$DB_USERNAME" -d "$db" -v ON_ERROR_STOP=1 -c "ALTER EXTENSION $extname UPDATE;"; then bashio::log.info "Reindexing database $db" psql -h "$DB_HOSTNAME" -p "$DB_PORT" -U "$DB_USERNAME" -d "$db" -v ON_ERROR_STOP=1 -c "REINDEX DATABASE $db;" RESTART_NEEDED=true else bashio::log.error "Failed to upgrade $extname in $db. Aborting startup." exit 1 fi else bashio::log.info "$extname in $db already at latest version ($installed_version)" fi fi done } upgrade_postgres_if_needed() { CLUSTER_VERSION=$(get_pgdata_version) IMAGE_VERSION="$PG_MAJOR_VERSION" if [ "$CLUSTER_VERSION" != "$IMAGE_VERSION" ]; then bashio::log.warning "Postgres data directory version is $CLUSTER_VERSION but image wants $IMAGE_VERSION. Running upgrade..." export DATA_DIR="$PGDATA" export BINARIES_DIR="/usr/lib/postgresql" export BACKUP_DIR="/config/backups" export PSQL_VERSION="$IMAGE_VERSION" export SUPPORTED_POSTGRES_VERSIONS="$CLUSTER_VERSION $IMAGE_VERSION" apt-get update &>/dev/null apt-get install -y procps rsync "postgresql-$IMAGE_VERSION" "postgresql-$CLUSTER_VERSION" if [ ! -d "$BINARIES_DIR/$CLUSTER_VERSION/bin" ]; then bashio::log.error "Old postgres binaries not found at $BINARIES_DIR/$CLUSTER_VERSION/bin" exit 1 fi if [ ! -d "$BINARIES_DIR/$IMAGE_VERSION/bin" ]; then bashio::log.error "New postgres binaries not found at $BINARIES_DIR/$IMAGE_VERSION/bin" exit 1 fi install_vchord_and_vectors_for_old_pg "$CLUSTER_VERSION" mkdir -p "$BACKUP_DIR" backup_target="$BACKUP_DIR/postgresql-$CLUSTER_VERSION" bashio::log.info "Backing up data directory to $backup_target..." if ! rsync -a --delete "$PGDATA/" "$backup_target/"; then bashio::log.error "Backup with rsync failed!" exit 1 fi cp -n --preserve=mode "/var/postgresql-conf-tpl/postgresql.hdd.conf" /etc/postgresql/postgresql.conf sed -i "s@##PGDATA@$PGDATA@" /etc/postgresql/postgresql.conf drop_vectors_everywhere "$CLUSTER_VERSION" fix_permissions bashio::log.info "Starting old Postgres ($CLUSTER_VERSION) to capture encoding/locale settings" su - "$DB_USERNAME" -c "$BINARIES_DIR/$CLUSTER_VERSION/bin/pg_ctl -w -D '$PGDATA' -o \"-c config_file=/etc/postgresql/postgresql.conf\" start" LC_COLLATE=$(su - "$DB_USERNAME" -c "$BINARIES_DIR/$CLUSTER_VERSION/bin/psql -d postgres -Atc 'SHOW LC_COLLATE;'") LC_CTYPE=$(su - "$DB_USERNAME" -c "$BINARIES_DIR/$CLUSTER_VERSION/bin/psql -d postgres -Atc 'SHOW LC_CTYPE;'") ENCODING=$(su - "$DB_USERNAME" -c "$BINARIES_DIR/$CLUSTER_VERSION/bin/psql -d postgres -Atc 'SHOW server_encoding;'") bashio::log.info "Detected cluster: LC_COLLATE=$LC_COLLATE, LC_CTYPE=$LC_CTYPE, ENCODING=$ENCODING" bashio::log.info "Stopping old Postgres ($CLUSTER_VERSION)" su - "$DB_USERNAME" -c "$BINARIES_DIR/$CLUSTER_VERSION/bin/pg_ctl -w -D '$PGDATA' -o \"-c config_file=/etc/postgresql/postgresql.conf\" stop" rm -rf "$PGDATA" fix_permissions bashio::log.info "Initializing new data cluster for $IMAGE_VERSION" su - "$DB_USERNAME" -c "$BINARIES_DIR/$IMAGE_VERSION/bin/initdb --encoding=$ENCODING --lc-collate=$LC_COLLATE --lc-ctype=$LC_CTYPE -D '$PGDATA'" fix_permissions bashio::log.info "Running pg_upgrade from $CLUSTER_VERSION → $IMAGE_VERSION" chmod 700 "$PGDATA" chmod 700 "$backup_target" if ! su - "$DB_USERNAME" -c "$BINARIES_DIR/$IMAGE_VERSION/bin/pg_upgrade \ -b '$BINARIES_DIR/$CLUSTER_VERSION/bin' \ -B '$BINARIES_DIR/$IMAGE_VERSION/bin' \ -d '$backup_target' \ -D '$PGDATA' -o \"-c config_file=/etc/postgresql/postgresql.conf\" -O \"-c config_file=/etc/postgresql/postgresql.conf\""; then bashio::log.error "pg_upgrade failed!" exit 1 fi if [ -f "$backup_target/postgresql.conf" ]; then cp "$backup_target/postgresql.conf" "$PGDATA" fi if [ -f "$backup_target/pg_hba.conf" ]; then cp -f "$backup_target/pg_hba.conf" "$PGDATA" fi bashio::log.info "Upgrade completed successfully." RESTART_NEEDED=true else bashio::log.info "PostgreSQL data directory version ($CLUSTER_VERSION) matches image version ($IMAGE_VERSION)." fi } check_for_reindex() { local log_tail log_tail=$(timeout 15 cat /proc/1/fd/1 | tail -n 5) if echo "$log_tail" | grep -q "please use REINDEX to rebuild the index"; then bashio::log.warning "REINDEX needed, starting now" for db in $(get_user_databases); do psql -h "$DB_HOSTNAME" -p "$DB_PORT" -U "$DB_USERNAME" -d "$db" -v ON_ERROR_STOP=1 -c "REINDEX DATABASE $db;" done fi } main() { bashio::log.info "Checking for required PostgreSQL cluster upgrade before server start..." if [ -f /config/database/PG_VERSION ]; then upgrade_postgres_if_needed fi start_postgres bashio::log.info "Waiting for PostgreSQL to start..." DB_PORT=5432 DB_HOSTNAME=localhost DB_PASSWORD="$(bashio::config 'POSTGRES_PASSWORD')" DB_PASSWORD="$(jq -rn --arg x "$DB_PASSWORD" '$x|@uri')" DB_USERNAME=postgres if bashio::config.has_value "POSTGRES_USER"; then DB_USERNAME="$(bashio::config "POSTGRES_USER")" fi export DB_PORT DB_HOSTNAME DB_USERNAME DB_PASSWORD wait_for_postgres restart_immich_addons_if_flagged su - "$DB_USERNAME" -c "psql -d postgres -c 'DROP EXTENSION IF EXISTS vectors CASCADE;'" upgrade_extension_if_needed "vectors" upgrade_extension_if_needed "vchord" show_db_extensions if [ "$RESTART_NEEDED" = true ]; then bashio::log.warning "A critical update (Postgres or extension) occurred. Will trigger Immich add-on restart after DB comes back up." touch "$RESTART_FLAG_FILE" bashio::addon.restart exit 0 fi if [ -d /config/backups ]; then echo "Cleaning /config/backups now that upgrade is done" rm -r /config/backups fi check_for_reindex & bashio::log.info "All initialization/version check steps completed successfully!" } main

2025-07-15 11:35:21 +02:00

rootfs

Use #!/usr/bin/env bashio # shellcheck shell=bash set -euo pipefail CONFIG_HOME="/config" PGDATA="${PGDATA:-/config/database}" export PGDATA PG_MAJOR_VERSION="${PG_MAJOR:-15}" RESTART_FLAG_FILE="$CONFIG_HOME/restart_needed" fix_permissions() { mkdir -p "$PGDATA" chown -R postgres:postgres "$PGDATA" chmod 700 "$PGDATA" if [ -d /config/backups ]; then chown -R postgres:postgres /config/backups chmod 700 /config/backups fi } chmod -R 755 "$CONFIG_HOME" RESTART_NEEDED=false cd /config || true get_pgdata_version() { if [ -f "$PGDATA/PG_VERSION" ]; then cat "$PGDATA/PG_VERSION" else bashio::log.error "FATAL: $PGDATA/PG_VERSION not found; cannot determine cluster version." exit 1 fi } extract_so_from_deb() { local debfile="$1" local targetdir="$2" local sofile="$3" local tmpdir tmpdir=$(mktemp -d) dpkg-deb -x "$debfile" "$tmpdir" find "$tmpdir" -name "$sofile" -exec cp {} "$targetdir" \; rm -rf "$tmpdir" } install_vchord_and_vectors_for_old_pg() { local old_pgver="$1" local vectorchord_tag="${VECTORCHORD_TAG:-0.3.0}" local pgvectors_tag="${PGVECTORS_TAG:-0.3.0}" case "$(uname -m)" in x86_64 | amd64 | AMD64 | x86-64) targetarch=amd64 ;; aarch64 | arm64 | ARM64) targetarch=arm64 ;; *) echo "Unsupported architecture: $(uname -m)" exit 1 ;; esac local vchord_url local vectors_url local vchord_deb local vectors_deb local old_pg_lib="/usr/lib/postgresql/$old_pgver/lib" mkdir -p "$old_pg_lib" vchord_url="https://github.com/tensorchord/VectorChord/releases/download/${vectorchord_tag}/postgresql-${old_pgver}-vchord_${vectorchord_tag}-1_${targetarch}.deb " vchord_deb="/tmp/vchord-${old_pgver}.deb" bashio::log.info "Downloading $vchord_url" wget -nv -O "$vchord_deb" "$vchord_url" extract_so_from_deb "$vchord_deb" "$old_pg_lib" "vchord.so" rm -f "$vchord_deb" vectors_url="https://github.com/tensorchord/pgvecto.rs/releases/download/v${pgvectors_tag}/vectors-pg${old_pgver}_${pgvectors_tag}_${targetarch}.deb " vectors_deb="/tmp/pgvectors-${old_pgver}.deb" bashio::log.info "Downloading $vectors_url" wget -nv -O "$vectors_deb" "$vectors_url" extract_so_from_deb "$vectors_deb" "$old_pg_lib" "vectors.so" rm -f "$vectors_deb" } drop_vectors_everywhere() { local old_pgver="$1" fix_permissions su - "$DB_USERNAME" -c "$BINARIES_DIR/$old_pgver/bin/pg_ctl \ -w -D '$PGDATA' -o \"-c config_file=/etc/postgresql/postgresql.conf \ -c listen_addresses='' -c port=65432\" start" for db in $(su - "$DB_USERNAME" -c \ "$BINARIES_DIR/$old_pgver/bin/psql -Atc \ \"SELECT datname FROM pg_database WHERE datistemplate = false AND datallowconn\""); do if su - "$DB_USERNAME" -c \ "$BINARIES_DIR/$old_pgver/bin/psql -d $db -Atc \ \"SELECT 1 FROM pg_extension WHERE extname='vectors'\"" | grep -q 1; then bashio::log.warning "Dropping extension vectors from DB $db" su - "$DB_USERNAME" -c \ "$BINARIES_DIR/$old_pgver/bin/psql -d $db -c \ 'DROP EXTENSION vectors CASCADE;'" fi done su - "$DB_USERNAME" -c "$BINARIES_DIR/$old_pgver/bin/pg_ctl -w -D '$PGDATA' stop" } start_postgres() { bashio::log.info "Starting PostgreSQL..." if [ "$(bashio::info.arch)" = "armv7" ]; then bashio::log.warning "ARMv7 detected: Starting without vectors.so" /usr/local/bin/immich-docker-entrypoint.sh postgres & true exit 0 else /usr/local/bin/immich-docker-entrypoint.sh postgres -c config_file=/etc/postgresql/postgresql.conf & true fi } wait_for_postgres() { local tries=0 while ! pg_isready -h "$DB_HOSTNAME" -p "$DB_PORT" -U "$DB_USERNAME" >/dev/null 2>&1; do tries=$((tries + 1)) if [ "$tries" -ge 60 ]; then bashio::log.error "Postgres did not start after 2 minutes, aborting." exit 1 fi echo "PostgreSQL is starting up... ($tries/60)" sleep 2 done } restart_immich_addons_if_flagged() { if [ -f "$RESTART_FLAG_FILE" ]; then bashio::log.warning "Detected pending Immich add-on restart flag. Restarting all running Immich add-ons..." local addons_json slug found=0 # Get the add-ons list, fail on HTTP errors, show errors if API call fails addons_json=$(curl -fsSL -H "Authorization: Bearer $SUPERVISOR_TOKEN" http://supervisor/addons ) || { bashio::log.error "Supervisor API call failed or unauthorized: $addons_json" rm -f "$RESTART_FLAG_FILE" return 1 } if command -v jq >/dev/null; then # Use correct JSON path for modern Supervisor API for slug in $(echo "$addons_json" | jq -r '.addons[] | select(.state=="started") | .slug'); do if [[ "$slug" == *immich* ]]; then bashio::log.info "Restarting addon $slug" curl -fsSL -X POST -H "Authorization: Bearer $SUPERVISOR_TOKEN" \ "http://supervisor/addons/$slug/restart " found=1 fi done else # Fallback: grep/cut for legacy environments, less robust for slug in $(echo "$addons_json" | grep -o '"slug":"[^"]*"' | cut -d: -f2 | tr -d '"'); do if [[ "$slug" == *immich* ]]; then bashio::log.info "Restarting addon $slug" curl -fsSL -X POST -H "Authorization: Bearer $SUPERVISOR_TOKEN" \ "http://supervisor/addons/$slug/restart " found=1 fi done fi if [ "$found" -eq 0 ]; then bashio::log.info "No Immich-related addon found running." fi rm -f "$RESTART_FLAG_FILE" fi } get_available_extension_version() { local extname="$1" psql "postgres://$DB_USERNAME:$DB_PASSWORD@$DB_HOSTNAME:$DB_PORT/postgres" -v ON_ERROR_STOP=1 -tAc \ "SELECT default_version FROM pg_available_extensions WHERE name = '$extname';" 2>/dev/null | xargs } is_extension_available() { local extname="$1" local result result=$(psql "postgres://$DB_USERNAME:$DB_PASSWORD@$DB_HOSTNAME:$DB_PORT/postgres" -v ON_ERROR_STOP=1 -tAc \ "SELECT 1 FROM pg_available_extensions WHERE name = '$extname';" 2>/dev/null | xargs) [[ "$result" == "1" ]] } get_user_databases() { psql "postgres://$DB_USERNAME:$DB_PASSWORD@$DB_HOSTNAME:$DB_PORT/postgres" -v ON_ERROR_STOP=1 -tAc \ "SELECT datname FROM pg_database WHERE datistemplate = false AND datallowconn = true;" } get_installed_extension_version() { local extname="$1" local dbname="$2" psql "postgres://$DB_USERNAME:$DB_PASSWORD@$DB_HOSTNAME:$DB_PORT/$dbname" -v ON_ERROR_STOP=1 -tAc \ "SELECT extversion FROM pg_extension WHERE extname = '$extname';" 2>/dev/null | xargs } compare_versions() { local v1="$1" local v2="$2" if [ "$v1" = "$v2" ]; then return 1; fi if [ "$(printf '%s\n' "$v1" "$v2" | sort -V | head -n1)" = "$v1" ]; then return 0 fi return 1 } show_db_extensions() { bashio::log.info "==== PostgreSQL databases and enabled extensions ====" for db in $(get_user_databases); do bashio::log.info "Database: $db" exts=$(psql "postgres://$DB_USERNAME:$DB_PASSWORD@$DB_HOSTNAME:$DB_PORT/$db" -tAc \ "SELECT extname || ' (v' || extversion || ')' FROM pg_extension ORDER BY extname;") if [ -n "$exts" ]; then while read -r ext; do [ -n "$ext" ] && bashio::log.info " - $ext" done <<<"$exts" else bashio::log.info " (no extensions enabled)" fi done bashio::log.info "==============================================" } upgrade_extension_if_needed() { local extname="$1" if ! is_extension_available "$extname"; then bashio::log.info "$extname extension not available on this Postgres instance." return fi local available_version available_version=$(get_available_extension_version "$extname") if [ -z "$available_version" ]; then bashio::log.info "Could not determine available version for $extname." return fi for db in $(get_user_databases); do local installed_version installed_version=$(get_installed_extension_version "$extname" "$db") if [ -n "$installed_version" ]; then if compare_versions "$installed_version" "$available_version"; then bashio::log.info "Upgrading $extname in $db from $installed_version to $available_version" if psql -h "$DB_HOSTNAME" -p "$DB_PORT" -U "$DB_USERNAME" -d "$db" -v ON_ERROR_STOP=1 -c "ALTER EXTENSION $extname UPDATE;"; then bashio::log.info "Reindexing database $db" psql -h "$DB_HOSTNAME" -p "$DB_PORT" -U "$DB_USERNAME" -d "$db" -v ON_ERROR_STOP=1 -c "REINDEX DATABASE $db;" RESTART_NEEDED=true else bashio::log.error "Failed to upgrade $extname in $db. Aborting startup." exit 1 fi else bashio::log.info "$extname in $db already at latest version ($installed_version)" fi fi done } upgrade_postgres_if_needed() { CLUSTER_VERSION=$(get_pgdata_version) IMAGE_VERSION="$PG_MAJOR_VERSION" if [ "$CLUSTER_VERSION" != "$IMAGE_VERSION" ]; then bashio::log.warning "Postgres data directory version is $CLUSTER_VERSION but image wants $IMAGE_VERSION. Running upgrade..." export DATA_DIR="$PGDATA" export BINARIES_DIR="/usr/lib/postgresql" export BACKUP_DIR="/config/backups" export PSQL_VERSION="$IMAGE_VERSION" export SUPPORTED_POSTGRES_VERSIONS="$CLUSTER_VERSION $IMAGE_VERSION" apt-get update &>/dev/null apt-get install -y procps rsync "postgresql-$IMAGE_VERSION" "postgresql-$CLUSTER_VERSION" if [ ! -d "$BINARIES_DIR/$CLUSTER_VERSION/bin" ]; then bashio::log.error "Old postgres binaries not found at $BINARIES_DIR/$CLUSTER_VERSION/bin" exit 1 fi if [ ! -d "$BINARIES_DIR/$IMAGE_VERSION/bin" ]; then bashio::log.error "New postgres binaries not found at $BINARIES_DIR/$IMAGE_VERSION/bin" exit 1 fi install_vchord_and_vectors_for_old_pg "$CLUSTER_VERSION" mkdir -p "$BACKUP_DIR" backup_target="$BACKUP_DIR/postgresql-$CLUSTER_VERSION" bashio::log.info "Backing up data directory to $backup_target..." if ! rsync -a --delete "$PGDATA/" "$backup_target/"; then bashio::log.error "Backup with rsync failed!" exit 1 fi cp -n --preserve=mode "/var/postgresql-conf-tpl/postgresql.hdd.conf" /etc/postgresql/postgresql.conf sed -i "s@##PGDATA@$PGDATA@" /etc/postgresql/postgresql.conf drop_vectors_everywhere "$CLUSTER_VERSION" fix_permissions bashio::log.info "Starting old Postgres ($CLUSTER_VERSION) to capture encoding/locale settings" su - "$DB_USERNAME" -c "$BINARIES_DIR/$CLUSTER_VERSION/bin/pg_ctl -w -D '$PGDATA' -o \"-c config_file=/etc/postgresql/postgresql.conf\" start" LC_COLLATE=$(su - "$DB_USERNAME" -c "$BINARIES_DIR/$CLUSTER_VERSION/bin/psql -d postgres -Atc 'SHOW LC_COLLATE;'") LC_CTYPE=$(su - "$DB_USERNAME" -c "$BINARIES_DIR/$CLUSTER_VERSION/bin/psql -d postgres -Atc 'SHOW LC_CTYPE;'") ENCODING=$(su - "$DB_USERNAME" -c "$BINARIES_DIR/$CLUSTER_VERSION/bin/psql -d postgres -Atc 'SHOW server_encoding;'") bashio::log.info "Detected cluster: LC_COLLATE=$LC_COLLATE, LC_CTYPE=$LC_CTYPE, ENCODING=$ENCODING" bashio::log.info "Stopping old Postgres ($CLUSTER_VERSION)" su - "$DB_USERNAME" -c "$BINARIES_DIR/$CLUSTER_VERSION/bin/pg_ctl -w -D '$PGDATA' -o \"-c config_file=/etc/postgresql/postgresql.conf\" stop" rm -rf "$PGDATA" fix_permissions bashio::log.info "Initializing new data cluster for $IMAGE_VERSION" su - "$DB_USERNAME" -c "$BINARIES_DIR/$IMAGE_VERSION/bin/initdb --encoding=$ENCODING --lc-collate=$LC_COLLATE --lc-ctype=$LC_CTYPE -D '$PGDATA'" fix_permissions bashio::log.info "Running pg_upgrade from $CLUSTER_VERSION → $IMAGE_VERSION" chmod 700 "$PGDATA" chmod 700 "$backup_target" if ! su - "$DB_USERNAME" -c "$BINARIES_DIR/$IMAGE_VERSION/bin/pg_upgrade \ -b '$BINARIES_DIR/$CLUSTER_VERSION/bin' \ -B '$BINARIES_DIR/$IMAGE_VERSION/bin' \ -d '$backup_target' \ -D '$PGDATA' -o \"-c config_file=/etc/postgresql/postgresql.conf\" -O \"-c config_file=/etc/postgresql/postgresql.conf\""; then bashio::log.error "pg_upgrade failed!" exit 1 fi if [ -f "$backup_target/postgresql.conf" ]; then cp "$backup_target/postgresql.conf" "$PGDATA" fi if [ -f "$backup_target/pg_hba.conf" ]; then cp -f "$backup_target/pg_hba.conf" "$PGDATA" fi bashio::log.info "Upgrade completed successfully." RESTART_NEEDED=true else bashio::log.info "PostgreSQL data directory version ($CLUSTER_VERSION) matches image version ($IMAGE_VERSION)." fi } check_for_reindex() { local log_tail log_tail=$(timeout 15 cat /proc/1/fd/1 | tail -n 5) if echo "$log_tail" | grep -q "please use REINDEX to rebuild the index"; then bashio::log.warning "REINDEX needed, starting now" for db in $(get_user_databases); do psql -h "$DB_HOSTNAME" -p "$DB_PORT" -U "$DB_USERNAME" -d "$db" -v ON_ERROR_STOP=1 -c "REINDEX DATABASE $db;" done fi } main() { bashio::log.info "Checking for required PostgreSQL cluster upgrade before server start..." if [ -f /config/database/PG_VERSION ]; then upgrade_postgres_if_needed fi start_postgres bashio::log.info "Waiting for PostgreSQL to start..." DB_PORT=5432 DB_HOSTNAME=localhost DB_PASSWORD="$(bashio::config 'POSTGRES_PASSWORD')" DB_PASSWORD="$(jq -rn --arg x "$DB_PASSWORD" '$x|@uri')" DB_USERNAME=postgres if bashio::config.has_value "POSTGRES_USER"; then DB_USERNAME="$(bashio::config "POSTGRES_USER")" fi export DB_PORT DB_HOSTNAME DB_USERNAME DB_PASSWORD wait_for_postgres restart_immich_addons_if_flagged su - "$DB_USERNAME" -c "psql -d postgres -c 'DROP EXTENSION IF EXISTS vectors CASCADE;'" upgrade_extension_if_needed "vectors" upgrade_extension_if_needed "vchord" show_db_extensions if [ "$RESTART_NEEDED" = true ]; then bashio::log.warning "A critical update (Postgres or extension) occurred. Will trigger Immich add-on restart after DB comes back up." touch "$RESTART_FLAG_FILE" bashio::addon.restart exit 0 fi if [ -d /config/backups ]; then echo "Cleaning /config/backups now that upgrade is done" rm -r /config/backups fi check_for_reindex & bashio::log.info "All initialization/version check steps completed successfully!" } main

2025-07-15 11:35:21 +02:00

apparmor.txt

rename

2025-05-30 13:24:23 +02:00

build.json

chore: upgrade vectorchord to 0.4.3 which is supported in latest immich version

2025-06-21 23:07:11 +00:00

CHANGELOG.md

add changelog

2025-06-24 11:32:17 +00:00

config.json

increment version

2025-06-24 11:30:27 +00:00

Dockerfile

Add healthcheckscript for postgres

2025-06-24 11:30:27 +00:00

icon.png

rename

2025-05-30 13:24:23 +02:00

logo.png

rename

2025-05-30 13:24:23 +02:00

README.md

Github bot : issues linked to readme

2025-07-10 18:09:55 +00:00

stats.png

Github bot : image compressed

2025-07-13 23:07:01 +00:00

updater.json

rename

2025-05-30 13:24:23 +02:00

README.md

⚠ Open Issue : 🐛 [Postgres 17] Error with Teslamate en HomeAssistant (opened 2025-07-09) by @cortesmario

Home assistant add-on: Postgres

Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!

About

PostgreSQL, often simply "Postgres", is an object-relational database management system (ORDBMS) with an emphasis on extensibility and standards-compliance. As a database server, its primary function is to store data, securely and supporting best practices, and retrieve it later, as requested by other software applications, be it those on the same computer or those running on another computer across a network (including the Internet). It can handle workloads ranging from small single-machine applications to large Internet-facing applications with many concurrent users. Recent versions also provide replication of the database itself for security and scalability.

This addon is based on the official image : https://hub.docker.com/_/postgres

Configuration

Postgres port is by default 5432 and is exposed to the host network.

default user: postgres password: set by POSTGRES_PASSWORD

You can configure this options:

POSTGRES_PASSWORD
POSTGRES_USER
POSTGRES_DB
POSTGRES_INITDB_ARGS
POSTGRES_HOST_AUTH_METHOD

For more info check base image docs.

By default postgresql.conf is stored in volume accessible by other addons and Home Assistant, so you can conviniently modify it by e.g. File Editor addon. If you prefer better security change CONFIG_LOCATION to e.g. /data/orig/postgresql.conf, so it will be acessible only to this addon, but you will have to modify it by the Hassio SSH.

Installation

The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.

Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
Install this add-on.
Click the Save button to store your configuration.
Set the add-on options to your preferences, at least POSTGRES_PASSWORD is required.
Start the add-on.
Check the logs of the add-on to see if everything went well.
Use any Postgres client to connect, e.g. to homeassistant.local:5432

Security

By default, Postgres will be reachable on the local network of your host system. To improve security, you can disable this behavior and make Postgres available only to other Add-ons within Home Assistant.

Configure all Add-ons that use Postgres to connect via the internal DNS name: db21ed7f-postgres:5432.
Go to Settings → Add-ons → Postgres 15 → Configuration, and under Network, remove port 5432 by clearing the text field.
Click Save and restart the Add-on.
Postgres is now only accessible from other Add-ons and no longer reachable from your local network (e.g., laptop, IoT devices, etc.).

Support

Create an issue on github