Overview
Portainer is an open-source web application that allows easy management of local Docker containers running on the host server. It operates as a web server application accessed from a web browser, providing a convenient user interface.
It is possible to maintain containers using the command-line interface, but this is often a difficult and complicated task. Portainer abstracts away this complexity to provide an easy-to-use management tool allowing individual control for containers such as start, stop, pause, enable, disable, and delete.
Containers are the fundamental software component of Infinity VIP and provide the feature licensing, matrix-free audio routing functionality, virtual panels, interfaces to third-party systems, and other Telos Alliance products.
Portainer is loaded and executed as part of the Infinity VIP boot sequence and sets up a TCP/IP socket listening to port 9000 on both NET-1 (AoIP) and NET-2 (WAN). This allows local browser access from the Infinity VIP or externally on either the AoIP or the WAN networks.
Portainer is set to automatically start at the end of boot-up as this reduces the possibility of any IP address conflicts until the configuration is complete. When the system has been configured for the first time, each container application can be set to automatically run so that Infinity VIP can start without further configuration.
Setting a Password for Portainer
Before Portainer can be used, the admin password must be set. On first login, you will be prompted to create your own password as shown below.
Figure 1 - Setting the admin password for Portainer
Navigate to the Maintenance section in the Telos VIP Setup tool.
Figure 2 - Maintenance section
Select "Reset Portainer Password" to reset a forgotten Portainer password
Figure 3- Resetting the Portainer password
Select "Yes" when asked if you wish to auto-generate a new Portainer password.
Figure 4- Setting the Portainer password
A new, randomly generated password will be created. Be sure to record the password as it will be needed later to log in to Portainer. Use the new password to log in. A password of your choosing may be set from within Portainer.
Figure 5- Portainer password generator
Maintenance
This section includes common maintenance tasks, including:
1 - Update License Server: The license server is responsible for displaying your available licenses at <YourIP/license>, and is infrequently updated.
2 - Update VIP Setup Tools: Includes the entire menu system as presented when you log in locally or via ssh. If you are instructed to download a beta version, enter the information here.
3 - Update Portainer: Updates the Portainer container.
4 - Reset Portainer Password: Resets to an auto-generated password.
5- Factory Reset: Erases all configurations on the system including Docker networks, all containers, and Dashboard setup (including partylines, groups, IFBs, scenes, and more).
6- Reboot System
7 - Poweroff System
8 - External License Server - Uses an external license server instead of adding licenses to this machine.
0 - Return to Main Menu.
Figure 6 - Maintenance menu
Service Control
This section is used to enable and disable the services needed for access and control.
Figure 7 - Service control menu
Available services include:
SSH - Secure Shell Protocol. This is a cryptographic network protocol for operating network services securely over an unsecured network.
Telos Connect - A proprietary control method developed by Telos that does not require opening additional public ports for external access, though internet access is required.
Figure 7 - SSH and Telos Connect services
Accessing Portainer
To access the Portainer from anywhere on the AoIP or WAN networks, open a web browser and enter the Infinity VIP IP address followed by 9000. For example, if the IP address of the Infinity VIP is “10.216.40.2”, enter “10.216.40.2:9000” in the address bar.
After entering the IP address in the browser, log in to Portainer with the user name "admin" and the random eight-character password referenced above.
On the first login of a new installation, select "Get Started" to continue.
Figure 8 - Portainer log in
Once logged in, select the local group.
Figure 9 - Portainer local group
The local group contains all the containers needed to run Infinity VIP. The images and containers can be found by clicking on the “local” keyword highlighted above.
To access updated images, access to the Quay repository is required. Information on Quay can be found here.
Container IP Address
Each container requires a unique IP address so that it can communicate with devices within the host server as well as other devices on the network such as panels, other Telos products, and other AoIP products and services.
From the Portainer home window, click on “local”, then click on “container” to open the Infinity Dashboard application.
Figure 10- Container IP address
Note that the Infinity Dashboard application in this example is not running. Click on the “Dashboard” name, then click on "Duplicate/Edit".
Figure 11 - Container details
Enter the following information into the Name, Registry, and Image fields:
Figure 12 - Portainer name and registry fields
The advanced container settings will appear. Click on the “Network” tab to change IP addresses, network, and domain names.
Figure 13 - Advanced container settings
Use the "Deploy the container" button when finished. Connect to the Dashboard container using <DashboardContainerIP>:5000.