UpgradeLink

English

简体中文

English

简体中文

Appearance

UpgradeLink-standalone ​

This quick start guide helps you quickly deploy and use UpgradeLink in Docker containers through UpgradeLink's Docker images.

  • The UpgradeLink-admin module is defined as an internal application, not a product for public network environments. It is recommended to deploy it in an isolated internal network environment and strongly not recommended to deploy it in a public network environment.
  • The UpgradeLink-api module is defined as an API project intended for public network environments and should be deployed in external network environments.

1. Environment Preparation ​

1.1 Environment Setup ​

Install Docker, and verify the installation:

shell
docker --version  # Installation is successful if version number is displayed

1.2 Download the Project ​

Clone from either repository:

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

# or GitCode
git clone https://gitcode.com/toolsetlink/upgradelink.git

1.3 Start Dependent Services (MySQL + Redis) ​

If you already have independent MySQL and Redis environments, you can refer to the "Self-Build Documentation" for configuration.

1.3.1 Start MySQL ​

shell
cd upgradelink/development/mysql-8.4.3
shell
docker-compose up -d

1.4 Start UpgradeLink ​

The first execution will automatically download the Docker image. The waiting time depends on your network speed:

shell
docker run -d --add-host=host.docker.internal:host-gateway -p 8081:8080 -p 8888:8888 toolsetlink/upgradelink-standalone:v2.1.0

2. Verify if the UpgradeLink Service Started Successfully ​

Use the docker logs -f $container_id command to check the UpgradeLink service startup logs. If you see the following logs, the service has started successfully.

2025-09-26 15:10:26,284 INFO Set uid to user 0 succeeded
2025-09-26 15:10:26,302 INFO RPC interface 'supervisor' initialized
2025-09-26 15:10:26,303 CRIT Server 'unix_http_server' running without any HTTP authentication checking
2025-09-26 15:10:26,303 INFO supervisord started with pid 9
2025-09-26 15:10:27,312 INFO spawned: 'core-rpc' with pid 11
2025-09-26 15:10:27,313 INFO spawned: 'file' with pid 12
2025-09-26 15:10:27,315 INFO spawned: 'message' with pid 13
2025-09-26 15:10:27,317 INFO spawned: 'upgrade' with pid 14
2025-09-26 15:10:27,322 INFO spawned: 'core-api' with pid 15
2025-09-26 15:10:27,325 INFO spawned: 'api' with pid 16
2025-09-26 15:10:27,336 INFO spawned: 'crond' with pid 25
2025-09-26 15:10:27,345 INFO spawned: 'nginx' with pid 41

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

2.1 UpgradeLink Console Page ​

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

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

2.2 API Interface ​

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

toolsetlink@163.com