Licensing

ew-manip requires a valid license to operate. Some endpoints are accessible without a valid license, but endpoints retrieving a manipulated playlist/manifest are protected.

Requirements

• An internet connection on the machine running ew-manip
• A valid license reference provided by Agile Content

Using the license reference

The license reference along with the product name must be stored in: /etc/edgeware/ew-manip/license.json. For example:

{
    "license_ref": "this_is_an_example_license_ref",
    "product_name": "ew-manip"
}

License validation

There will be an initial and then a periodic license check every 24 hours towards a license server once the service has started. The service will initiate a grace period if, and only if, the license server cannot be reached or the license server reports an internal error. The grace period will last for 2 hours if this is the license validation made during startup, and 7 days if this was a license validation that was made after a successful validation during startup (for internal license server errors, the grace period will always be 2 hours).

If an unsuccessful validation occurs, ew-manip will do the verification more often. This starts with one minute after the first fail, two minutes after the second, doubling every time it fails. It will do so until it reaches 1024 minutes (~17 hours), and then do the verification every 1024 minutes. If the license reference is successfully verified again, it will return to verifying the reference every 24 hours.

In case license.json is changed, the ew-manip service must be restarted in order to update server data.

License information

There are mainly two ways of finding information regarding the license status in the ew-manip service, the logging, and an HTTP endpoint.

Logging

All license related logging has the topic logging. Filtered logs with regard to topic is described in Monitoring & Logging.

HTTP

The /licensing endpoint of the ew-manip service provides some information regarding the licensing status. Currently, the information provided includes:

• A timestamp for when the last license validity verification occurred
• Timestamp for when the next license validity verification will occur
• Whether the current license reference is considered valid or not. If this is false, and there is no active grace period, requests to the protected endpoints will fail
• If the license is valid, this endpoint will also show the expiry date of the license
• If currently in a grace period, or the grace period has ended, a timestamp of when the grace period end is provided