Skip to content

Configure Connection Information

Use this procedure to point the Onsite Proxy at your Cloud Voice PBX (Private Branch Exchange, the hosted phone system). It applies whenever you need to establish a fresh link, including the first connection after you skipped the setup wizard while installing the proxy. The connection details are entered through a terminal-based wizard that runs directly on the proxy host.

Before you begin, add an Onsite Proxy instance on your Cloud Voice PBX so that the PBX generates the credentials this wizard needs: the connection address, UUID (Universally Unique Identifier, the unique ID for this proxy instance), and secret key. You can view them in the PBX portal at System > Onsite Proxy > Edit > Connection information.

Step 1. Run the configuration wizard on the Onsite Proxy

Section titled “Step 1. Run the configuration wizard on the Onsite Proxy”
  1. Open a terminal session on the Onsite Proxy host.

  2. Switch to the root account:

    Terminal window
    sudo -i
  3. Launch the wizard:

    Terminal window
    onsite-proxy-configure

    The Onsite Proxy Configuration Wizard opens in a prompt window.

  4. Press Enter at the opening prompt to start.

    Terminal prompt window that starts the Onsite Proxy configuration wizard

  5. Work through each connection setting in turn, using the values you copied from the PBX.

    PBX connection address

    1. In the Configure PBX Connection Address window, paste the connection address you obtained from the PBX, then select <Ok> and press Enter.

      Field for pasting the PBX connection address into the proxy wizard

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

      Confirmation dialog for the entered PBX connection address

    UUID

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

      Field for pasting the proxy instance UUID into the wizard

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

      Confirmation dialog for the entered UUID

    Secret key

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

      Field for pasting the secret key into the wizard

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

      Confirmation dialog for the entered secret key

    PBX external web server port

    1. In the Configure PBX External Web Server Port window, select <Ok> and press Enter.

      Wizard window showing the PBX external web server port

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

      Confirmation dialog for the external web server port

    PBX external tunnel port

    1. In the Configure PBX External Tunnel Port window, select <Ok> and press Enter.

      Wizard window showing the PBX external tunnel port

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

      Confirmation dialog for the external tunnel port

    Local IP

    1. In the Select Local IP window, choose the static IP (Internet Protocol) address assigned to the host.

      List of available network interfaces for selecting the local IP

    2. Select <Ok> and press Enter.

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

      Confirmation dialog for the selected local IP address

  6. Review everything in the Configuration Summary window. When the details are correct, select <Yes> and press Enter.

    Summary window listing all entered connection settings

  7. At the Verification Successful prompt, press Enter.

    Prompt confirming that the connection details verified successfully

  8. At the Configuration Complete prompt, press Enter.

    Prompt confirming that configuration is complete

Apply the new configuration by restarting both services:

  1. Restart the tunnel forwarding service:

    Terminal window
    systemctl restart proxycore.service
  2. Restart the tunnel status reporting service:

    Terminal window
    systemctl restart proxycron.service

The Onsite Proxy is now connected to your Cloud Voice PBX. Confirm the link in either of these ways:

  • On the Onsite Proxy host, run onsiteproxy-cli status. For details on reading the output, see Query client status.

  • In the PBX portal, review the status under System > Onsite Proxy.

    PBX portal showing an Onsite Proxy instance in a connected state