Installation & Deployment

DB_HOST=host.docker.internal
HZ_MEMBERS=host.docker.internal:5701
ACS_WEB_SERVICE_HOST=host.docker.internal
CLICKHOUSE_HOST=host.docker.internal

extra_hosts:
  - "host.docker.internal:host-gateway"

docker images hub.friendly-tech.com/ui/backend

mkdir -p /usr/local/ft-system/ui-backend/{config,logs}
cd /usr/local/ft-system

env_file:
  - .env                 # shared stack environment
  - ./ui-backend/.env    # per-service environment

SSL_KEYSTORE=${APP_HOME}/conf/ftacs.keystore
SSL_KEYSTORE_PASSWORD=<your-keystore-password>
SSL_KEYSTORE_TYPE=JKS

cd /usr/local/ft-system
set -a; . ./.env; set +a

# Wait for the database (MySQL example; use 1521 for Oracle)
until nc -z ${DB_HOST:-host.docker.internal} 3306; do
  echo "waiting for database..."; sleep 3
done

# Wait for Hazelcast (host taken from HZ_MEMBERS, whose format is host:port)
until nc -z ${HZ_MEMBERS%%:*} 5701; do
  echo "waiting for hazelcast..."; sleep 3
done

# Wait for FTACS
until curl -sf http://${ACS_WEB_SERVICE_HOST:-host.docker.internal}:8080 >/dev/null; do
  echo "waiting for FTACS..."; sleep 3
done

name: ft-ui-backend
# UI Backend on a dedicated host. The Portals are a SEPARATE stack -- see
# compose.portals.yaml.
# DB/Hazelcast/FTACS/ClickHouse are EXTERNAL prerequisites (set in .env).
# Joins the external ft-network so the separately-composed Portals, Keycloak,
# AI Agent and FT Device Network Service reach it by container name.
# Run first: docker network create ft-network
services:
  ui-backend:
    image: hub.friendly-tech.com/ui/backend:latest   # <-- pin a released tag
    container_name: ui-backend
    ports:
      - "${FT_UI_BACKEND_HTTP_PORT:-8881}:8880"
    env_file:
      - .env
      - ./ui-backend/.env
    environment:
      USE_NOHUP: 0
      APP_HOME: "/opt/app"
      DB_VENDOR: "${DB_PROFILE}"
      SPRING_PROFILES_ACTIVE: "${DB_PROFILE}"
      DB_HOST: "${DB_HOST}"
      DB_PASSWORD: "${DB_PASSWORD:-ftacs}"
      MYSQL_PORT: "${DB_PORT:-3306}"
      MYSQL_USER: "${DB_USER:-ftacs}"
      ORACLE_PORT: "${DB_PORT:-1521}"
      ORACLE_SERVICE: "${DB_SERVICE:-XEPDB1}"
      ORACLE_USER_FTACS: "${DB_USER:-ftacs}"
      ORACLE_USER_IOTW: "${ORACLE_USER_IOTW:-iotw}"
      ACS_WEB_SERVICE_USER: "${ACS_USERNAME}"
      ACS_WEB_SERVICE_PASSWORD: "${ACS_PASSWORD}"
      CLICKHOUSE_SCHEMA: "${CLICKHOUSE_DATABASE}"
      # The analytics datasource reads CLICKHOUSE_USER / CLICKHOUSE_PASWORD (single S);
      # only Flyway reads CLICKHOUSE_USERNAME / CLICKHOUSE_PASSWORD. Map both.
      CLICKHOUSE_USER: "${CLICKHOUSE_USERNAME}"
      CLICKHOUSE_PASWORD: "${CLICKHOUSE_PASSWORD}"
      JAVA_OPTS: "${FT_UI_BACKEND_JAVA_RAM:--Xms512m -Xmx2g} -Duser.timezone=${TZ}"
    volumes:
      - ${DATA_FOLDER:-.}/ui-backend/config:/opt/app/conf
      - ${DATA_FOLDER:-.}/ui-backend/logs:/opt/app/logs
      # SAML (uncomment when enabled):
      # - ${DATA_FOLDER:-.}/ui-backend/config/sc-idp.crt:/opt/app/conf/sc-idp.crt
      # - ${DATA_FOLDER:-.}/ui-backend/config/mc-idp.crt:/opt/app/conf/mc-idp.crt
    extra_hosts:
      - "host.docker.internal:host-gateway"
    restart: unless-stopped
    healthcheck:
      test: [ "CMD", "wget", "--spider", "-q", "-T", "5", "http://127.0.0.1:8880/iot-webservice/swagger-ui/index.html" ]
      interval: 20s
      timeout: 5s
      retries: 15
      start_period: 60s
    stop_grace_period: 45s
    networks:
      - ft-network

