Installation & Deployment

# Authenticate with the registry
docker login hub.friendly-tech.com

# Pull the latest image (optional -- "docker run" / "docker compose up"
# will pull it automatically on first use)
docker pull hub.friendly-tech.com/emulator/iot:latest

docker pull hub.friendly-tech.com/emulator/iot:<version>

# Build the application JAR (Java 25 + Maven)
mvn clean package -DskipTests

# Build the Docker image (uses the Dockerfile in the repository root)
docker build -t iot-emulator:latest .

docker images | grep iot

mkdir -p /usr/local/ft-system/iot-emulator/logs
cd /usr/local/ft-system

docker create --name tmp-emulator hub.friendly-tech.com/emulator/iot:latest
docker cp tmp-emulator:/app/configuration ./iot-emulator/configuration
docker rm tmp-emulator

/usr/local/ft-system/
├── compose.yml               # from FT_DISK -- iot-emulator (or the FT System <vendor> Stack)
└── iot-emulator/
    ├── .env                  # per-service environment, from FT_DISK
    ├── configuration/        # -> /app/configuration
    └── logs/                 # -> /app/logs

name: ft-iot-emulator

services:
  iot-emulator:
    image: hub.friendly-tech.com/emulator/iot:latest
    container_name: iot-emulator
    env_file:
      - ./iot-emulator/.env
    ports:
      # Host port is literal on purpose. The emulator does not read it, and
      # Compose interpolates ${...} only from the shell environment and from a
      # .env in this directory -- never from the env_file above.
      - "8556:8556"
    volumes:
      # The mounted directory REPLACES the built-in one, so it must contain
      # every required file. Populate it from the image before the first start.
      - ./iot-emulator/configuration:/app/configuration
      - ./iot-emulator/logs:/app/logs
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8556/api/status"]
      interval: 30s
      timeout: 3s
      start_period: 30s
      retries: 3
    restart: unless-stopped

# ==========================================================
# IoT Emulator - per-service environment
# ==========================================================
# The only environment file this deployment uses. The emulator has no shared
# infrastructure of its own, so there is no root .env layer.
#
# The published host port is NOT here: it is a compose concern, not an
# application setting, and Compose does not interpolate env_file values anyway.
# Change it in compose.yml.

# HTTP port the emulator listens on inside the container
SERVER_PORT=8556

# Active Spring profile
SPRING_PROFILES_ACTIVE=prod

# Container timezone
TZ=UTC

# JVM options. Raise the heap for large device counts.
JAVA_OPTS=-Xms512m -Xmx1g -XX:+UseG1GC -XX:+UseStringDeduplication -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/app/logs/heapdump.hprof

# Auto-prepended by the launcher; opens sun.security.ssl for reflective TLS
# code paths. Normally leave as-is.
JDK_JAVA_OPTIONS=--add-opens=java.base/sun.security.ssl=ALL-UNNAMED

# USP MQTTv5 MTP TLS mode: 1 = mutual auth, 0 = server auth only
FT_TLS_AUTH=1

# Application log file inside the container
LOG_FILE=/app/logs/iot-emulator.log

# Headless mode only: override the target server at startup. Each is applied
# independently -- either can be set alone.
# SERVER_IP=
# SERVER_TARGET_PORT=

docker compose up -d
docker compose logs -f iot-emulator

# From the directory where you want ./configuration to live
./run-docker.sh

docker run -d \
  --name iot-emulator \
  -p 8556:8556 \
  --restart unless-stopped \
  hub.friendly-tech.com/emulator/iot:latest

docker run -d \
  --name iot-emulator \
  -p 8556:8556 \
  --env-file ./iot-emulator/.env \
  -v "$(pwd)/iot-emulator/configuration:/app/configuration" \
  --restart unless-stopped \
  hub.friendly-tech.com/emulator/iot:latest

docker run -d \
  --name iot-emulator \
  -p 8556:8556 \
  -e FT_TLS_AUTH=0 \
  hub.friendly-tech.com/emulator/iot:latest

FT_TLS_AUTH=0 ./run.sh
# or
java -Dft.tls.auth=0 -jar gui/target/iot-emulator.jar --web-mode

docker run -d \
  --name iot-emulator \
  -p 8556:8556 \
  -e JAVA_OPTS="-Xms512m -Xmx1g -XX:+UseG1GC -Dusp.diagnostics.ooklaDurationMs=30000 -Dusp.diagnostics.errorRate=0.2" \
  hub.friendly-tech.com/emulator/iot:latest

java -Dusp.diagnostics.ooklaDurationMs=30000 -Dusp.diagnostics.errorRate=0.2 -jar gui/target/iot-emulator.jar --web-mode

java -Dft.rules.java=1 -jar gui/target/iot-emulator.jar --web-mode

<?xml version="1.0" encoding="UTF-8"?>
<resources>
    <resource>
        <path>Device.DeviceInfo.Manufacturer</path>
        <value>MyCompany</value>
        <type>string</type>
        <writable>false</writable>
    </resource>
    <!-- More resources... -->
</resources>

java -jar gui/target/iot-emulator.jar --web-mode

# Linux / macOS
./run.sh

# Windows
run.bat

# (Optional) back up your configuration first
tar -czf emulator-config-$(date +%Y%m%d).tar.gz configuration/

./run-docker.sh

IMAGE=hub.friendly-tech.com/emulator/iot:latest
CONF=./iot-emulator/configuration

# (Optional) back up the directory first
tar -czf emulator-config-$(date +%Y%m%d).tar.gz "$CONF"

STAGE=$(mktemp -d)
docker create --name tmp-emulator "$IMAGE" >/dev/null
docker cp tmp-emulator:/app/configuration/. "$STAGE/"
docker rm tmp-emulator >/dev/null

for f in "$STAGE"/*_gui.properties \
         "$STAGE"/*_resources.xml \
         "$STAGE"/*_controls_names.properties \
         "$STAGE"/profiles.properties \
         "$STAGE"/sensor_info.properties \
         "$STAGE"/metering_plugin_db_connection.properties; do
  [ -f "$f" ] || continue
  cp "$f" "$CONF/"
done
rm -rf "$STAGE"

docker rm -f iot-emulator

# Re-run with the previous image tag
docker run -d \
  --name iot-emulator \
  -p 8556:8556 \
  -v "$(pwd)/configuration:/app/configuration" \
  --restart unless-stopped \
  hub.friendly-tech.com/emulator/iot:<previous-version-tag>