Install Onsite Proxy

This topic takes Ubuntu operating system as example to introduce how to install Onsite Proxy on a host in the same subnet as the remote IP phones, and connect it to the Yeastar P-Series Software Edition during installation.

Note: The procedure applies to all supported operating systems.

Prerequisites

PBX server
  • You have added an Onsite Proxy instance on Yeastar PBX.
  • You have obtained connection information from the PBX.
    • Obtain connection credentials (connection address, UUID, secret key) (Path: System > Onsite Proxy > Edit > Connection information).
      Note: To avoid the Secret Key being used, it is recommended refresh it and copy the new one.

    • Obtain external ports (External Web Server Port and External Tunnel Port) (Path: System > Network > Public IP and Port > Public Ports).

  • HTTPS protocol is enabled on the PBX (Path: System > Network > Web Server > Protocol > Protocol).

Onsite Proxy host
Item Prerequisite
Network The host must reside in the same subnet as the remote IP phones, and there is network connectivity between the subnet and the PBX server.
Operating system The host is deployed with required operating system.
Hardware The host meeting the minimum specifications.
Port forwarding UDP port 5060 on the host is available.
IP address The host have been assigned a static IP address.

Procedure

Step 1. Download and unzip the Onsite Proxy installation package to the host
  1. Access the command line on the Onsite Proxy host.
  2. Run sudo -i to switch to the root user.
    Note: If a password is required, enter your current user's password and press Enter.
  3. Run the following command to download the latest Onsite Proxy installation package to the desired directory.
    Note: Replace <desired_directory> in the following command with the directory path where you want to download the package to.
    Architecture Command
    x86_64 wget https://help.yeastar.com/download/docs/onsite-proxy/onsiteproxy-x86_64.tar.gz -O <desired_directory>/onsiteproxy.tar.gz
    ARM64 wget https://help.yeastar.com/download/docs/onsite-proxy/onsiteproxy-aarch64.tar.gz -O <desired_directory>/onsiteproxy.tar.gz

    In this example, run wget https://help.yeastar.com/download/docs/onsite-proxy/onsiteproxy-x86_64.tar.gz -O /home/user/Desktop/onsiteproxy.tar.gz to download the latest Onsite Proxy installation package to desktop directory.

  4. Run tar -xzf <your_package_path>/onsiteproxy.tar.gz -C / to unzip the package to the root directory.
    Note: Replace <your_package_path> with the actual path to your package.

    In this example, run tar -xzf /home/user/Desktop/onsiteproxy.tar.gz -C /.

Step 2. Install and configure Onsite Proxy to connect it to PBX
  1. Run onsite-proxy-install to initiate the installation.
  2. In the pop-up Onsite Proxy Installation window, conform the Onsite Proxy version and operating system details, and then select Yes and press Enter.

    Wait about one minute until a requirement prompt window pops up.

  3. In the Important Requirements prompt window, press Enter.

  4. In the Onsite Proxy Configuration Wizard prompt window, press Enter.

  5. Configure connection information as follows:
    Note: You can skip the wizard at this stage and complete the configuration after installation as needed.

    To skip configuration wizard, select <Cancel> in one of the following configuration windows, and select No in Configuration Failed window.

    Action Instruction
    Configure PBX connection address
    1. In the Configure PBX Connection Address window, do as follows:

      1. Paste the PBX connection address obtained from PBX.
      2. Select <Ok> and press Enter.
    2. In the Confirm Connection Address window, select <Yes> and press Enter.
    Configure UUID
    1. In the Configure UUID window, do as follows:

      1. Paste the UUID obtained from PBX.
      2. Select <Ok> and press Enter.
    2. In the Confirm UUID window, select <Yes> and press Enter.
    Configure secret key
    1. In the Configure Secret Key window, do as follows:

      1. Paste the secret key obtained from PBX.
      2. Select <Ok> and press Enter.
    2. In the Confirm Secret Key window, select <Yes> and press Enter.
    Configure PBX external web server port
    1. In the Configure PBX External Web Server Port window, do as follows:

      1. Paste the external web server port obtained from PBX.
      2. Select <Ok> and press Enter.
    2. In the Confirm PBX External Web Server Port window, select <Yes> and press Enter.
    Configure PBX external tunnel port
    1. In the Configure PBX External Tunnel Port window, do as follows:

      1. Paste the external tunnel port obtained from PBX.
      2. Select <Ok> and press Enter.
    2. In the Confirm PBX External Tunnel Port window, select <Yes> and press Enter.
    Select local IP
    1. In the Select Local IP window, do as follows:

      1. Select the static IP address assigned to the host.
        Note: If the desired IP address is not displayed in the Available network interfaces list, you need to select manual and press Enter to manually enter the IP address.

      2. Select <Ok> and press Enter.
    2. In the Confirm Local IP window, select <Yes> and press Enter.
  6. In the Configuration Summary window, confirm the configuration details, and then select <Yes> and press Enter.

  7. In the Verification Successful prompt window, press Enter.

  8. In the Configuration Complete prompt window, press Enter.

  9. In the Installation Complete prompt window, press Enter.

Result

  • The Onsite Proxy is successfully installed and connected to the PBX.
    Note: Onsite Proxy can automatically start on boot and reconnect to the PBX upon network restoration.
  • On the PBX, the Onsite Proxy instance displays a status along with the proxy's information, such as version, internal IP address, and public IP address.
    Note: Once the connection is interrupted, or when the system resource utilization for Onsite Proxy exceeds the any of following thresholds, the PBX sends a event notification Onsite Proxy to relevant contacts.
    • The CPU utilization exceeds 85%.
    • The memory utilization exceeds 85%.
    • The disk utilization exceeds 95%.