-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathquick_installation.html
112 lines (96 loc) · 6.27 KB
/
quick_installation.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
<article class="docs-article" id="section-1">
<section class="docs-section" id="installation-1">
<h1 class="docs-heading">Quick Installation</h1>
<hr>
<p>The quick-installation option saves time and labour, and is less error prone than manual installation. It
helps you set up a running environment of formsflow.ai by installing the necessary packages and customizing
the configuration files automatically.</p><br>
<h3>Prerequisites</h3>
<ol>
<li>For installation of formsflow.ai, the <a href="https://www.docker.com/">Docker Desktop</a> needs to be
installed (for both Windows/Linux). If Docker has been installed, and if any previous formsflow.ai
installations were done already, those need to be removed from the Docker Desktop.</li>
<li>This installation is supported only by Node.js versions 14 and below (older versions of Node.js are
listed
<a href="https://nodejs.org/en/download/releases/">here</a>).
</li>
</ol>
<h2>Steps for formsflow.ai Installation</h2>
<hr><br>
<ol>
<li>To start the formsflow.ai quick installation process, open the GitHub repository <a
href="https://github.com/AOT-Technologies/forms-flow-ai-deployment">https://github.com/AOT-Technologies/forms-flow-ai-deployment</a>
.
</li>
<li>Clone the repository and copy this folder's contents to any local folder in your system. The steps to
clone the folder:</li>
<ol type="a">
<li>Expand the option code and clone the GitHub repository URL.
</li><br><br>
<img src="./assets/images/clone.png" height="450" width="800"></img><br><br>
<li>Create a new folder or open any folder on your machine, open the command prompt for the folder and
clone this repository to the folder using the command
<code> <strong>git clone <repo name></strong></code>
</li><br><br>
<img src="./assets/images/quickinstallation.png"></img><br><br>
<li>Once the repository is copied, the command prompt will display done, and all the folders in the
repository will be present in the respective local folder.</li><br><br>
<img src="./assets/images/quickinstallation1.png"></img><br><br><br>
<img src="./assets/images/folderstructure.png"></img><br><br>
</ol>
<li>Open the folder forms-flow-ai deployment>>Scripts>>Run the Install.bat/install.bash file for
Windows/Linux respectively.</li><br>
<img src="./assets/images/Screenshot 2022-10-10 125306.png"><br><br>
<li>The installation starts with the following question,</li>
<ol type="a">
<li>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 <a
href="https://redash.io/help/">Redash</a> ).</li>
<img src="./assets/images/automation1.png"></img><br><br>
<li>Verify the IP address is valid or incorrect after that. If true, provide ‘y’ as the answer, or else
answer ‘n’.</li>
<img src="./assets/images/quick3.png" width="600"><br><br>
<li> Provide the proper ip address.</li><br><br>
<img src="./assets/images/quick4.png" width="600">
</ol>
<br><br>
<li>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.</li><br><br>
<img src="./assets/images/quick2.png"></img><br><br>
<li>
The Redash application should be available for use at port defaulted to 7001. Open
<a href="http://localhost:7001/">http://localhost:7001/</a> on your machine and register with any valid
credentials.
</li><br><br>
<img src="./assets/images/analyticsdashboard.png" height="700" width="500"></img><br><br> <br>
<li>To get the Redash API key, log in to <a href="http://localhost:7001/"> http://localhost:7001/</a>,Choose
Settings>>Account, and copy the API
Key.</li>
<img src="./assets/images/apikey.png" height="250" width="500"></img><br><br>
<li>Copy the API Key and paste it into the cmd. The installation will continue.</li>
<li>Once the installation is complete, the command prompt displays the installation is complete. The Docker
Desktop displays all the installed containers.</li>
<li>Health check can be applied.</li>
</ol>
<h4 id="healthcheck">Health Check</h4>
<ul>
<li>Analytics should be up and available for use at port defaulted to 7001 i.e. <a
href="http://localhost:7001/">http://localhost:7001/</a>.</li>
<li>Business Process Engine should be up and available for use at port defaulted to 8000
i.e.<a href="http://localhost:8000/camunda/"> http://localhost:8000/camunda/</a>.</li>
<li>FormIO should be up and available for use at port defaulted to 3001 i.e. <a
href="http://localhost:3001/checkpoint">http://localhost:3001/checkpoint</a>.</li>
<li>formsflow.ai REST API should be up and available for use at port defaulted to 5000 i.e.
<a href="http://localhost:5000/checkpoint">http://localhost:5000/checkpoint</a>.
</li>
<li>formsflow.ai web application should be up and available for use at port defaulted to
3000 i.e. <a href="http://localhost:3000/">http://localhost:3000/</a>.</li>
<li>
<p>Default user credentials are provided <a href="default user credential.html"
target="_blank">here</a>.
</p>
</li>
</ul>
</div>
</section>
</article>