> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flowx.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Deployment guidelines v5.4.0

<Info>
  After upgrading to a new platform version, always ensure that your installed component versions match the versions specified in the release notes. To verify this, navigate to **FlowX.AI Designer > Platform Status**.
</Info>

<Frame>
  ![Platform Status screen showing component versions](https://s3.eu-west-1.amazonaws.com/docx.flowx.ai/4.6/platform_status.png)
</Frame>

## Component versions

| Component                  | 5.4.0       | 5.3.0   | 5.2.0   | 5.1.1   | 5.1.0   | 5.0.0  |
| -------------------------- | ----------- | ------- | ------- | ------- | ------- | ------ |
| **process-engine**         | **10.38.0** | 10.29.0 | 10.12.0 | 9.64.3  | 9.63.0  | 9.29.2 |
| **admin**                  | **10.38.0** | 10.26.1 | 10.12.0 | 9.66.5  | 9.65.0  | 9.25.2 |
| **designer**               | **10.59.1** | 10.32.4 | 10.12.1 | 9.159.5 | 9.153.6 | 9.69.0 |
| **cms-core**               | **10.22.0** | 10.16.0 | 10.7.0  | 9.36.3  | 9.35.0  | 9.21.2 |
| **scheduler-core**         | **10.15.0** | 10.11.1 | 10.4.1  | 9.26.1  | 9.25.0  | 9.12.0 |
| **events-gateway**         | **10.17.0** | 10.12.1 | 10.4.1  | 9.26.1  | 9.25.0  | 9.12.0 |
| **notification-plugin**    | **10.22.0** | 10.17.0 | 10.7.0  | 9.29.1  | 9.28.0  | 9.14.2 |
| **document-plugin**        | **10.23.0** | 10.16.0 | 10.6.0  | 9.35.1  | 9.34.0  | 9.17.2 |
| **task-management-plugin** | **10.25.0** | 10.18.0 | 10.7.0  | 9.34.2  | 9.33.0  | 9.14.2 |
| **data-search**            | **10.14.0** | 10.10.1 | 10.4.1  | 9.23.1  | 9.22.0  | 9.12.1 |
| **audit-core**             | **10.21.0** | 10.15.1 | 10.6.0  | 9.30.1  | 9.29.1  | 9.15.2 |
| **advancing-controller**   | **10.16.0** | 10.11.0 | 10.4.1  | 9.25.1  | 9.24.0  | 9.11.0 |
| **integration-designer**   | **10.38.0** | 10.24.0 | 10.8.0  | 9.50.0  | 9.49.1  | 9.26.2 |
| **application-manager**    | **10.37.0** | 10.24.0 | 10.11.0 | 9.73.6  | 9.72.0  | 9.27.3 |
| **runtime-manager**        | **10.37.0** | 10.24.0 | 10.11.0 | 9.73.6  | 9.72.0  | 9.27.3 |
| **data-sync**              | **10.20.1** | 10.14.1 | 10.3.1  | 9.22.1  | 9.21.0  | 9.11.0 |
| **authorization-system**   | **10.28.0** | 10.18.1 | 10.7.0  | 9.34.2  | 9.33.0  | 9.14.2 |
| **nosql-db-runner**        | **10.17.0** | 10.10.1 | 10.4.1  | 9.22.1  | 9.21.0  | 9.11.0 |
| **email-gateway**          | **10.9.0**  | -       | -       | -       | -       | -      |

### Embedded components

* **SpiceDB**
* **DGraph**

### Renderers

| Component                     | 5.4.0       | 5.3.0   | 5.2.0   | 5.1.1   | 5.1.0   | 5.0.0  |
| ----------------------------- | ----------- | ------- | ------- | ------- | ------- | ------ |
| **@flowx/angular-sdk**        | **10.59.1** | 10.32.4 | 10.12.1 | 9.159.5 | 9.153.6 | 9.69.0 |
| **@flowx/angular-theme**      | **10.59.1** | 10.32.4 | 10.12.1 | 9.159.5 | 9.153.6 | 9.69.0 |
| **@flowx/angular-ui-toolkit** | **10.59.1** | 10.32.4 | 10.12.1 | 9.159.5 | 9.153.6 | 9.69.0 |
| **@flowx/react-sdk**          | **10.59.1** | 10.32.4 | 10.12.1 | 9.159.5 | 9.153.6 | 9.69.0 |
| **@flowx/react-theme**        | **10.59.1** | 10.32.4 | 10.12.1 | 9.159.5 | 9.153.6 | 9.69.0 |
| **@flowx/react-ui-toolkit**   | **10.59.1** | 10.32.4 | 10.12.1 | 9.159.5 | 9.153.6 | 9.69.0 |
| **@flowx/core-sdk**           | **10.59.1** | 10.32.4 | 10.12.1 | 9.159.5 | 9.153.6 | 9.69.0 |
| **@flowx/core-theme**         | **10.59.1** | 10.32.4 | 10.12.1 | 9.159.5 | 9.153.6 | 9.69.0 |
| **iOS renderer**              | **10.2.0**  | 10.1.0  | 10.0.0  | 9.0.5   | 9.0.4   | 9.0.0  |
| **Android renderer**          | **10.2.0**  | 10.1.0  | 10.0.0  | 9.0.3   | 9.0.2   | 9.0.0  |

### Plugins

| Component            | 5.4.0  | 5.3.0  | 5.2.0  | 5.1.1  | 5.1.0  | 5.0.0  |
| -------------------- | ------ | ------ | ------ | ------ | ------ | ------ |
| **ocr-plugin**       | 1.0.17 | 1.0.17 | 1.0.17 | 1.0.17 | 1.0.17 | 1.0.17 |
| **reporting-plugin** | 0.2.3  | 0.2.3  | 0.2.3  | 0.2.3  | 0.2.3  | 0.2.0  |

### AI Platform

| Component                       | 5.4.0      | 5.3.0  | 5.2.0  | 5.1.1 | 5.1.0 | 5.0.0  |
| ------------------------------- | ---------- | ------ | ------ | ----- | ----- | ------ |
| **ai-assistant**                | **10.1.2** | 10.1.1 | 10.0.1 | 9.2.5 | 9.2.4 | 9.2.3  |
| **di-platform**                 | 10.2.5     | 10.2.5 | 10.2.0 | 9.3.1 | 9.3.1 | 9.0.12 |
| **ai-platform-ai-developer**    | **10.1.3** | 10.1.3 | 10.0.1 | 9.4.2 | 9.3.0 | 9.0.1  |
| **ai-platform-connected-graph** | **10.1.3** | 10.1.3 | 10.0.1 | 9.4.2 | 9.3.0 | 9.0.1  |
| **ai-platform-knowledge-graph** | **10.1.3** | 10.1.3 | 10.0.1 | 9.4.2 | 9.3.0 | 9.0.1  |
| **ai-platform-agents**          | **10.1.3** | 10.1.3 | 10.0.1 | 9.4.2 | 9.3.0 | 9.0.1  |
| **ai-platform-conversations**   | **10.1.3** | 10.1.3 | 10.0.1 | 9.4.2 | 9.3.0 | 9.0.1  |
| **ai-platform-models**          | **10.1.3** | 10.1.3 | 10.0.1 | 9.4.2 | 9.3.0 | 9.0.1  |
| **ai-platform-tenants**         | **10.1.3** | 10.1.3 | 10.0.1 | 9.4.2 | 9.3.0 | 9.0.1  |
| **ai-platform-planner**         | **10.1.3** | 10.1.3 | 10.0.1 | 9.4.2 | 9.3.0 | 9.0.1  |
| **ai-platform-ai-analyst**      | **10.1.3** | 10.1.3 | 10.0.1 | 9.4.2 | 9.3.0 | 9.0.1  |
| **ai-platform-ai-designer**     | **10.1.3** | 10.1.3 | 10.0.1 | 9.4.2 | 9.3.0 | 9.0.1  |
| **ai-platform-agent-builder**   | **10.1.3** | 10.1.3 | 10.0.1 | 9.4.2 | 9.3.0 | 9.0.1  |
| **ai-platform-binaries**        | **10.1.3** | 10.1.3 | 10.0.1 | 9.4.2 | 9.3.0 | 9.0.1  |

## Third-party recommended component versions

| FlowX.AI Version | 3rd Party Dependency | Supported Versions |
| ---------------- | -------------------- | ------------------ |
| 5.4.0            | Keycloak             | 26+                |
| 5.4.0            | Kafka                | 3.8 - 3.9          |
| 5.4.0            | PostgreSQL           | 16 - 17            |
| 5.4.0            | Oracle Database      | 21c, 23ai          |
| 5.4.0            | MongoDB              | 7 - 8              |
| 5.4.0            | Redis                | 7.4 - 8.0          |
| 5.4.0            | Elasticsearch        | 8                  |
| 5.4.0            | Angular (Web SDK)    | 20                 |
| 5.4.0            | React (Web SDK)      | 18.x               |

<Warning>
  Starting FlowX 5.0, the following versions of 3rd Party Dependencies are no longer supported:

  * Keycloak versions older than 26
  * Kafka versions older than 3.8
  * Redis versions older than 7.4
</Warning>

## New in v5.4.0

### Key features and updates

<CardGroup cols={2}>
  <Card title="Email Trigger" icon="envelope">
    Start processes automatically from incoming emails with configurable validation rules
  </Card>

  <Card title="MCP Server Improvements" icon="server">
    Enhanced audit logging, resource management, and tool refresh capabilities
  </Card>

  <Card title="Email Gateway" icon="envelope-open-text">
    New microservice for handling email communication workflows
  </Card>
</CardGroup>

## Upgrading from v5.3.0

### Breaking changes

<Info>
  FlowX.AI 5.4.0 does not introduce breaking changes for standard deployments. Upgrades from v5.3.0 should be straightforward.
</Info>

### New environment variables

The following new environment variables have been introduced:

| Variable                         | Service        | Description                                                                                                           |
| -------------------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------- |
| `KAFKA_CONNECTORS_TOPIC_PATTERN` | process-engine | Dedicated Kafka topic pattern for connectors (optional, falls back to `KAFKA_TOPIC_PATTERN` if not set)               |
| `KAFKA_BOOTSTRAP_SERVERS`        | All services   | Standardized Kafka bootstrap servers property (preferred over `SPRING_KAFKA_BOOTSTRAPSERVERS`, backwards compatible)  |
| `KAFKA_SECURITY_PROTOCOL`        | All services   | Standardized Kafka security protocol property (preferred over `SPRING_KAFKA_SECURITY_PROTOCOL`, backwards compatible) |

### Key changes

* **Email Trigger**: New capability to start processes from email events
* **Connector Topics**: New dedicated topic pattern variable for connectors
* **Kafka Configuration**: Standardized Kafka property names (`KAFKA_BOOTSTRAP_SERVERS`, `KAFKA_SECURITY_PROTOCOL`) aligned across all services with backwards compatibility
* **Email Gateway**: New microservice for email communication workflows

### New microservice: Email Gateway

<Info>
  FlowX.AI 5.4.0 introduces a new optional microservice: **Email Gateway**. This service handles email communication workflows within the platform.
</Info>

The Email Gateway requires the following infrastructure:

| Component  | Requirement                                   |
| ---------- | --------------------------------------------- |
| PostgreSQL | Dedicated database named `email_gateway`      |
| MongoDB    | Connection to existing `app-runtime` database |
| Kafka      | Access to the FlowX Kafka cluster             |
| Redis      | Shared Redis instance                         |
| Keycloak   | Service account for authentication            |

<Note>
  The Email Gateway operates as an internal service and does not require ingress configuration.
</Note>

<Card title="Email Gateway Setup Guide" href="/5.1/setup-guides/email-gateway-setup" icon="envelope-open-text">
  Complete setup instructions including Helm values, environment variables, and troubleshooting.
</Card>

### Compatibility

* **No Breaking Changes**: Standard deployments can upgrade without configuration changes
* **Feature Additions**: SaaS features require additional infrastructure configuration for production use
* **Renderer Updates**: Web and mobile SDKs include bug fixes with backward compatibility
* **Database**: No schema changes required for this upgrade

## Support

<Info>
  For technical support, deployment assistance, or feature questions, please contact your FlowX.AI support representative.
</Info>

### Support channels

* **Technical issues**: Contact your FlowX.AI support representative
* **Feature questions**: Reach out through your designated support channel
* **Documentation**: Report documentation issues or suggestions