Release and Upgrades¶

We follow the international standard for versioning, which is in the format X.Y.Z. Here’s how each component of the version works:

Major version X: Released 1-2 times a year. It includes significant upgrades, such as changes to the overall system interface or the introduction of major new features.
Minor version Y: Released 1-2 times per quarter. It includes regular updates, such as the introduction of new features or upgrades to frameworks and dependencies.
Patch version Z: Released intermittently. It mainly includes bug fixes and other minor, routine updates.

This versioning structure helps clearly communicate the scope and significance of each release.

Tip

We recommend that you update regularly to ensure the best and most up-to-date user experience.

Software Upgrade¶

Assuming you followed the installation steps in the Quick Start guide, and you have downloaded and extracted the latest installation script (version 1.4.0),

cd /opt/beatsight

.
|-- beatsight-docker-1.3.0-ce
|   |-- README.md
|   |-- backup.sh
|   |-- backups
|   |-- beatsight_install_log-2024-10-26_04-10-18.txt
|   |-- docker-compose.yaml
|   |-- install
|   |-- install.sh
|   |-- logs
|   |-- runtime
|   |-- start.sh
|   `-- stop.sh
|-- beatsight-docker-1.4.0-ce
|   |-- README.md
|   |-- backup.sh
|   |-- backups
|   |-- docker-compose.yaml
|   |-- install
|   |-- install.sh
|   |-- logs
|   |-- runtime
|   |-- upgrades
|   |-- start.sh
|   `-- stop.sh
|-- logs
|   |-- beatsight
|   |-- nginx
|   `-- supervisor
`-- runtime
    |-- beatsight.nginx.conf
    |-- beatsight_settings.py
    `-- gunicorn.conf.py

Enter the new installation script directory and execute the upgrade script:

cd beatsight-docker-1.3.0-ce
./upgrades/v1.3_1.4.sh

The script will first stop the current service, so please ensure that you execute it at an appropriate time.

Tip

Patch version upgrades (e.g., v1.3.0 -> v1.3.1) do not require running the upgrade script.

After the upgrade is complete, install the new version and start the services.

./install.sh
./start.sh

Upgrade Across Multiple Major Versions¶

Assuming you are upgrading directly from version 1.2 to version 1.4.5, you will need to execute multiple upgrade scripts in sequence:

cd beatsight-docker-1.4.5
./upgrades/v1.2_1.3.sh
./upgrades/v1.3_1.4.sh

Software Downgrade¶

If the new version has bugs or other issues preventing normal usage, you can revert to the previous version by following these steps:

cd beatsight-docker-1.3.0-ce
./install.sh

Once the old version is installed, simply restart the service to complete the downgrade.