Unwired On-board Media Portal specs

Introduction

This document describes the functionality a media portal has to provide so it can interoperate with the Unwired On-board Portal.

Overview

The Unwired On-board Portal will intercept client DNS requests for certain domains provided by the media portal and craft a response directing the client to the media portal.
There are three requirements for this to work:

1. A DHCP server needs to configure the LAN/client network interface of the Unwired On-board Portal.

2. The first router IP of the DHCP response must be the IP of the media portal.

3. The media portal needs to provide a list of domains to intercept to the Unwired On-board Portal.

DHCP configuration

If this feature is enabled in the Unwired On-board Portal Container, it will use a separate network interface for communicating with the media portal.

On that network, there needs to be a DHCP server which both:

• assigns an IP to the Unwired On-board Portal in the 192.168.254.0/24 subnet

• informs the Unwired On-board Portal of the media portal’s IP by setting it as the first entry in the routers option (see RFC 2132 for details)

Domain configuration

Once the Unwired On-boar Portal knows the media portal’s IP address, it will fetch the domains to intercept from http://<media_portal_ip>:80/api/v1/dns_redirect
Note that it is an HTTP, not an HTTPS endpoint.
The Unwired On-board Portal expects a JSON response with the following fields:

{  
  "version": 1,  
  "domains": [  
    "first.domain",  
    "second.example"  
  ]  
}

The response should arrive within 3 seconds.
After the Unwired On-board Portal receives such a response, it will intercept DNS requests to any of the listed domains and craft a DNS response directing the requesting client to the media portal IP with a TTL of 300.

Content revisions

Revision	Published date	Changes
1.0	2022-10-27	initial v1 release
1.1	2025-01-27	adjust wording and release on docs.unwirednetworks.com