Deploy Homer Service using Deployment Tool

This topic describes how to install the Homer service on a server in your system architecture using the Yeastar-provided Deployment Tool.

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.

Prerequisites

Item Prerequisites
Server
  • Depending on your deployment needs, prepare the required deployment environment for the Homer service on either the YCM Server or a new dedicated server.
  • Ensure that the SSH port 1022 is open on the target server where you want to install the Homer service.
  • Obtain the public IP address of the target server.
SSH Account On the target server, 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
  • Contact Yeastar to obtain the following resources:
    • The Deployment Tool
    • The download URL of the Homer installation package
  • Prepare a valid SSL/TLS certificate for Homer service domain (if available).

Procedure

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

    • Username: admin
    • Password: admin123
  3. In the Deploy Mode section, select where you want to install the Homer service.

  4. In the YCM Server Config/New Server Config section, do as follows:

    1. Enter the server connection information:
      • Server IP: Enter the public IP address of the target server.
      • SSH Port: Enter 1022.
      • Username: Enter yeastar.
      • Password: Enter the SSH login password for the yeastar account.
    2. Optional: Click the Test Connection button to verify that the tool can connect to the target server using the provided information.

      The connection result is displayed on the interface.

  5. In the Package Config section, paste the download URL of the Homer installation package.

  6. Optional: In the Certificate Config section, configure a certificate for the Homer service.

    1. Select the checkbox of Use Custom SSL Certificate.
    2. Paste the contents of the cert.pem and key.pem files in the corresponding fields.
  7. Click Install Homer.

Result

The interface displays a message “Homer installed successfully”, indicating that the installation is finished.

What to do next

  • Verify the installation by clicking the Start Verification at the bottom of the tool.

    The interface shows the verification result, as well as the access URL of the Homer.

  • Access the Homer via either of the following methods:
    Direct access with credentials
    This method requires login credentials, so you need to update the default credentials first, then access Homer using the new credentials.
    1. Change the password for Homer login.

      1. At the bottom of the tool, click Set Password.
      2. In the New Password field, set a login password.
        Note: The password length must not exceed 32 characters.
      3. Click Set Password.

        The interface displays a message "Password set successfully".

    2. Log in to Homer.
      1. Launch a web browser and paste the Homer access URL into the address bar.

        You will enter the login page of Homer.

      2. Enter the default username admin and the new password to log in.

    Passwordless access via YCM
    This method requires you to associate Homer with Yeastar Central Management first. After that, you can conveniently access the Homer from the management portal in one-click without entering any credentials.
    1. Connect Homer to Yeastar Central Management
    2. Click the Manage Homer button (Path: System > Homer) to directly enter the Homer web interface.