# Shared external network: the Portals, Keycloak and the AI Agent run as separate
# Compose projects and reach this backend by container name only over it.
# Create it once per host before the first start:
#   docker network create ft-network
networks:
  ft-network:
    external: true

docker compose -f compose.ui-backend.yaml ps

NAME         STATUS     PORTS
ui-backend   healthy    0.0.0.0:8881->8880/tcp

docker compose -f compose.ui-backend.yaml logs ui-backend | tail -30

==================================================
    HTTP ports: 8880
    HTTPS ports: 8843
    ACS WS URL: http://<ftacs-host>:8080/ACSServer-ACS/ACSWebService?wsdl
    Swagger UI: /iot-webservice/swagger-ui/index.html
==================================================
INFO ... Started FtIotWebApp in <seconds> seconds (process running for <seconds>)

# Swagger UI (also the container health endpoint)
curl -I http://localhost:8881/iot-webservice/swagger-ui/index.html

# OpenAPI document
curl http://localhost:8881/iot-webservice/v3/api-docs

# Actuator health (exposed endpoints: health, prometheus)
curl http://localhost:8881/actuator/health

# MySQL
docker compose -f compose.ui-backend.yaml exec ui-backend sh -c 'nc -zv "$DB_HOST" 3306'

# Oracle
docker compose -f compose.ui-backend.yaml exec ui-backend sh -c 'nc -zv "$DB_HOST" 1521'

# Hazelcast
docker compose -f compose.ui-backend.yaml exec ui-backend nc -zv <hazelcast-host> 5701

# FTACS SOAP endpoint
curl http://<ftacs-host>:8080

# ClickHouse (optional): 9000 native TCP for queries, 8123 HTTP for Flyway migrations
docker compose -f compose.ui-backend.yaml exec ui-backend nc -zv <clickhouse-host> 9000
docker compose -f compose.ui-backend.yaml exec ui-backend nc -zv <clickhouse-host> 8123

netstat -tlnp | grep 8881

# Container logs
docker compose -f compose.ui-backend.yaml logs -f ui-backend

# On-disk application log
tail -f /usr/local/ft-system/ui-backend/logs/application.log

FT_UI_BACKEND_LOG_LEVEL=debug

docker compose -f compose.ui-backend.yaml up -d ui-backend

docker compose -f compose.ui-backend.yaml stop ui-backend
docker compose -f compose.ui-backend.yaml start ui-backend
docker compose -f compose.ui-backend.yaml restart ui-backend

# Stop (keeps the container, config and logs)
docker compose -f compose.ui-backend.yaml stop ui-backend

# Stop and remove only the UI Backend container
docker compose -f compose.ui-backend.yaml rm -f ui-backend

docker compose -f compose.ui-backend.yaml exec ui-backend bash

# Inspect loaded environment
docker compose -f compose.ui-backend.yaml exec ui-backend env | grep -E 'DB_|HZ_|ACS_|CLICKHOUSE_'

# 1. Back up the config directory
tar -czf ui-backend-config-$(date +%Y%m%d).tar.gz /usr/local/ft-system/ui-backend/config/

# 2. Pull the new tag (registry-connected hosts)
docker compose -f compose.ui-backend.yaml pull ui-backend

# 3. Recreate the container with the new image
docker compose -f compose.ui-backend.yaml up -d ui-backend