DVS SPA Installation Guide Public App 1.0.0
User Manual:
Open the PDF directly: View PDF 
.
Page Count: 9
| Download | |
| Open PDF In Browser | View PDF |
Qualcomm Technologies, Inc.
Device Verification Subsystem 1.0.0
SPA Installation Guide (Public App)
DVS-SPA-Installation-Guide-Public-App-1.0.0
July 9, 2018
Copyright © 2018 Qualcomm Technologies, Inc.
This work is licensed under a Creative Commons Attribution-NoDerivatives 4.0 International License.
Revision history
Revision
A
Date
Description
Initial release
Copyright © 2018 Qualcomm Technologies, Inc.
This work is licensed under a Creative Commons Attribution-NoDerivatives 4.0 International License.
2
Contents
1 Introduction .............................................................................................................................. 4
1.1 Purpose & Scope ....................................................................................................................... 4
1.2 Definitions, Acronyms & Abbreviations ...................................................................................... 4
1.3 References ................................................................................................................................ 4
1.4 Getting Started ........................................................................................................................... 4
2 Installation ................................................................................................................................ 5
2.1 System Requirements................................................................................................................ 5
2.1.1 Software Requirements ............................................................................................ 5
2.1.2 Hardware Requirement............................................................................................. 5
2.1.3 Operating System ..................................................................................................... 5
2.1.4 Supported Browser(s) ............................................................................................... 5
2.1.5 Supported Mobile Browser(s) ................................................................................... 6
2.2 Extracting Software Release ....................................................................................... 6
2.3 Manual Installation ..................................................................................................................... 6
3 Configuration ........................................................................................................................... 7
3.1 Apiman, Keycloak and API Configuration .................................................................................. 7
Tables
Table 1- Definitions, Acronyms & Abbreviations ............................................................................................................ 4
Table 2- References....................................................................................................................................................... 4
DVS-SPA-Installation-Guide-Public-App-1.0.0 Copyright © 2018 Qualcomm Technologies, Inc.
This work is licensed under a Creative Commons Attribution-NoDerivatives 4.0 International License.
3
1 Introduction
1.1 Purpose & Scope
This document provides:
■
Installation instructions for the Single Page Application (Public App) of Device Verification
Subsystem
1.2 Definitions, Acronyms & Abbreviations
Table 1- Definitions, Acronyms & Abbreviations
Term
Explanation
DIRBS
Device Identification, Registration & Blocking System
DVS
Device Verification Subsystem
OS
Operating System
Nginx
An open source, lightweight, high-performance web server or proxy
server.
API
Application Program Interface
Gateway
A Gateway route requests from clients to services
SPA
Single Page Application
IAM
Identity Access Management
1.3 References
Table 2- References
Ref no.
Document
REF-1
IAM User Guide (Section 3)
1.4 Getting Started
The instructions provided in this document assumes that the required equipment (hardware,
software) has been installed and configured.
DVS-SPA-Installation-Guide-Public-App-1.0.0 Copyright © 2018 Qualcomm Technologies, Inc.
This work is licensed under a Creative Commons Attribution-NoDerivatives 4.0 International License.
4
Device Verification Subsystem 1.0.0
Installation
2 Installation
NOTE:
The reader acknowledges and agrees that he is entirely and solely responsible for the selection
and use of all third-party software modules downloaded and installed by this installation method,
including securing all appropriate and proper rights of use to any of such third-party software
modules and to comply fully with any terms of use that may apply to or accompany any such thirdparty software modules.
Qualcomm Technologies, Inc. does not undertake any obligations, duties, or other responsibilities
in connection with the selection or use by the reader of any of such third-party software modules.
2.1 System Requirements
2.1.1 Software Requirements
Node v8.9.4 or greater
NPM v5.6.0 or greater
Nginx 1.14.X
2.1.2 Hardware Requirement
Minimum hardware requirements:
At least 512 MB of RAM
At least 1G of disk space
2.1.3 Operating System
This system will be installed and configured with Ubuntu 16.04. Refer to the Ubuntu Installation
Guide for additional installation help.
2.1.4 Supported Browser
Chrome 63.0 (recommended)
Internet Explorer 11.0
Firefox 52.5 ESR, 57.0
Safari 11.0
Edge 41.16299
DVS-SPA-Installation-Guide-Public-App-1.0.0 Copyright © 2018 Qualcomm Technologies, Inc.
This work is licensed under a Creative Commons Attribution-NoDerivatives 4.0 International License.
5
Device Verification Subsystem 1.0.0
Installation
2.1.5 Supported Mobile Browser
Chrome 63.0 (recommended)
Safari 11.1
UC Browser 11.5
Opera (Android) 44.1
Opera Mini (iOS) 16.0.7
Samsung Internet 6.2
Android (included with Android OS4.1.X-4.3)
2.2 Extracting Software Release
The DVS software release is distributed as a tar.gz file. To extract the contents of the
distribution, run:
tar xvzf dirbs-dvs-spa-public-1.0.0.tar.gz
2.3 Manual Installation
Go to dirbs-dvs-spa-public-1.0.0
pushd dirbs-dvs-spa-publlic-1.0.0
Install dependencies by running below mentioned command
npm install
DVS-SPA-Installation-Guide-Public-App-1.0.0 Copyright © 2018 Qualcomm Technologies, Inc.
This work is licensed under a Creative Commons Attribution-NoDerivatives 4.0 International License.
6
Device Verification Subsystem 1.0.0
Configuration
3 Configuration
3.1 Apiman, Keycloak and API Configuration
To align Apiman and API Configurations go to src/settings.json file and make following
configurations accordingly
nano src/settings.json
{
"appDetails": {
// configure Application name, make sure that this appName must be the
//first part of keycloak user’s role e.g. “dvs_authority” in here “dvs”
//part refers to appName and “authority” part refers to user’s role
//configured in keycloak
"appName": "APP_NAME",
//configure your support email
"supportEmail": "example@company.com",
// configure your support number
"supportNumber": "+923001234567"
},
//Note:Configure to directly hit APIs or through API Gateway (Apiman). In
order to use any of the configuration, change its "use" value to "True". If
both configurations are enabled, preference will be given to first
configuration.
"api": {
// Configure API Host e.g. http://www.api-example.com
"host": "http://SERVER_IP",
// Configure API Port e.g. 3000
"port": "PORT_NUMBER",
// Configure API Version e.g. /api/v1/
DVS-SPA-Installation-Guide-Public-App-1.0.0 Copyright © 2018 Qualcomm Technologies, Inc.
This work is licensed under a Creative Commons Attribution-NoDerivatives 4.0 International License.
7
Device Verification Subsystem 1.0.0
Configuration
"version": "VERSION_OR_SUBPATH",
// for directly hitting API, make it ‘True’
"use": true
},
"apiman": {
// configure Apiman Host e.g. http://www.apiman-example.com
// Configure Apiman Port e.g. 8000
"host": "http://SERVER_IP",
"port": "PORT_NUMBER",
// configure clientID e.g. /apiman-gateway/example/appname/1.0
"clientId": "CLIENT_ID_OR_SUBPATH",
// for hitting Apiman Gateway directly, make it *’True’
"use": false
}
}
Note: To configure SPA in IAM see IAM User Guide document section 3 and then perform
following steps:
Copy the downloaded Keycloak.json file into public directory
Build the code for production
npm run build
It will create a build directory, copy the content of the directory to web root directory e.g.
/var/www/html (default Nginx web root directory)
cp -r build/* /var/www/html
DVS-SPA-Installation-Guide-Public-App-1.0.0 Copyright © 2018 Qualcomm Technologies, Inc.
This work is licensed under a Creative Commons Attribution-NoDerivatives 4.0 International License.
8
Device Verification Subsystem 1.0.0
Testing
4 Testing
To verify the installation, visit server web IP on browser i.e. http://your_server_IP_address
DVS-SPA-Installation-Guide-Public-App-1.0.0 Copyright © 2018 Qualcomm Technologies, Inc.
This work is licensed under a Creative Commons Attribution-NoDerivatives 4.0 International License.
9
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.5 Linearized : No Page Count : 9 Language : en-US Tagged PDF : Yes Author : Fozia Zafar Creator : Microsoft® Word 2013 Create Date : 2018:11:07 12:16:40+05:00 Modify Date : 2018:11:07 12:16:40+05:00 Producer : Microsoft® Word 2013EXIF Metadata provided by EXIF.tools