Skip to main content
Version: Next

Linux / MAC

Prerequisites

  • Docker needs to be installed andd running

Step 1: Download the GitHub Repository

In this initial step, download the Forms Flow AI Deployment GitHub repository by simply clicking Here

A zip file will be downloaded.

Step 2: Extract the downloaded .zip file

extracted folder preview

Now double click and open the exctracted folder and go to the scripts directory:

scripts dir preview

There you can see install.bash file:

install file preview

Now right click anywhere in the file manager and click open in terminal:

.bat file preview

Now type sudo su in the terminal to gain elevated privilages whcih is required for the installation procedure:

sudo permissions

  • You can type ls to see the install.sh file there

Step 3: Install using install.bash file

Type ./install.sh to start the installation:

  • It may ask for Do you want to continue because it may not tested in the Docker version you have. Just enter 'y' and proceed with the installation.

installation start

a) The installation starts with the following question:

Redash analytics prompt

  • If you need Redash Analytics Engine in the installation, provide ‘y’ as the answer, or else answer ‘n’. (To know more about Redash Analytics Engine, please visit Redash ).

b) Verify the IP address is valid or incorrect after that. If true, provide ‘y’ as the answer, or else answer ‘n’:

IP Address prompt

c) Now it will ask to install formsflow data analysis api in the installation. Chose 'y' or 'n' according to your preference:

formsflow data analysis api prompt

d) Once the installation is complete, the command prompt displays the formsflow.ai is successfully installed.

Step 4: Mail-Configuration

For the email-configuration, follow the steps below:

configuration folder

Create a folder inside the configuration folder(Inside docker-compose directory) named bpm-mail-config.

mail configuration file

Create a file name mail.config.properties inside the bpm-mail-config folder that just created and copy the below contents and update the values as needed:

# Send mails via SMTP. The given settings are for Gmail 
mail.transport.protocol=smtp

mail.smtp.host=smtp.gmail.com
mail.smtp.port=465
mail.smtp.auth=true
mail.smtp.ssl.enable=true
mail.smtp.socketFactory.port=465
mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory

# Poll mails via IMAPS.
mail.store.protocol=imaps
mail.imaps.host=imap.gmail.com
mail.imaps.port=993
mail.imaps.timeout=10000

mail.sender=donotreply
mail.sender.alias=DoNotReply

mail.attachment.download=true
mail.attachment.path=attachments

# Credentials
mail.user=CHANGEME@gmail.com
mail.password=CHANGEME

  • Now run the container to verify the changes.

Verifying the Installation status

The following applications will be started and can be accessed in your browser.

Srl NoService NameUsageAccessDefault credentials (userName / Password)
1KeycloakAuthenticationhttp://localhost:8080admin/changeme
2forms-flow-formsform.io form building. This must be started earlier for resource role id's creationhttp://localhost:3001admin@example.com/changeme
3forms-flow-analyticsRedash analytics server, This must be started earlier for redash key creationhttp://localhost:7001Use the credentials used for registration / Default user credentials
4forms-flow-webformsflow Landing web apphttp://localhost:3000Default user credentials
5forms-flow-apiAPI serviceshttp://localhost:5001Authorization tocken from keycloak role based user credentials
6forms-flow-bpmCamunda integrationhttp://localhost:8000/camundaDefault user credentials

Uninstall Formsflow

To uninstall formsflow installed through quick installation, follow the steps:

  • Go to the folder you exctracted earlier and go to the scripts directory
    • There you can see uninstall.bash file
  • Now right click anywhere in the file manager and click open in terminal:
  • Type chmod +x uninstall.bash to give executable permission to the file
    • If you type ls you can see the uninstall.bash in green color means it has now executable permission
  • Now just type ./uninstall.bash
    • It will prompt you to uninstall formsflow.ai installation click 'y' and proceed with the installation.

uninstall formsflow

If you face any issues while installing ,please connect with us.