Setup

System Requirements

Before proceeding with installation, ensure your system meets the following minimum requirements:

Operating System: 64-bit Windows, Linux, or macOS
RAM: Minimum 8 GB (16 GB recommended)
Disk Space: Minimum 10 GB of free space
Java: JDK or JRE version 21

Verify your Java installation by running:

java -version

Installation Methods

Portable Distribution

The portable distribution allows you to run Flowset Control without additional dependencies (except Java). Ideal for quick testing or local development.

Get the latest Flowset Control distribution package from the official downloads page.

Download

Running Instructions:

Download the portable archive from the provided link.
Extract the archive to your preferred directory.
Execute the launch script based on your OS:

Linux/macOS:
```
./run.sh
```
Windows:
```
run.bat
```
Access the application at: http://localhost:8081.

Docker Compose

This method allows for quick startup of Flowset Control in containers, without manual database or environment configuration.

Prerequisites:

Docker and Docker Compose
Verify installations:
```
docker --version
docker compose version
```

Running Instructions:

Create a docker-compose.yml file with:

version: '3.8'

services:
  postgres:
    image: postgres:15
    environment:
      POSTGRES_DB: flowset-control
      POSTGRES_USER: root
      POSTGRES_PASSWORD: root
    ports:
      - "5432:5432"

  flowset-control:
    image: flowset/flowset-control-community:latest
    environment:
      MAIN_DATASOURCE_URL: jdbc:postgresql://postgres:5432/flowset-control
      MAIN_DATASOURCE_USERNAME: root
      MAIN_DATASOURCE_PASSWORD: root
      SERVER_PORT: 8081
    ports:
      - "8081:8081"
    depends_on:
      - postgres

Start the containers:
```
docker compose up -d
```
Access the application at: http://localhost:8081.
To stop the containers:
```
docker compose down
```

Detailed instructions are available at GitHub.

Source Code Build

Build and run from source for development or custom deployments.

Prerequisites:

Git
Java 21 JDK
PostgreSQL database

Running Instructions:

Clone the repository:

git clone https://github.com/flowset/flowset-control-community

Configure PostgreSQL database.

Flowset Control stores data, such as BPM engine connections, in a database. By default, Flowset Control requires a PostgreSQL database with the following parameters:
- Database name: flowset-control
- Username: root
- Password: root
Navigate to the project directory and run:
```
./gradlew bootRun
```
Access the application at: http://localhost:8081.

Post-Installation

After successful installation:

Open your web browser and navigate to http://localhost:8081.
Use default administrator credentials (admin/admin).
Configure your BPM engine connections.