Install Yeastar Central Management System using Deployment Tool

This topic describes how to use the Yeastar Deployment Tool to install the complete Yeastar Central Management system, including the YCM server and all cluster servers, in your architecture.

Requirements and Restriction

Requirements
  • Your computer runs the Windows operating system, as the tools are .exe applications.
  • Your system has a Basic deployment architecture (i.e., no High Availability (HA) configured).
  • The firmware version of the YCM server is 87.19.0.27 or later to ensure the operations can be performed successfully using the tools.
Restrictions
The Deployment Tool has the following restrictions:
  • Installation in environments with dual-network card configuration is not supported.
  • The Yeastar TA gateway remote management (MGT) service configuration during installation is not supported.

Prerequisites

Item Prerequisites
Server
  • Prepare the required deployment environment for the core components in the system, including YCM Server, SBC Server, SBC Proxy Server, and PBXHub Server.
  • Ensure that the SSH port 1022 is open on all the servers.
  • Collect the following server information that needs to be entered in the Deployment Tool:
    • YCM Server: Public IP address, private IP address, and a single domain name.
    • SBC Server/SBC Proxy Server: Public IP address, private IP address, and the wildcard domain names.
    • PBXHub Server: Private IP address and the mount path of the additional mounted data disks (for Cloud PBX data and recordings storage).
      Tip: You can SSH to the PBXHub Server and run the lsblk command to view the data disk mount path.
SSH Account On all servers, create an SSH account yeastar that meets the following requirements:
  • Set an SSH login password.
  • Grant passwordless sudo privileges (NOPASSWD) so it can execute commands requiring root privileges without entering a password.
Resources
  • Purchase the required BYOI resource package from Yeastar, and obtain the product serial number and activation code.
  • Contact Yeastar to obtain the following resources:
    • The Deployment Tool
    • The installation package download URL of the required servers

