Front-end and back-end deployment #

This article shows you how to deploy the Server and Client sides of Sonic.

Quick deploy #

In this mode, the front and back ends are deployed at one time.

preparatory work: docker-compose, Docker, MySQL

1. Create a MySQL database. The database name can be customized. Note that the character set is utf8 and the collation rule is utf8_general_ci. If you want MySQL to start with Sonic (not recommended), refer to the Built-in MySQL in docker-compose.yml section at the bottom of this page.
2. Click here Download the latest version of the zip file to any directory. (If the accelerator link fails, please go by yourself here download)
3. Unzip and change the information in.env. Do not modify docker-compose.yml file. For details about the env configuration item, see the following table. If your system does not display.env, see the solution at the bottom of the page under FAQs)
4. Run the following command in the current directory

docker-compose up -d

docker-compose -f docker-compose-zh.yml up -d

5. The front and rear ends are deployed!(Due to the Eureka heartbeat mechanism, it takes 3 to 5 minutes for microservices to access each other. Please wait patiently)Open a browser and visit http://localhost:3000，Then you can directly deploy the Agent。
6. (Attached) If you are experienced operation and maintenance personnel, you can also visit the Eureka page to check the status of each micro-service.

.env configuration item description #

Use your own Eureka #

If you have your own Eureka service, you can view this section.

1. Remove Eureka service from docker-compose.yml .
2. Replace SONIC_EUREKA_HOST to your own Eureka service from docker-compose.yml .
3. Replace your own Eureka service info form .env .
4. Done!

Built-in MySQL in docker-compose.yml（Not recommended） #

Because MySQL is prone to data loss due to improper operation or data migration risks during Docker mounting, so docker-compose.yml does not come with a MySQL image by default.

If you want MySQL to start with sonic, you can do the following:

1. Create the mysql folder in the current directory

mkdir -p mysql/log mysql/data mysql/conf

2. Change MYSQL_HOST in .env to sonic-mysql
3. Add the following comment section to docker-compose.yml

version: '3'
services:
  sonic-server-eureka:
  .
  .
  .
  .
  .
  sonic-client-web:
    image: "sonicorg/sonic-client-web:SONIC_VERSION"
    environment:
      - SONIC_SERVER_HOST
      - SONIC_SERVER_PORT
    networks:
      - sonic-network
    depends_on:
      - sonic-server-gateway
    restart: on-failure
    ports:
      - "${SONIC_SERVER_PORT}:80"
# ==== MySQL ====
  sonic-mysql:
    image: "mysql:5.7"
    hostname: sonic-mysql
    command: mysqld --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
    environment:
      - MYSQL_ROOT_PASSWORD=${MYSQL_PASSWORD}
      - MYSQL_DATABASE
    volumes:
      - ./mysql/log:/var/log/mysql
      - ./mysql/data:/var/lib/mysql
      - ./mysql/conf:/etc/mysql
    ports:
      - "3306:3306"
    networks:
      - sonic-network
# ==== End ====

networks:
  sonic-network:
    driver: bridge

4. Just execute docker-compose up -d.

Frequently Asked Questions（Q&A） #

Q1: The browser accesses the front end without errors, but 【system error】 or 【unknown exception occurred】 appears during registration.

A1: The solution can refer to this post

Q2: Check the log and find that MySQL is not connected, how to solve it?

A2: Mainly divided into a variety of situations:

• MySQL does not have remote access permissions enabled.
• Due to the deployment of Docker containers, ip addresses such as 127.0.0.1 or localhost are invalid.
• Special circumstances such as corporate network restrictions.

The solution can refer to this post.

Q3: At present, the files are mounted in the default directory of Docker, how can they be mounted to a custom file directory?

A3: The solution can refer to this post.

Q4: The Mac system does not see the .env file after decompression, how to solve it?

A4: The solution can refer to this post

Q5: I don't see the .env file after decompressing the Linux system, how to solve it?

A5: You can use the ls -a command to view hidden files