Install Onsite Proxy

The Onsite Proxy runs on a host that shares a subnet (the same local network segment) with your IP phones and relays their call signaling to your Cloud Voice PBX (Private Branch Exchange, the system that routes your phone calls). This page walks through installing the proxy and connecting it to the PBX, using Ubuntu as the example. The same steps apply to every supported operating system.

Before you begin

On the PBX

Make sure you have already added an Onsite Proxy instance on your Cloud Voice PBX and have its connection credentials on hand: the connection address, UUID (Universally Unique Identifier, the unique ID for this proxy), and secret key. You will find them under System > Onsite Proxy > Edit > Connection information.

Tip

To be sure the secret key hasn’t already been claimed by another connection, refresh it first and copy the new value.

On the proxy host

Confirm the host meets the following before you install.

Item	Requirement
Network	The host sits on the same subnet as the IP phones, and that subnet can reach the PBX server.
Operating system	The host runs a supported operating system.
Hardware	The host meets the minimum specifications.
Ports	UDP (User Datagram Protocol) port 5060 is free on the host. This is the standard port the proxy uses for SIP (Session Initiation Protocol) call signaling.
IP address	The host has a static IP address assigned.

Caution

If another service on the host is already using UDP port 5060, the proxy cannot claim it and the connection will not work. Confirm the port is free before you install.

Step 1: Download and unpack the installation package

1. Open a command line on the proxy host.

2. Switch to the root user:

   sudo -i

   Note

   If prompted for a password, enter the current user’s password and press Enter.

3. Download the latest installation package into a directory of your choice. Use the command that matches the host’s CPU architecture, replacing <desired_directory> with the path where you want the file saved.

   For an x86_64 host:

   wget <package-url>/onsiteproxy-x86_64.tar.gz -O <desired_directory>/onsiteproxy.tar.gz

   For an ARM64 host:

   wget <package-url>/onsiteproxy-aarch64.tar.gz -O <desired_directory>/onsiteproxy.tar.gz

   For example, to save the x86_64 package to the desktop:

   wget <package-url>/onsiteproxy-x86_64.tar.gz -O /home/user/Desktop/onsiteproxy.tar.gz

4. Extract the package to the root directory, replacing <your_package_path> with the actual path to the file you downloaded:

   tar -xzf <your_package_path>/onsiteproxy.tar.gz -C /

   Following the example above:

   tar -xzf /home/user/Desktop/onsiteproxy.tar.gz -C /

Step 2: Install the proxy and connect it to the PBX

1. Start the installer:

   onsite-proxy-install

2. In the Onsite Proxy Installation window, review the proxy version and operating system details, then select Yes and press Enter. Give it about a minute for the requirements prompt to appear.

   

3. At the Important Requirements prompt, press Enter.

   

4. At the Onsite Proxy Configuration Wizard prompt, press Enter to begin configuration.

   

5. Work through the wizard, supplying each value when its window appears. Paste the credentials you copied from the PBX exactly, and confirm your entry on the follow-up window for each setting.

   Note

   You can skip the wizard now and set up the connection later if you prefer. To skip, choose <Cancel> in any of the configuration windows, then select No in the Configuration Failed window.

   

   a. PBX connection address: In the Configure PBX Connection Address window, paste the connection address from the PBX, select <Ok>, and press Enter.

   

   In the Confirm Connection Address window, select <Yes> and press Enter.

   

   b. UUID: In the Configure UUID window, paste the UUID from the PBX, select <Ok>, and press Enter.

   

   In the Confirm UUID window, select <Yes> and press Enter.

   

   c. Secret key: In the Configure Secret Key window, paste the secret key from the PBX, select <Ok>, and press Enter.

   

   In the Confirm Secret Key window, select <Yes> and press Enter.

   

   d. PBX external web server port: In the Configure PBX External Web Server Port window, select <Ok> and press Enter.

   

   In the Confirm PBX External Web Server Port window, select <Yes> and press Enter.

   

   e. PBX external tunnel port: In the Configure PBX External Tunnel Port window, select <Ok> and press Enter.

   

   In the Confirm PBX External Tunnel Port window, select <Yes> and press Enter.

   

   f. Local IP: In the Select Local IP window, choose the static IP address assigned to the host, select <Ok>, and press Enter.

   

   Note

   If the address you want isn’t in the Available network interfaces list, select manual, press Enter, and type the IP address yourself.

   

   In the Confirm Local IP window, select <Yes> and press Enter.

   

6. In the Configuration Summary window, check that every value is correct, then select <Yes> and press Enter.

   

7. At the Verification Successful prompt, press Enter.

   

8. At the Configuration Complete prompt, press Enter.

   

9. At the Installation Complete prompt, press Enter.

   

Result

The Onsite Proxy is installed and connected to the PBX.

Note

The proxy starts automatically on boot and reconnects to the PBX on its own once network connectivity is restored.

On the PBX, the Onsite Proxy instance now shows a connected status along with the proxy’s details, such as its version, internal IP address, and public IP address.

Note

If the connection drops, or if the proxy’s resource usage crosses any of the thresholds below, the PBX sends the Onsite Proxy event notification to your designated contacts:

• CPU usage above 85%
• Memory usage above 85%
• Disk usage above 95%