Configure the Vidyo Discovery Service

The Vidyo Discovery Service is an optional component that can be configured on the same deployment of the Vidyo Epic Service. The Vidyo Discovery Service serves as a location to point endpoints to where they can discover where certain services are hosted; in this case, the Vidyo Epic Service. You can optionally choose to host this JSON file in another location instead of on the Vidyo Epic Service. If you choose to do so, just upload the JSON file to that location and skip to Apply the custom parameters to your tenant.

This section provides the information you require to configure the Vidyo Discovery Service:

Setup prerequisites

  1. Vidyo Epic Service Public FQDN: This is the URL (public) that clients will use to interact with the Vidyo Epic Service.
  2. VidyoPlatform API credentials: These are the VidyoPlatform API credentials to the Vidyo Epic Service. These will be used to invoke certain commands.

Create the services file

You must create a file, services.json, with the following structure:

{

  "epicService": {

    "url": "https://vidyoepicservice.example.com/epic/api/v1",

    "isServiceAvailable": true

  }

}

Note

Replace "https://vidyoepicservice.example.com/epic/api/v1" with the Public FQDN of your deployed Vidyo Epic Service.

Upload the services file

  1. Log into the System Console.
  2. Set up a VidyoPlatform API user.
Note

To continue, you must have an SSH private/public key pair generated. How to do this is outside the scope of this document.
  1. Use the VidyoUpload Platform API to upload the services.json file to the Vidyo Epic Service server.

kram@test-machine: ~$ cat services.json | ssh apiuser@10.10.10.10 VidyoUpload

12+1 records in

12+1 records out

6261 bytes (1.0 kB, 1.0 KiB) copied, 0.000115537 s, 54.2 MB/s

  1. Run the VidyoDiscovery Platform API to update the file.

kram@test-machine: ~$ ssh apiuser@10.10.10.10 VidyoDiscovery updateServices

  1. After the service file is updated, restart the service to apply the changes.

kram@test-machine: ~$ ssh apiuser@10.10.10.10 VidyoDiscovery restart

  1. Verify the service.json file is available by going to the following path:

https://vidyoepicservice.example.com/discovery/api/v1/services

You should see the content of the service.json file that you uploaded.

Apply the custom parameters to your tenant

For information about how to configure the Tenant Admin for this feature, refer to the Configuring Custom Parameters section in the VidyoPortal and VidyoRouter Administrator Guide.

  • Using the Custom Parameters menu, add the following entry (replacing vidyoepicservice.example.com with your service URL).

Auth type

Key

Value

Registered

vidyoCloudServicesURL

https://vidyoepicservice.example.com/discovery/api/v1/services