Customize Domain for NovoOne Portal

This topic describes how to add a custom domain for NovoOne portal.

Background information

You can customize domains for NovoOne portal for different regions to establish your own brand.

Note:
  • Each region supports up to one custom domain.
  • All custom domains across all regions configured by you and your colleagues are centrally displayed on the Domains list, while each domain is regionally isolated and operates independently.

After configuration, platform users (you, your colleagues, your resellers, and resellers' colleagues) and tenant users (within the tenants owned by you and your resellers in a specific region) can access NovoOne portal for the region via the associated custom domain (e.g., doc.sg.sample.com).

Tip: When platform users access the NovoOne Platform portal via a custom domain and switch from the current region to another, the region list displays only the regions configured with custom domains.

Requirements and restrictions

Requirements
You have subscribed to the White Label service. Each white label template includes one custom domain quota by default.
Note: You can check subscribed resource details at My Subscription.
Restrictions

Once the domain is successfully deployed, it cannot be changed. To deploy a new one, you must delete the previously configured domain and re-deploy the new one.

Procedure

Step 1. Obtain CNAME records on NovoOne Platform

On NovoOne Platform portal, pre-define the custom portal domain, the system automatically uses the portal domain to generate CNAME records (including host and target domains) for sub-services, such as API, SIP, account and ACME validation. The generated CNAME records will be required for domain resolution.
  1. Log in to NovoOne Platform portal, go to System > Domains.
  2. Click Add Domain.
  3. In the Domain Information section, fill in the basic information of custom portal domain.

    1. In the Region drop-down list, select the desired region.
    2. In the Domain field, enter a custom portal domain.

      In this example, enter doc.sg.sample.com. sample.com is the root domain.

      Note:
      • Wildcard domains (e.g. *.itsp.com) and IP address are not allowed.
      • Multi-level domains are supported, such as sample.com, sg.sample.com and doc.sg.sample.com.

      When the field loses focus, CNAME records auto-generated based on the selected region and portal domain are displayed in the DNS Configuration section.

  4. In the DNS Configuration section, hover over the host and target domains in the CNAME record list, then click to copy and note down them for later use.
    Tip: For host domains, the copy operation retrieves the subdomain portion for direct use in subsequent domain resolution. For example, the host domain is api.doc.sg.sample.com, only its subdomain portion api.doc.sg is copied for use.

    Leave this Add Domains page open before proceeding.

Step 2. Configure domain resolution on DNS server

Register the root domain and configure CNAME records for domain resolution.
  1. Register the root domain with a domain registrar.

    In this example, register sample.com.

  2. Add the CNAME records obtained from NovoOne Platform portal to your DNS server to point your host domains to the corresponding CNAME target domains.
    Note: For Host fields, your DNS provider will automatically append the root domain (sample.com). You only need to paste the raw data copied from NovoOne Platform portal into the field.

(Optional) Step 3. Prepare domain certificates

Purchase and download SSL certificates from Certified Authority (CA).
Note: NovoOne Platform provides automatic certificate issuance and renew via Let's Encrypt. If you want to quickly deploy domains without manual certificate handling, you can skip this step and proceed to Step 4.
  1. Purchase a wildcard SSL certificate to cover the domains.

    In this example, purchase a wildcard SSL certificate for *.doc.sg.sample.com, which secures all subdomains under doc.sg.sample.com.

  2. Download the wildcard SSL certificates and private key.
    Note:

    • NovoOne Platform 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.

Step 4. Check DNS resolution status on NovoOne Platform

Check DNS resolution status to confirm all CNAME records have taken effect.

  1. Back to Add Domains page on NovoOne Platform portal.

  2. In the DNS Configuration section, click Check DNS at the left-top corner of the CNAME record list.

    The status of each CNAME record displays Checking and switches to Resolved after approximately 3 seconds.

    Note: The status may display Not Resolved due to DNS propagation delays. You can click Check DNS later to re-run the detection.

    If the status remains Not Resolved, review the previous Step 2.

Step 5. Deploy domain certificates on NovoOne Platform

Deploy certificates for the domain names via either of the following methods according to your needs.
Automatic certificate deployment
  1. In the Certificate Configuration section, select Automatically issue certificate (Let's Encrypt) of Certificate Management.

  2. Click Save.
Manual certificate deployment
  1. In the Certificate Configuration section, select Use custom certificate of Certificate Management.

  2. In the Private Key field, fill in the PEM-encoded private key downloaded from Certified Authority (CA) in one of the following methods.
    Note:
    • The supported content formats are as follows:
      Format Description
      RSA Start with -----BEGIN RSA PRIVATE KEY----- and end with -----END RSA PRIVATE KEY-----.
      EC Start with -----BEGIN EC PRIVATE KEY----- and end with -----END EC PRIVATE KEY-----.
      PKCS#8 Start with -----BEGIN PRIVATE KEY----- and end with -----END PRIVATE KEY-----.
    • The content must not exceed 16 KB.
    • Copy the content of the private key and paste it in the field directly.
    • Click beside the field to upload the private key file with the .key extension.

      The content of uploaded private key is displayed in the Private Key field.

  3. In the Certificate field, fill in the PEM-encoded certificate obtained from the Certificate Authority (CA) in one of the following methods.
    Note:
    • The certificate must contain a COMPLETE Certificate Chain assembled in the following order: the Server Domain Certificate , followed by Intermediate Certificates, and ending with the Root CA Certificate.
    • The content must not exceed 32 KB.
    • Copy the content of the certificate and paste it in the field directly.
    • Click beside the field to upload the certificate file with a .cer, .crt, or .pem extension.

      The content of uploaded certificate is displayed in the Certificate field.

    The certificate information (status, authority and expiration date) is auto filled in the Certificate Information section.

  4. If you intend to manually apply and upload certificates by yourself before expiration, deselect the checkbox of Automatically renew certificate before expiration.
    Note: This setting is enabled by default. If enabled, the system will automatically issue and renew certificate via Let's Encrypt before expiration.
  5. Click Save.

Result

The custom domain for NovoOne portal is displayed on the Domains list with a certificate status of Deployed.
Note: If you use a custom certificate and disable automatic certificate renewal for the custom domain, the system sends‑out certificate‑expiry reminder emails to the email address of your NovoOne Platform account 30 days before expiry, 7 days before expiry, and on the expiry date. If required, update the certificate promptly.

What to do next

To customize portal appearance, customize tailor-fit branding options.