Configure Connection Information

If you want to connect the Onsite Proxy to Yeastar P-Series Software Edition for the first time after skipping the configuration wizard during installation, or if you need to establish a new connection, you can configure the connection information on the Onsite Proxy.

Prerequisites

  • 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).

Procedure

Step 1. Configure Onsite Proxy
  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 onsite-proxy-configure.

    The Onsite Proxy Configuration Wizard prompt window pops up.

  4. In the pop-up prompt window, press Enter.

  5. Configure connection information as follows:
    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.

Step 2. Restart proxy service
  1. Run systemctl restart proxycore.service to restart tunnel forwarding service.
  2. Run systemctl restart proxycron.service to restart tunnel status reporting service.

Result

The Onsite Proxy is successfully connected to the PBX. You can check the connection status using one of following methods:
  • On Onsite Proxy host, run onsiteproxy-cli status. For more information, see Query client status.
  • On the PBX web portal, check the connection status on System > Onsite Proxy.
    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%.