Installation script overview

The script performs environment validation, installs the required services, deploys applications, and initializes the system for first use. On Linux, the script adapts its deployment method based on the configured environment type, such as native, Docker, or Podman.

The script completes the following major steps:

1. Validate prerequisites

   The script ensures that you run the command from the correct directory under the installation root:

   • On Windows: You must run the script from the DesignServer directory under the IBM Sterling Transformation Extender installation root and have administrator privileges. If you do not meet these conditions, the script stops and returns an error.
   • On Linux: You must run the command from the correct directory under the installation root and have appropriate permissions. Root privileges are required if you use default ports below 1024; non-root users must configure ports above 1024 to avoid permission issues. If you do not meet these conditions, the script stops and returns an error.

2. Initialize and verify the environment

   The script initializes the runtime environment by loading environment settings from the installation. It verifies that the configuration file (config.yaml) is valid and confirms that required binaries, such as flowcmdserver.exe, are functional.

3. Load configuration settings

   The script reads configuration values from the config.yaml configuration file, including the following settings:

   • Service names for Apache Tomcat, the client user interface, and Redis
   • Network ports and hostnames
   • File storage and persistence directories
   • Redis and MongoDB settings
   • User interface access configuration

4. Prepare application files

   The script extracts the server application archive as needed, prepares the required utility libraries, and determines and appends version information to service names.

5. Clean existing installations

   If the script detects a previous installation, it runs a cleanup process to remove the existing deployment. If the cleanup process fails, the installation stops to prevent conflicts.

6. Validate port availability

   Before installing the user interface, the script checks whether the configured user interface port is already in use. If the port is occupied, the script displays the conflicting process and stops.

7. Validate database availability

   For Design Server installations, the script verifies that the MongoDB database is running and accessible. If MongoDB is not available, the installation stops and provides instructions to start the database.

8. Configure and start Redis

   The script generates a Redis configuration file based on the settings, creates required directories for Redis persistence, and checks whether Redis is already running. If Redis is enabled but not running, the script completes the following actions:

   • On Windows: It installs Redis as a Windows service, starts the service, and verifies that the service is accessible.
   • On Linux: It installs Redis as a background service or daemon, starts the service, and verifies that the service is accessible.

9. Install and configure Apache Tomcat

   The script installs Apache Tomcat as a service or daemon (Windows service on Windows, or background service/daemon on Linux). It updates the Apache Tomcat configuration from the settings, configures service dependencies (such as ensuring that Apache Tomcat depends on Redis), and prepares logging and runtime directories.

10. Install the web user interface

    For Design Server installations, the script builds the user interface using Node.js tooling, installs the user interface as a service or daemon (Windows service on Windows, or background service/daemon on Linux), and starts and verifies the service. The user interface is made available at the configured host and port.

11. Deploy the server application

    The script deploys the server application by copying the application .war file into the Apache Tomcat web applications directory, installing required supporting libraries, and creating required working directories and file storage locations.

12. Start and verify services

    The script starts the Apache Tomcat service, waits for the configured startup timeout, and verifies that the server operates correctly. If the server does not start successfully, the installation fails.

13. Initialize application data

    For Design Server installations, the script performs the initial setup by completing the following tasks:

    • Create a default account
    • Import a sample project (such as "Process Orders")
    • Remove any previously installed adapters
    • Generate an administrator password
    • Create an initial administrator user
    • Configure a default runtime server over HTTPS (optional).
      The generated administrator password is stored in a file for later use.

14. Complete the installation

    When all steps complete successfully, the script marks the installation as complete, creates a success indicator file, and prepares the system for use. You can then start or manage the application using the provided scripts, such as start.bat on Windows or ./ITX start on Linux.