Skip to content

Latest commit

 

History

History
121 lines (74 loc) · 3.76 KB

README.md

File metadata and controls

121 lines (74 loc) · 3.76 KB
Raw

HOMER-View

Stand-Alone Angular Viewer for HOMER API 7.7

2020-03-18_16-53-40

Requirements

  • This Application requires a Proxy like HEP Auth Proxy to access the HOMER API.

1 Install and configure the Proxy

  1. open the proxy config from proxy/config.js

  2. configure the proxy settings with your HOMER API parameters and the server you want to Proxy the API as shown:

...
var config = {

        // the url of my api
        apiUrl: 'http://[Api Host]/api/v3/',

        // the url of my api auth
        apiSess: 'http://[Api Host]/api/v3/auth',
        
        apiAuthJWT: true, //Activate for Homer7 setup
       
        apiUser: '[api-user]',   // api user
       
        apiPass: '[api-pass]',  // api password

        timeOut: 1800, // seconds

        //my server host where I will run the View and the Proxy
        proxyHost: '[my Homer-view host]',

        // my server Proxy port
        proxyPort: 8765
};

module.exports = config;
...
  1. start proxy: cd proxy; npm install && npm start ( The proxy will start in the Port you specified, so be sure that you have that port available for the Proxy )

2 Install and configure the view

  1. cd homer-view

  2. Run npm install to install dependencies.

  3. Run npm install -g @angular/cli to install or update Angular CLI.

  4. configure your environment.ts with the correct apiUrl

...
import { VERSION } from '../VERSION';
export const environment = {
  production: false,
  environment: VERSION + '(dev)',
  /* MY URL with proxy port*/
  apiUrl: 'http://my.host:8765'
};

...

  1. npm run build to build the Stand-Alone Angular Viewer. Or just jump to next step for running with the default environment.

  2. ng serve --host=my.server.host --port=4200 to serve the app replacing the 4200 with the port and my.server.host with the host you will use for the Homer-view.

  3. Access the application at http://my.server.host:4200/

  4. Test the Homer-view app with the parameters of a call stored in your server.

Example

  • http://localhost:4200/?id=16697926&callid=3orfbk@127.0.0.1&from=1574632800000&to=1577224799000
  1. If you have errors in the console it should be because now the ?id= param is needed. And the queries you made before are stored on local storage.

Just clean local storage and refresh the browser.

URL Parameters

The Application accepts the following URL parameters defining search settings

Required

  • id: id string or array
  • callid: callid string or array
  • from: start time in milliseconds
  • to: stop time in milliseconds

Optional

  • tabs: visibile tabs, options
    • messages
    • qos
    • flow
    • logs
    • export

Example

  • http://localhost:4200/?id=16697926&callid=3orfbk@127.0.0.1&from=1574632800000&to=1577224799000

Made by Humans

This Open-Source project is made possible by actual Humans without corporate sponsors, angels or patreons.
If you use this software in production, please consider supporting its development with contributions or donations

Donate