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

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;

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/upgradelink-2.4.0.sql.

DB Initialization

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/admin.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.