Skip to main content

WeDa Private Deployment Version Upgrade Guide

This document will guide you through the version upgrade process for WeDa private deployment, ensuring a safe and reliable upgrade process.

Pre-upgrade Preparation

License Status Check

Important Reminder

Users with unexpired License: You can directly jump to Step 3: Data Backup to start the upgrade process.

Users with expired License: You need to start from Step 1, update the License first, then proceed with the upgrade.

Upgrade Steps

Step 1: Obtain Latest Version License

If your License has expired, please renew it first:

👉 Go to License Renewal Guide to complete renewal

License Version Description
  • Community Edition License: Limited functionality (supports only 1 developer and 1 production application deployment)
  • Package Details: View Official Package Information
  • Upgrade Recommendation: If you need more features, please purchase Enterprise Edition License

Step 2: Update License File

Update the renewed License to the system:

  1. Switch to WeDa Installation Directory

    cd /data/tencent/weda  # Default installation directory for standalone version
  2. Edit License File

    vim LICENSE.txt
  3. Replace License Content

    • Delete the original License content
    • Paste the new License obtained in Step 1
    • Save and exit the editor
Notes
  • Ensure the License content is complete without extra spaces or line breaks
  • The default installation directory for standalone version is /data/tencent/weda, please adjust according to actual situation

Step 3: Data Backup

Data backup is mandatory before upgrade to prevent data loss:

Built-in Database Backup

# 1. Switch to WeDa installation directory
cd /data/tencent/weda

# 2. Backup the entire data directory
cp -r weda weda-bak

# 3. Confirm backup completion
ls -la weda-bak/

External Database Backup

External Database Users

If you are using an external MySQL database, please use database management tools to backup MySQL data yourself.

MySQL Backup Example:

# Backup specific database
mysqldump -u username -p database_name > backup_$(date +%Y%m%d_%H%M%S).sql

# Backup all databases
mysqldump -u username -p --all-databases > full_backup_$(date +%Y%m%d_%H%M%S).sql

Step 4: Download Latest Installation Package

Download and execute the latest version installation script:

wget -L -O install.sh https://software-1302110647.cos.ap-guangzhou.myqcloud.com/rc/lastest/install.sh && chmod +x install.sh && ./install.sh

Download Process Description:

  1. Download the latest installation script
  2. Add execution permissions
  3. Automatically execute the installation program

Step 5: Upgrade

Execute the upgrade:

# Switch to WeDa directory
cd /data/tencent/weda

# Execute upgrade verification
./upgrade.sh

Verification Result Handling

Verification Result Description
  • Verification Success: Wait for upgrade completion
  • "EnvId not match" Error: Need to continue with Step 6 and Step 7 for data migration

Step 6: Data Migration (Execute only when verification fails)

If Step 5 shows "EnvId not match" error, data migration is required:

# Execute data migration in WeDa directory
./envmigrate

Migration Process:

  • The system will automatically migrate existing data to new version format
  • Please wait patiently for migration completion, do not interrupt the process

Step 7: Complete Upgrade (Only after executing Step 6)

After data migration completion, re-execute Step 5:

Step 8: Republish Applications

If the upgrade involves HTTPS configuration updates, after upgrade completion, you need to republish existing applications:

  1. Login to WeDa Management Console
  2. Enter Application Management Page
  3. Republish existing applications one by one
Application Publishing Description
  • If there are no published applications, you can skip this step
  • Republishing ensures applications are fully compatible with the new version
  • If problems occur during publishing, please check if application configuration is correct

Special Situation Handling

Tencent Cloud Lighthouse Users

If you are using Tencent Cloud Lighthouse WeDa Application Template, you need to execute special configuration before upgrade:

# Set Lighthouse environment variable
export LH_ENABLED="true"

# Then normally download install.sh file for upgrade
wget -L -O install.sh https://software-1302110647.cos.ap-guangzhou.myqcloud.com/rc/lastest/install.sh && chmod +x install.sh && ./install.sh

FAQ [For License Downgrade]

License Downgrade Notes
  • This refers to situations where the newly purchased License has fewer developers and applications than the previous configuration

Q1: Can multiple developers continue to use after upgrade?

Problem Description: There were multiple developers before upgrade, can they still be used normally after upgrade?

Answer:

  • Development Tools: Cannot use development tools after upgrade, need to delete excess developers before continuing to use
  • Existing Applications: Original applications are not affected and can be accessed and used normally
  • Solution: Delete excess developers in user management, keeping only the number of developers within License limits

Q2: Can multiple applications continue to be used after upgrade?

Problem Description: Multiple applications were published before upgrade, can they still be used normally after upgrade?

Answer:

  • Application Access: Published applications are not affected, users can access them normally
  • Application Publishing: Cannot publish new applications, need to delete excess applications or upgrade License
  • Solution: Delete excess applications to stay within License limits, or purchase Enterprise Edition License

Upgrade Verification

After upgrade completion, it is recommended to perform the following verification:

1. System Status Check

# Check service status
docker ps

# Check logs
docker logs <container_name>

2. Function Verification

  1. Login Verification: Confirm normal login to management console
  2. Application Access: Verify published applications can be accessed normally
  3. Development Tools: Confirm development tools function normally
  4. Data Integrity: Check if application data is complete

3. Performance Check

  • Check system response speed
  • Verify application loading time
  • Confirm database connection is normal

Rollback Plan

If problems occur during the upgrade process, you can use backup data for rollback:

# Stop current service
docker-compose --profile all down

# Restore backup data
rm -rf weda
mv weda-bak weda

# Restart service
./upgrade.sh
Rollback Notes
  • Rollback will lose all data changes after upgrade
  • It is recommended to rollback only after confirming complete upgrade failure
  • Please contact technical support for professional advice before rollback

Summary

Through the above steps, you have successfully completed the WeDa private deployment version upgrade:

  1. ✅ Updated License (if needed)
  2. ✅ Completed data backup
  3. ✅ Downloaded and installed the latest version
  4. ✅ Executed upgrade verification and data migration
  5. ✅ Republished applications
  6. ✅ Handled special situations and common problems

Now you can enjoy the functional improvements and performance enhancements brought by the new version. If you encounter any problems during the upgrade process, please contact the technical support team promptly.