UpgradeLink

English

简体中文

English

简体中文

Appearance

UpgradeLink Docker Compose Quick Start ​

This guide helps you quickly deploy and use UpgradeLink in Docker containers through UpgradeLink project image examples.

Before you begin, we hope you have the following experience:

  • Familiar with Docker containerized deployment.
  • Familiar with MySQL database.
  • Familiar with Redis cache.
  • Familiar with backend project deployment.
  • Read the project module introduction to understand the functions of each module. Project Module Introduction

1. Environment Preparation ​

You need to install Docker.

2. Download the Project ​

2.1. Download the project from GitHub ​

shell
git clone https://github.com/toolsetlink/upgradelink

3. Modify the configurations of MySQL and Redis to replace with your own database-related information. ​

Note 1: If an independent MySQL/Redis environment is used, the configuration needs to be adjusted; if the environment is deployed with Docker-Compose in one click, no modification is required.

Note 2: [Critical] If the database is deployed on the host machine (physical machine/virtual machine) but the application runs in a Docker container:

  • Do NOT fill in 127.0.0.1 (127.0.0.1 inside the container points to the container itself and cannot access the host machine);
  • It needs to be replaced with the actual intranet IP of the host machine (e.g., 192.168.1.100, 10.0.0.5, etc.).

Note 3: Path of MySQL initialization script: development/upgrade-20251209.sql.

How to query the intranet IP of the host machine? ​

  • Linux/macOS: Execute ip addr (or ifconfig), and check the inet field of network cards such as eth0/en0;
  • Windows: Execute ipconfig, and check the IPv4 address under "Ethernet/WLAN".

Adjust the configuration file below ​

development/docker-compose/upgradelink-admin-core/core-api.yaml

development/docker-compose/upgradelink-admin-core/core-rpc.yaml

development/docker-compose/upgradelink-admin-file/fms.yaml

development/docker-compose/upgradelink-admin-message/mcms.yaml

development/docker-compose/upgradelink-admin-upgrade/upgrade.yaml

development/docker-compose/upgradelink-admin-task/task.yaml

development/docker-compose/upgradelink-api/api.yaml

4. Start UpgradeLink ​

Project Module Introduction

Execute the following command in the development/docker-compose directory:

docker-compose up -d

5. Access the UpgradeLink Backend Management System ​

You can quickly test the functionality of UpgradeLink through the following services.

5.1 UpgradeLink Console Page ​

Open any browser and enter the address: http://127.0.0.1:80 to access the UpgradeLink console page.

Note: Default username and password are admin/simple-admin

5.2 API Interface ​

The API service address is http://127.0.0.1:8080. You can refer to the API documentation and replace the address for testing.

toolsetlink@163.com