Skip to main content

Updates and Upgrades

Set aside time to test after upgrading. Do not run updates immediately before you need the software. A valid license is required to install updates.

Backup First​

Backup your current data path (for example /var/lib/vidredi).

Always Backup Before Upgrading

The upgrade process takes precautions to prevent data loss, but keep backups of the data partition (/var/lib/vidredi). This contains everything needed to run VidRedi.

During an upgrade, the new version is installed to /opt/vidredi/current. A backup is made of the previously running software (/opt/vidredi/current.backup). Data is not backed up during upgrades. A snapshot of the current database (db.sqlite) is made before the upgrade runs and can be restored if needed. Contact support if there are issues upgrading.

Minor Upgrades​

Minor upgrades only update the core VidRedi software. Use Configuration → Updates.

  1. Confirm the update channel on Configuration → System (stable, rc, beta, or alpha). Keep production machines on stable.
  2. Check for updates.
  3. Download and install when a release is available.
  4. Wait for the server to restart. The page reloads when the service is back.

See Configuration.

Full Upgrades​

Full upgrades can upgrade operating-system packages, core configurations (such as Nginx), and helper tools. Some software versions require a full upgrade. When that is the case, there is a notice when you try to update inside the software.

sudo /opt/vidredi/current/scripts/install.sh --full-upgrade

The installer never runs a blanket apt-get upgrade of the whole operating system. Keep Debian itself updated separately.

Useful flags:

  • --yes — accept defaults and skip prompts (safe for a re-run)
  • --from STEP — resume at a named step after a failure
  • --verbose — stream command output to the console as well as the log
  • --offline — install from the local release tree instead of downloading
  • --data-path PATH — store packages, the database, and config here instead of /var/lib/vidredi
  • --clean-cache — delete cached downloads under /var/lib/vidredi/cache (or your data path's cache/ folder). Used alone, this only clears the cache. Combined with --full-upgrade or --offline, it clears the cache and then continues.
  • --reinstall-gst — force reinstall of the GStreamer support package

Release archives and side packages are stored in the cache folder and reused when the file's hash still matches.

Maintain Operating System Updates

Keep the operating system and firmware up to date, especially if the machine is exposed to the Internet.

Upgrade Considerations​

  • Review release notes for any changes that could affect usage.
  • Test in a non-production environment first, when possible, and leave ample time for testing.
  • Ensure adequate disk space (at least 10 GB on the OS disk) for the upgrade process.
Test Environment

VidRedi can be installed on unlicensed hardware for testing. On unlicensed hardware, video playback and recording are disabled and updates are not allowed. Licenses can be deregistered and moved to different hardware from your account page on VidRedi.com.

If an upgrade fails, see Troubleshooting.