VIP Beacon and Invitation Server
Last updated
Last updated
The Beacon server is a container in the VIP suite and facilitates many aspects of remote audio and connection discovery and negotiation using the popular WebRTC codecs.
The first login will require some setup from a site administrator.
The fields shown below in Figure 2 must be filled out, and the information entered will serve as the main Beacon administrator account login.
Once the correct information has been entered, click "Save," then log in with your newly-created account details.
Once logged in, the main Beacon landing page will appear which allows management of e-mail servers, VIP Invites, and more.
All panel invites will be displayed in the middle of the "Invites" section. Note that in the example below in Figure 5, there are no existing invites; the VIP (0) referenced refers to the Vipserver container.
There are two types of user roles available:
Admin - Has permission to change settings and manage users.
User - Has permission to access invitations.
The Settings section is at the heart of the Beacon server's purpose: Sending e-mail invites and finding the best network route for audio connections.
STUN is used for many underlying protocols including WebRTC. It provides a tool for hosts to discover a network address translator, and to discover the mapped IP address and port numbers the NAT has allocated between remote hosts.
You may provide your own STUN server address or use one of the many free STUN services available, such as the one from Google included in the container.
A TURN server is used to relay WebRTC data in the event STUN connections fail. In order for most WebRTC applications to function, a server is required for relaying the traffic between peers since a direct socket is often not possible between the clients (unless they reside on the same local network).
TURN servers require bandwidth to relay audio data between VIP clients and VIP hosted servers, either on-prem or cloud-provided. As a result, their services are typically not free.
For geographically diverse clients, it is recommended to specify several TURN servers as doing so greatly reduces the risk of "trombone routing" which can add significant latency.
In order for the Beacon server to send invites, it needs access to an account from which to send e-mails. Several different e-mail protocols are supported:
SMTP - Simple Mail Transfer Protocol, perhaps the most commonly used protocol.
Mailjet - A cloud-based e-mail delivery and tracking system which allows users to send marketing and transactional e-mails.
Mailgun - An API-based e-mail delivery service for sending, receiving, and tracking e-mails.
Sendgrid - A communication platform for marketing and transactional e-mail.
Once all e-mail credentials have been entered, click on the "Save App Setup" button, then send a test e-mail to yourself. If everything is correct, you will see two successful notifications in the bottom right corner as shown below in Figure 10.
Public URL - This is the public web address of the Beacon server, and is populated with the URL entered from the "#3 Set VIP Domain Name" field of the main VIP menu. If this field is empty in the main VIP menu, run Option #3 from the main menu again.
Public URL Override - This option can be used for systems employing a custom proxy of the Web URLs but is not used in a typical setup and can be left empty.
Invite Password Length - Determines the length of the randomly-generated password required to join the invite; zero-length passwords are permitted.