Procedure

  1. On your computer, install and launch the Yeastar Deployment Tool.
  2. Log in with the default credentials.

    • Username: admin
    • Password: admin123
  3. Follow the on-screen steps to complete the installation.
    Step 1: Server & Domain Configuration
    Enter the server information you've collected, and validate the server connectivity.
    1. Enter the required server information.
      Note:
      • For wildcard domains, replace the wildcard * with 11. For example, if the domain is *.sbc.example.com, enter 11.sbc.example.com.
      • When entering an IP address or domain name, make sure there are NO extra spaces, otherwise connection failures may occur.
    2. Click the corresponding buttons in each section to validate the configurations.

      • Verify DNS: Check whether the domain name can be resolved to the server's public IP.
      • Test SSH Connections: Check whether the tool can connect to the server using the SSH credentials.
      Tip: You can also click Test All Connections and Verify All DNS at the bottom of the page to validate all servers at once.
    3. Click Next to proceed.
    Step 2: Pre-Check
    Run a pre-check to verify whether the servers meet the installation requirements.
    1. At the top-right corner of the page, click Run All Checks.

      Wait for the check to complete. When an "All Passed" message is displayed, the environment pre-check has succeeded.

      Tip: You can click Details for any item to view the raw data.

    2. Click Next to proceed.
    Step 3. Port Connectivity Check
    Verify the accessibility of required ports. The tool performs random checks on the port connectivity.
    1. At the top-right corner, click Run All Checks.

      The tool checks the port connectivity randomly. When an "All Reachable" message is displayed, the checked ports are accessible.

      Tip:
      • You can click Show Details to view the specific ports that were checked.

      • If any ports do not pass the check, verify the firewall rules on the corresponding servers. After confirming the ports are open, proceed to the next step.
    2. Click Next to proceed.
    Step 4: Download Packages
    Download and extract the installation packages for YCM Server, SBC Server / SBC Proxy Server, and PBXHub Server.
    1. In the Package URL field, paste the installation package download URL for the following servers:
      • YCM Server
      • SBC Server / SBC Proxy Server
      • PBXHub Server

    2. At the bottom of the page, click Start Download.

      The tool begins downloading the packages. Wait a few minutes until the tool displays a "Downloaded" message for each server.

    3. Click Start Extract to extract the downloaded package.

    4. Click Next to proceed.
    Step 5: License Information
    Configure the license, environment mode, and region identification for the Yeastar Central Management system.
    1. Configure the license settings:

      Setting Description
      Serial Number Paste the product serial number (SN) of your purchased BYOI package.
      Activation Code Paste the activation code of your purchased BYOI package.
      Environment Mode

      Select byoi-prod (Production Environment).
    2. In the Region Information section, configure the basic identification information for the cluster region.

      Setting Description
      Country Specify the country where the Yeastar Central Management system is located.
      Country Code Enter the corresponding country code.
      Customer Name Enter the customer name.

      The system combines this with the country and country code to generate the region name and cluster server information.

      For example:
      Network Mode Select the corresponding network mode based on your system environment:
      • Intranet Mode: The system is deployed on the internal network, and the network has been configured with NAT Loopback (port forwarding) to support access from the internal network via a public domain name or IP address.
      • Internet Mode: The system is directly accessible from the public network.
    3. Click Next to proceed.
    Step 6: Render CM Config Template
    Populate the specific configuration settings into the server configuration templates and deploy them to the YCM server.
    1. At the bottom of the page, click Deploy Config Files.

      The generated complete configuration files are deployed to the YCM server.

    2. Click Next to proceed.
    Step 7: CM Install
    Install the YCM server.
    1. At the bottom of the page, click Start CM Installation.

      Wait until the installation completes and the interface displays "CM Installation Succeeded".

    2. Click Next to proceed.
    Step 8: Validation
    Validate the service status on the YCM server after installation.
    1. Click Start Validation.

      The tool starts to validate the service status on the YCM server, and displays the result.

    2. Click Next to proceed.
    Step 9: CM Render Cluster Config
    Obtain the authentication code, then render and deploy the cluster configuration to the cluster servers.
    1. Click Auth Code to obtain the authentication code from the YCM Server.

    2. Click Render Config Files.

      The tool populates the specific configuration settings into the configuration templates of the cluster servers and generates the complete configuration files.
    3. Click Deploy Config Files.

      The generated complete configuration files are deployed to the cluster servers.

    4. Click Next to proceed.
    Step 10: Cluster Installation
    Install the cluster servers, including SBC Server, SBC Proxy Server, and PBXHub Server.
    Important: Do NOT navigate away from this page until the installation is fully completed.
    1. Click Install All on each server to start the installation.
      Note:

      • The installation for the three servers run independently. You can execute any step on any server individually, or start the installation on multiple servers simultaneously.

      • If the PBXHub Server installation is interrupted and needs to be restarted, you need to reset the data disk of PBXHub (under the server list) to clear its data disk before reinstalling.

    2. Optional: Export the installation logs for troubleshooting purposes.

    3. Click Next to proceed.
    Step 11: Server Reboot
    Reboot the servers in the required sequence to complete the installation.
    1. Reboot the cluster servers.
      1. Click Staged Reboot.

      2. Click OK in the pop-up window.

      The tool automatically initiates rebooting on the cluster servers in the required sequence.

    2. Reboot the YCM Serer.
      1. Select the checkbox of YCM Server in the server list, then click Reboot Selected Servers.

      2. Click OK in the pop-up window.
      All servers are rebooted successfully, with a Rebooted label displayed.

    3. Click Next to proceed.
    Step 12: Cluster Validation
    Perform post-installation validation and configuration for the system.
    1. In the Modify Customer Account Password section, set the login credentials for the Yeastar Central Management portal.
      1. Enter the email and password that will be used to log in to the web portal.

        • Customer Email: Enter the email address.
        • New Password: Set a password.
      2. Click Update Account Password.
    2. Optional: In the Modify Cluster Status section, update cluster identification information if needed.
      1. Modify the desired information.

        Setting Description
        Installation Count Tracks the number of installations. Keep the setting as 1 for a new system installation.
        Region Name The name of the cluster region.
        Region Key A unique identifier for the region.
      2. Click Update Cluster Status.
    3. In the Check All Server Information section, verify the health and status of all servers.
      1. Click Start Checking All Servers.

        The tool validates running processes, port status, database connectivity, and other system information on all servers.

      2. Review the results to ensure all checks have passed.

    4. Optional: In the Export Installation Information section, click Export Installation Info to export installation data for troubleshooting or record-keeping.

Result

The system installation is complete. You can log in to the Yeastar Central Management web portal using the YCM domain name and the credentials you configured.

What to do next

After completing the installation, it is recommended to perform the following configurations on Yeastar Central Management web portal to enable full functionality:

  1. Configure domain certificates for secure HTTP access.

    Upload domain certificates (if available) or directly apply for certificates on the web portal (Path: System > Domains > Cluster Domain Name/Yeastar Central Management Domain Name).
    • SBC Server / SBC Proxy Server: Upload or apply for the corresponding wildcard domain certificates, e.g., *.sbc.example.com and *.proxy1.sbc.example.com.
    • YCM Server: Upload or apply for a single domain certificate for YCM (e.g., cm.yourcompany.com) and a wildcard domain certificate for remote management (e.g., *.cm.yourcompany.com).

    For more information, see Management Guide - Domain Management.

  2. Configure email server to enable system email notifications.

    Set up the email server on the web portal (Path: System > Email Server).

    For more information, see Management Guide - Email Server Overview.

  3. Verify system functionality.

    Create a cloud PBX on the web portal (Path: Cloud PBX > PBX), then log in to the PBX to create extensions test internal calls between extensions to verify that the call functionality is working properly.

    For more information, see Management Guide - Create a P-Series Cloud PBX.