Add a Custom Domain Name

Yeastar Central Management allows you to customize the domain name of P-Series Cloud PBX, so as to establish your own brand of Cloud PBXs. This topic describes how to add a custom domain name.

Requirements and Restrictions

Requirements
  • Subscribe either Custom Domain service or White Label service.
Restrictions
  • You can add only one custom domain name in each region.
  • The custom domain name can be configured only ONCE, and cannot be changed after it's successfully deployed.

Procedure

To add a custom domain name, you need to deploy two wildcard domain names on Yeastar Central Management, including a PBX wildcard domain name and a SBC Proxy Server domain name.

Note:
  • The PBX wildcard domain name, namely the custom domain name you are about to add, will be used as the suffix of a Cloud PBX URL. The domain name should be resolved to the IP address of the back-end SBC server.
  • The domain name of SBC Proxy Server, which is associated with the PBX wildcard domain name, will be used to compose the server address for specific PBX features, including Register Trunk, Port-Based Peer Trunk, DID-Based Peer Trunk, LDAP, SSH, AMI, and Database Grant.
  1. Obtain Server IP addresses and domain names.

    On Yeastar Central Management, query the server IP addresses in the desired region, and obtain the associated SBC Proxy Server domain name using your custom domain name. The information will be required when you purchase domain names and certificates.

  2. Purchase domain names and certificates.

    Purchase the domain names and the corresponding wildcard SSL certificates.

  3. Deploy domain certificates.

    On Yeastar Central Management, upload the SSL certificates and private keys to deploy the domain certificate.

Obtain Server IP addresses and domain names

  1. Log in to Yeastar Central Management, go to Cloud PBX > Custom Domain.
  2. In the Region drop-down list, select the region where you want to add a custom domain name.

    The SBC IP Address and SBC Proxy IP Address fields display the IP addresses of the servers in the selected region.

  3. Click to copy the IP addresses of SBC Server and SBC Proxy Server.
  4. Obtain the SBC Proxy Server domain name, which is associated with the custom domain name.
    1. In the PBX Wildcard Domain field, enter your custom domain name. In this example, enter *.customdomain.com.

      SBC Proxy Domain displays the SBC Proxy Server domain name accordingly.

    2. Note down the SBC Proxy Server domain name.

Purchase domain names and certificates

  1. Purchase and configure domain names on a domain registrar.
    1. Purchase the wildcard domain names.

      In this example, purchase the wildcard domain name *.customdomain.com and *.proxy1.customdomain.com.

    2. Set up domain forwarding to resolve the domain names to the corresponding server IP addresses.
      In this example, set up the following domain forwarding:
      • Forward PBX wildcard domain name *.customdomain.com to SBC IP address 123.123.123.123.
      • Forward SBC Proxy domain name *.proxy1.customdomain.com to SBC Proxy IP address 124.124.124.124.
  2. Purchase and download SSL certificates from Certified Authority (CA).
    1. Purchase wildcard SSL certificates for the domain names.

      In this example, purchase wildcard SSL certificates for the domain name *.customdomain.com and *.proxy1.customdomain.com.

    2. Download the wildcard SSL certificates and private keys.
      Note:
      • Yeastar P-Series Cloud PBX uses NGINX as web server, so the downloaded SSL certificates should be compatible with NGINX server.
      • RSA private key and EC private key are supported to secure the custom domain.

Deploy domain certificates

  1. Log in to Yeastar Central Management, go to Cloud PBX > Custom Domain.
  2. In the Custom Domain section, enter the domain name information.

    1. In the Region drop-down list, select the region where you want to add a custom domain name.
    2. In the PBX Wildcard Domain field, enter your custom domain name.

      The SBC Proxy Server domain name is automatically filled in SBC Proxy Domain field.

  3. In the Domain Certificate section, upload the SSL certificates for the wildcard domain names.
    1. In the Operations column, click .
    2. In the pop-up window, do as follows:

      1. Fill in certificate information.
        • Certificate Name: Specify a name to help you identify the certificate.
        • Certificate File: Click Browse to select the certificate file in the format of .cer, .crt, or .pem.
          Important: The certificate file must include a COMPLETE Certificate Chain, including the Root CA Certificate, the Intermediate Certificate, and the Server Domain Certificate.
          Note: If you have received the certificate files separately from a Certified Authority (CA), you will need to manually merge the certificates into a bundle file, then paste or upload the complete certificate chain into the Certificate File field. Make sure that you merge the certificates in a specific order from top to bottom: Server Domain Certificate > Intermediate Certificate (if any) > Root CA Certificate. There should be no blank lines between the blocks.

          The figure below shows a merged certificate chain.

        • Certificate Private Key: Click Browse to select the private key in the format of .key.
          Note: The supported content formats are as follows:
          • Start with -----BEGIN RSA PRIVATE KEY----- and end with -----END RSA PRIVATE KEY-----.
          • Start with -----BEGIN PRIVATE KEY----- and end with -----END PRIVATE KEY-----.
          • Start with -----BEGIN EC PRIVATE KEY----- and end with -----END EC PRIVATE KEY-----.
      2. Click Confirm.

        The uploaded certificate is displayed in the list with a status of Not Deployed.

  4. Click Save.

Result

  • The Certificate Status displays Deployed, indicating that the custom domain name is added successfully.

  • In the Custom Domain section, a label 'Custom' appears beside the region, indicating that there exists a custom domain name in the region; the PBX Wildcard Domain field becomes uneditable.

What to do next

Now you can create Cloud PBXs with your custom domain in the region.

When creating a P-Series Cloud PBX in the region on Cloud PBX > PBX, you can see and select the custom domain name in the suffix of URL.

Note: For your resellers in the region, they can only see and use your custom domain name to create Cloud PBXs.