Upgrading Coneshare¶

We recommend upgrading regularly to get the latest features, bug fixes, and security updates.

Backup Before Upgrading

Before you begin, it is critical to back up your data. The upgrade process involves data migrations that are not easily reversible. Refer to the Backup and Recovery guide.

Expect Downtime

The upgrade process requires stopping all services to run data migrations. Plan for a maintenance window, as Coneshare will be unavailable during the upgrade.

Versioning¶

We use Semantic Versioning (MAJOR.MINOR.PATCH). - MAJOR versions include significant new features or breaking changes. - MINOR versions add functionality in a backward-compatible manner. - PATCH versions include backward-compatible bug fixes.

You can find the latest release on the Coneshare Compose Releases page.

Standard Upgrade Process¶

The upgrade process uses git to pull the latest version and the installation script to apply any changes.

Navigate to the installation directory:
```
cd /opt/coneshare/coneshare-compose
```
Fetch the latest release tags from the repository:
```
git fetch --all --tags
```
Check out the version you want to upgrade to. Replace 1.1.0 with your target version tag.
```
# Example: Check out version 1.1.0
git checkout 1.1.0
```
Run the installation script. This script pulls the latest Docker images and performs necessary data migrations.
```
./install.sh
```
Restart the services to apply the changes.
```
./start.sh
```

Your Coneshare instance is now upgraded.

Upgrade Paths for Major Versions¶

When upgrading across multiple major or minor versions, you may need to upgrade to specific intermediate versions first. These "hard stops" are necessary to ensure critical database migrations are applied correctly.

Skipping a hard stop can lead to a broken installation.

Hard Stops¶

When upgrading, you must upgrade to each hard stop in order between your current version and your target version.

1.0.0
1.2.0
(More versions will be added here as they become hard stops)

For example, to upgrade from 0.9.0 to 1.3.0, you must follow this path:

# Example Path
0.9.0 -> 1.0.0 -> 1.2.0 -> 1.3.0

For each step in the path, you must follow the full Standard Upgrade Process.

Downgrading¶

Downgrading is Not Supported

We do not support downgrading Coneshare. Attempting to run an older version after a newer version has run will likely corrupt your data due to database schema incompatibilities.

If you encounter a critical issue after an upgrade, the only safe way to "downgrade" is to restore your instance from the backup you took before the upgrade began.