Skip to content

Commit

Permalink
updated quick installation for mac and linux (#45)
Browse files Browse the repository at this point in the history
  • Loading branch information
@fahad-aot
fahad-aot authored May 7, 2024
1 parent 6d26b6d commit 06b8cc6
Show file tree
Hide file tree
Showing 2 changed files with 97 additions and 88 deletions.
77 changes: 41 additions & 36 deletions Pages/PC/linux/onLinux.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,58 +37,63 @@ The quick-installation option saves time and labour, and is less error prone tha

## Steps for formsflow.ai Installation

1.Download the following installation bundle to perform Quick Installation.

<span class="fs-5">
[Formsflow.ai-zip](https://github.com/AOT-Technologies/forms-flow-ai-deployment/archive/refs/heads/main.zip){: .btn .btn-purple .mr-4}
</span>
1. Download the following installation bundle to perform Quick Installation.

2.Extract the contents of the downloaded zip file in the desired location.
<span class="fs-5">
[Formsflow.ai-zip](https://github.com/AOT-Technologies/forms-flow-ai-deployment/archive/refs/heads/main.zip){: .btn .btn-purple .mr-4}
</span>

3.Open the Extracted folder, choose the folder forms-flow-ai-deployment and then open the folder scripts.
2. Extract the contents of the downloaded zip file in the desired location.

![folder](../../../assets/QuickDocker/quickfolder.png)

4.Double click on the install.bash file for quick Installation.
3. Open terminal ,Navigate to directory `/script `, Run the command `bash install.bash`.

![install](../../../assets/QuickDocker/install_bash.png)
{: .mt-6 .ml-6}
<span class ="text-gamma text-center" > OR</span>

5.The installation starts with the following question,
Open the Extracted folder, choose the folder forms-flow-ai-deployment and then open the folder scripts.
- Double click the bash script
- Open the terminal and make sure your current working directory is `forms-flow-ai-deployment\scripts`
- Run the command `bash install.bash`

![installqstn1](../../../assets/QuickDocker/runscript1.png)
{: .mt-6 .ml-6}
<!-- ![folder](../../../assets/QuickDocker/quickfolder.png) -->

*a*. 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](https://redash.io/help/) ).
{: .ml-5}
![install](../../../assets/QuickDocker/install_bash.png)
{: .mt-6 .ml-6}

![installqstn2](../../../assets/QuickDocker/runscript2.png)
{: .mt-6 .ml-6}
*b*. Verify the IP address is valid or incorrect after that. If true, provide 'y' as the answer, or else answer ‘n’.
{: .ml-5}
![installqstn3](../../../assets/QuickDocker/runscript3.png)
{: .mt-6 .ml-6}
*c*. Provide the proper ip address.
{: .ml-5}
4. The installation starts with the following question,

![installqstn1](../../../assets/QuickDocker/runscript1.png)
{: .mt-6 .ml-6}

*a*. 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](https://redash.io/help/) ).
{: .ml-5}

![installqstn2](../../../assets/QuickDocker/runscript2.png)
{: .mt-6 .ml-6}
*b*. Verify the IP address is valid or incorrect after that. If true, provide 'y' as the answer, or else answer ‘n’.
{: .ml-5}
![installqstn3](../../../assets/QuickDocker/runscript3.png)
{: .mt-6 .ml-6}
*c*. Provide the proper ip address.
{: .ml-5}

6.As part of the installation, if the user has chosen the option to install with “Analytics” the user is asked to enter the Redash API key after the successful installation of Redash.
5. As part of the installation, if the user has chosen the option to install with “Analytics” the user is asked to enter the Redash API key after the successful installation of Redash.

![install](../../../assets/QuickDocker/apikey.png)
{: .mt-6 .ml-6}
![install](../../../assets/QuickDocker/apikey.png)
{: .mt-6 .ml-6}

7.The Redash application should be available for use at port defaulted to 7000. Open [http://localhost:7000/](http://localhost:7000/) on your machine and register with any valid credentials.
6. The Redash application should be available for use at port defaulted to 7000. Open [http://localhost:7000/](http://localhost:7000/) on your machine and register with any valid credentials.

![install](../../../assets/QuickDocker/redash.png)
{: .mt-6 .ml-6}
![install](../../../assets/QuickDocker/redash.png)
{: .mt-6 .ml-6}

8.To get the Redash API key, log in to [http://localhost:7000/](http://localhost:7000/),Choose Settings>>Account, and copy the API Key.
7. To get the Redash API key, log in to [http://localhost:7000/](http://localhost:7000/),Choose Settings>>Account, and copy the API Key.

![install](../../../assets/QuickDocker/redashapikey.png)
{: .mt-6 .ml-6}
![install](../../../assets/QuickDocker/redashapikey.png)
{: .mt-6 .ml-6}

9.Copy the API Key and paste it into the cmd. The installation will continue.
8. Copy the API Key and paste it into the cmd. The installation will continue.

10.Once the installation is complete, the command prompt displays the installation is complete. The Docker Desktop displays all the installed containers.
9. Once the installation is complete, the command prompt displays the installation is complete. The Docker Desktop displays all the installed containers.

### Health Check
- Analytics should be up and available for use at port defaulted to 7001 i.e.<a target="_blank" href="http://localhost:7001/">http://localhost:7001/</a>.
Expand Down
108 changes: 56 additions & 52 deletions Pages/PC/macOS/onMac.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,58 +39,62 @@ The quick-installation option saves time and labour, and is less error prone tha

## Steps for formsflow.ai Installation

1.Download the following installation bundle to perform Quick Installation.

<span class="fs-5">
[Formsflow.ai-zip](https://github.com/AOT-Technologies/forms-flow-ai-deployment/archive/refs/heads/main.zip){: .btn .btn-purple .mr-4}
</span>

2.Extract the contents of the downloaded zip file in the desired location.

3.Open the Extracted folder, choose the folder forms-flow-ai-deployment and then open the folder scripts.

4.Double click on the install.bash file for quick Installation.

![install](../../../assets/QuickDocker/mac/mac_bash.png)
{: .mt-6 .ml-6}

5.The installation starts with the following question,

![installqstn1](../../../assets/QuickDocker/mac/mac_analytics.png)
{: .mt-6 .ml-6}

*a*. 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](https://redash.io/help/) ).
{: .ml-5}

![installqstn2](../../../assets/QuickDocker/mac/mac_order.png)
{: .mt-6 .ml-6}
*b*. Verify the IP address is valid or incorrect after that. If true, provide 'y' as the answer, or else answer ‘n’.
{: .ml-5}

*c*. Provide the proper ip address.
{: .ml-5}

6.As part of the installation, if the user has chosen the option to install with “Analytics” the user is asked to enter the Redash API key after the successful installation of Redash.

![install](../../../assets/QuickDocker/mac/mac_installing.png)
{: .mt-6 .ml-6}

![install](../../../assets/QuickDocker/mac/mac_installing2.png)
{: .mt-6 .ml-6}

7.The Redash application should be available for use at port defaulted to 7000. Open [http://localhost:7000/](http://localhost:7000/) on your machine and register with any valid credentials.

![install](../../../assets/QuickDocker/redash.png)
{: .mt-6 .ml-6}

8.To get the Redash API key, log in to [http://localhost:7000/](http://localhost:7000/),Choose Settings>>Account, and copy the API Key.

![install](../../../assets/QuickDocker/redashapikey.png)
{: .mt-6 .ml-6}

9.Copy the API Key and paste it into the cmd. The installation will continue.

10.Once the installation is complete, the command prompt displays the installation is complete. The Docker Desktop displays all the installed containers.
1. Download the following installation bundle to perform Quick Installation.
<span class="fs-5">
[Formsflow.ai-zip](https://github.com/AOT-Technologies/forms-flow-ai-deployment/archive/refs/heads/main.zip){: .btn .btn-purple }
</span>
2. Extract the contents of the downloaded zip file in the desired location.

3. Open terminal ,Navigate to directory `/script `, Run the command `bash install.bash`.

<span class ="text-gamma text-center" > OR</span>

Open the Extracted folder, choose the folder forms-flow-ai-deployment and then open the folder scripts.
- Double click the bash script
- Open the terminal and make sure your current working directory is `forms-flow-ai-deployment\scripts`
- Run the command `bash install.bash`

![install](../../../assets/QuickDocker/mac/mac_bash.png)
{: .mt-6 .ml-6}


4. The installation starts with the following question,

![installqstn1](../../../assets/QuickDocker/mac/mac_analytics.png)
{: .mt-6 .ml-6}

*a*. 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](https://redash.io/help/) ).
{: .ml-5}

![installqstn2](../../../assets/QuickDocker/mac/mac_order.png)
{: .mt-6 .ml-6}
*b*. Verify the IP address is valid or incorrect after that. If true, provide 'y' as the answer, or else answer ‘n’.
{: .ml-5}

*c*. Provide the proper ip address.
{: .ml-5}

5. As part of the installation, if the user has chosen the option to install with “Analytics” the user is asked to enter the Redash API key after the successful installation of Redash.

![install](../../../assets/QuickDocker/mac/mac_installing.png)
{: .mt-6 .ml-6}

![install](../../../assets/QuickDocker/mac/mac_installing2.png)
{: .mt-6 .ml-6}

6. The Redash application should be available for use at port defaulted to 7000. Open [http://localhost:7000/](http://localhost:7000/) on your machine and register with any valid credentials.

![install](../../../assets/QuickDocker/redash.png)
{: .mt-6 .ml-6}

7. To get the Redash API key, log in to [http://localhost:7000/](http://localhost:7000/),Choose Settings>>Account, and copy the API Key.

![install](../../../assets/QuickDocker/redashapikey.png)
{: .mt-6 .ml-6}

8. Copy the API Key and paste it into the cmd. The installation will continue.

9. Once the installation is complete, the command prompt displays the installation is complete. The Docker Desktop displays all the installed containers.

### Health Check
- Analytics should be up and available for use at port defaulted to 7001 i.e.<a target="_blank" href="http://localhost:7001/">http://localhost:7001/</a>.
Expand Down

0 comments on commit 06b8cc6

Please sign in to comment.