Prerequisites
See the Flowable System Requirements and Supported Software documentation.
Additional specific requirements are listed in the sections
Content Storage
Content items which are uploaded to Flowable need to be stored on a persistent medium.
By default, Flowable stores the documents on the file system of the running node at the following location: <USER-HOME>/content (e. g. /Users/myusername/content)
The location can be customized by configuring the following application property flowable.content.storage.root-folder=<storage folder for content items>.
On multi-node environments and dockerized installations, the content storage needs to be configured to a persistent common storage system (for example a pvc volume) to not lose any content items.
Further, Flowable supports the configuration of database-based content storage, AWS S3, Azure Blob Storage, and the possibility to implement a custom content storage system. A detailed guide is provided under Content Object Storage customization.
WebSockets
Chat capabilities Only
The chat feature of Flowable uses advanced Web 2.0 technologies to allow real time communication directly within a browser.
To achieve this, all network components (routers, firewalls, proxies, browsers, etc.) need to support the WebSocket technology as specified in RFC 6455.
If your infrastructure is not WebSocket capable, a fallback is to use either the supported streaming or long polling options. These alternatives have some impact on your infrastructure requirements.
It is also possible to allow or deny the use of WebSockets on a user role level.
STOMP Messaging Queue
Chat capabilities Only
The chat feature of Flowable requires a messaging queue to enable real time communication between users that supports the STOMP protocol.
Any STOMP compatible messaging queue is supported but Flowable recommends ActiveMQ as the preferred messaging queue. For clustered environments you should choose a "network of brokers" over the master-slave configuration. It is best to have one ActiveMQ node per Flowable server node and let it connect to it.
Flowable Adapters
Chat capabilities Only
The chat feature of Flowable uses additional communication adapters to integrate with 3rd party messaging platforms (like WhatsApp, WeChat, LINE, Facebook, etc.). The communication adapters are built on Java and Spring Boot. They require Java 8, 11, or (since v3.12.0+) 17. All the adapters are stateless (without a database) and communicate via JMS with Flowable.
WhatsApp Adapter
Memory and disk space requirements depend on the specific use cases modelled, the number of users and the expected number and size of the documents.
| CPU | RAM | Disk | |
|---|---|---|---|
| Minimum | 1 | 2 GB | 10 GB |
| Recommended | 2 | 4 GB | 20 GB |
Apart from the the Flowable WhatsApp Adapter, the WhatsApp client provided by Facebook should be installed as well. Information on how to install the WhatsApp client provided by Facebook can be found here. You can find more information in Third-Party Messenger Integration.
WeChat Adapter
Memory and disk space requirements depend on the specific use cases modelled, the number of users and the expected number and size of the documents.
| CPU | RAM | Disk | |
|---|---|---|---|
| Minimum | 1 | 2 GB | 10 GB |
| Recommended | 2 | 4 GB | 20 GB |
You can find more information in Third-Party Messenger Integration.
LINE Adapter
Memory and disk space requirements depend on the specific use cases modelled, the number of users and the expected number and size of the documents.
| CPU | RAM | Disk | |
|---|---|---|---|
| Minimum | 1 | 2 GB | 10 GB |
| Recommended | 2 | 4 GB | 20 GB |
You can find more information in Third-Party Messenger Integration.