proj_deploy

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
proj_deploy [2020/03/23 09:51] – ingridproj_deploy [2023/04/11 12:55] (current) – [Project Deployment] ingrid
Line 5: Line 5:
     * [[#deploy_project_using_the_local_network| Deploy project using the local network]]     * [[#deploy_project_using_the_local_network| Deploy project using the local network]]
     * [[#deploy_project_using_thinknx_cloud| Deploy project using Thinknx Cloud]]     * [[#deploy_project_using_thinknx_cloud| Deploy project using Thinknx Cloud]]
 +      * [[#QR_code_download| QR Code download]] 
   * [[#client_authentication| Client Authentication]]   * [[#client_authentication| Client Authentication]]
     * [[#authentication_via_local_network| Authentication via local network]]     * [[#authentication_via_local_network| Authentication via local network]]
     * [[#authentication_via_cloud| Authentication via cloud]]     * [[#authentication_via_cloud| Authentication via cloud]]
 +    * [[#authentication_via_otp| Authentication via OTP]] 
   * [[#project_Export_for_backup| Project Export for Backup]]   * [[#project_Export_for_backup| Project Export for Backup]]
  
Line 98: Line 100:
 <WRAP centeralign> Figure 9: Download project from Cloud </WRAP> <WRAP centeralign> Figure 9: Download project from Cloud </WRAP>
  
 +=== QR Code Download ===
 +When the project is uploaded onto the Cloud, the user can also download it on their client device by simply scanning the QR code provided by the integrator. This QR code is generated by the Configurator by accessing the Users and Groups window and clicking on the Data Summary of each user profile. For more information, check out [[main_cons_ui#users_and_groups| section 2.Thinknx Configurator - Users and Groups]].
 +
 +The download can be accomplished by selecting the QR code icon in the Settings window on the client application. The user must allow Thinknx UP application to access the phone's camera. Scan the QR code, and the project download will automatically start. Once finished, open the project and proceed to the Authentication process below.
 +<WRAP centeralign>{{ :qrcode_button.jpeg?direct300 |QR Code button on client application}} </WRAP>
 +<WRAP centeralign> Figure 10: QR code button on client application </WRAP>
 +
 +\\ <WRAP centeralign>{{ :qrcode_scan.jpeg?direct400 |QR Code Scanning}} </WRAP>
 +<WRAP centeralign> Figure 11: QR code scanning </WRAP>
 ===== Client Authentication ==== ===== Client Authentication ====
 Whenever a client uses the Thinknx application, a connection to the server is established. Whenever a client uses the Thinknx application, a connection to the server is established.
Line 108: Line 119:
 \\ <WRAP Group> \\ <WRAP Group>
 <WRAP column half centeralign> {{ :quickguide_authenticationMsg.png?direct300 |Authentication request message}}  <WRAP column half centeralign> {{ :quickguide_authenticationMsg.png?direct300 |Authentication request message}} 
-<WRAP centeralign> Figure 10: Authentication Request Message </WRAP> +<WRAP centeralign> Figure 12: Authentication Request Message </WRAP> 
 </WRAP> </WRAP>
 <WRAP column half centeralign>  <WRAP column half centeralign> 
 {{ :quickguide_authenticationLocal.png?direct350 |Authentication method-1}}  {{ :quickguide_authenticationLocal.png?direct350 |Authentication method-1}} 
-<WRAP centeralign> Figure 11: Authentication Method-1</WRAP>+<WRAP centeralign> Figure 13: Authentication Method-1</WRAP>
 </WRAP> </WRAP>
 </WRAP> </WRAP>
Line 123: Line 134:
 <WRAP column half centeralign>  <WRAP column half centeralign> 
 {{ :quickguide_authenticationMsg2.png?direct300 |Authentication request message}}  {{ :quickguide_authenticationMsg2.png?direct300 |Authentication request message}} 
-<WRAP centeralign> Figure 12: Authentication Request Message </WRAP> +<WRAP centeralign> Figure 14: Authentication Request Message </WRAP> 
 </WRAP> </WRAP>
 <WRAP column half centeralign>  <WRAP column half centeralign> 
 {{ :quickguide_authenticationCloud.png?direct350 |Authentication method-2}}  {{ :quickguide_authenticationCloud.png?direct350 |Authentication method-2}} 
-<WRAP centeralign> Figure 13: Authentication Method-2</WRAP>+<WRAP centeralign> Figure 15: Authentication Method-2</WRAP>
 </WRAP> </WRAP>
 </WRAP> </WRAP>
 +
 +==== Authentication via OTP ====
 +
 +<WRAP important center round  80%>This feature is available for server firmware 1.1.10.22 and above, configurator version 1.3.0.24 and above, and UP client version 1.2.24 and above. </WRAP>
 +
 +Instead of sharing a username and password to allow users to authenticate with the server, it is possible to generate a one-time password (OTP) and send it to the client. The code generated is valid for 2 hours, after which it will no longer work. 
 +
 +=== Generating the OTP ===
 +  * Only an Admin user can generate an OTP. The code is generated directly from the client application. To define an authenticated user as Admin, go to the server's webpage under Licenses and Codes, and make sure to enabled the Admin option for the admin user.
 +<WRAP centeralign>{{ :admin_configure.png?direct400 |Admin Configuration}} </WRAP>
 +<WRAP centeralign> Figure 16: Admin Configuration </WRAP>
 +
 +  * In the configurator, click on System and enable "Use OTP Authentication".
 +
 +<WRAP centeralign>{{ :enable_OTP.png?direct500 |Enable OTP}} </WRAP>
 +<WRAP centeralign> Figure 17: Enable OTP Authentication </WRAP>
 +
 +  *Open the project using the Admin profile, and access the advanced settings window as seen in the picture below.
 + 
 +<WRAP centeralign>{{ :user_manager_1c.png?direct700 |Project Settings}} </WRAP>
 +<WRAP centeralign> Figure 18: Project Settings</WRAP>
 +
 +  * Click on Manage Clients, and add a new user. Configure your preferences for this user and save it.
 +
 +<WRAP centeralign>{{ :user_manager_2.png?direct750 |Create User}} </WRAP>
 +<WRAP centeralign> Figure 19: Create User</WRAP>
 +
 +  * The user created is now visible in the Users list with the OTP displayed as the user label. The admin can now share this OTP with another user to authenticate with the server. 
 +
 +<WRAP centeralign>{{ :user_manager_3.png?direct450 |OTP created}} </WRAP>
 +<WRAP centeralign> Figure 20: OTP created</WRAP>
 +
 +=== Using the OTP to authenticate ===
 +
 +  * Any user wanting to authenticate with the server should ask the Admin for the OTP.
 +  * Download the project on the user's device using one of the methods explained above.
 +  * Open the project downloaded. A popup shows up, asking the user to authenticate. A toggle button on the extreme right of the popup gives the option to authenticate using username and password, or OTP. Select the OTP view mode, and enter the OTP generated by the Admin.
 +
 +<WRAP centeralign>{{ :user_manager_4.png?direct600 |OTP authentication}} </WRAP>
 +<WRAP centeralign> Figure 21: OTP Authentication</WRAP>
 +
 +
  
 ===== Project Export ===== ===== Project Export =====
Line 139: Line 192:
   * **Export for server on file** If the PC which the Configurator is running on is not in the same LAN as the one for the server, the software automatically creates an ".srv" file that can be manually uploaded to the web page. To do so, go to the server's web page, click on "Upload" tab then click on the button "select file". One the file is selected, click on "upload". The server will restart automatically and the project is now uploaded.   * **Export for server on file** If the PC which the Configurator is running on is not in the same LAN as the one for the server, the software automatically creates an ".srv" file that can be manually uploaded to the web page. To do so, go to the server's web page, click on "Upload" tab then click on the button "select file". One the file is selected, click on "upload". The server will restart automatically and the project is now uploaded.
 {{ :pro_man_-_figura18.png?direct&800 |Export for server on file}} {{ :pro_man_-_figura18.png?direct&800 |Export for server on file}}
-<WRAP center 60%> <WRAP centeralign> Figure 14: Export for server on file </WRAP> </WRAP>+<WRAP center 60%> <WRAP centeralign> Figure 22: Export for server on file </WRAP> </WRAP>
  
  
  
  
  • proj_deploy.1584953505.txt.gz
  • Last modified: 2020/03/23 09:51
  • by ingrid