MineSync Docs
MineSync Docs
MineSync Documentation
Audit LogBackup & RestoreBenchmark ManagementMaster DataNotificationsAdmin OverviewSettingsTemplatesThemeUpdatesUser Management
Admin

Updates

View system version information and manage software updates.

Overview

The Updates page shows the current MineSync version, build information, and update status. For self-hosted (local/Docker) deployments, it also provides tools to check for and manage software updates. Cloud-hosted deployments on Vercel handle updates automatically.

Key Concepts

Deployment Modes

MineSync supports two deployment modes, which affect how updates are managed:

ModeDescription
CloudHosted on Vercel. Updates are deployed automatically. The Updates page shows version info only.
LocalSelf-hosted via Docker. Updates can be checked for and applied from the admin interface.

Version Information

The system info panel displays:

FieldDescription
VersionThe current MineSync version (semantic versioning)
Build DateWhen the current version was built
CommitThe Git commit hash of the current build
EnvironmentThe runtime environment (development, production)
Deployment ModeCloud or Local

Update Mechanism

For self-hosted deployments, MineSync uses a file-based update mechanism:

  • Pending updates are stored as .tar.gz files in the updates directory
  • Applied updates are moved to the applied directory after installation
  • An updater service handles applying updates and logs its activity

How to Use

Viewing System Information

  1. Navigate to Admin > Updates.
  2. The system info card shows the current version, build date, commit, and environment.

Checking for Updates (Self-Hosted Only)

  1. Click Check for Updates.
  2. The system contacts the update server and compares your version against the latest available release.
  3. If an update is available, details are shown including version number, release notes, and download size.

Viewing Applied Updates

The applied updates list shows previously installed updates with:

  • Filename and version
  • Date applied
  • File size

Viewing Pending Updates

Pending updates are update files that have been downloaded but not yet applied.

Updater Logs

View the updater service logs to troubleshoot update issues. Logs show the last 100 lines by default (configurable up to 1,000 lines).

Update Server Configuration

The configuration panel shows:

  • Update server URL
  • Updates directory path
  • Applied updates directory path
  • Log file path
  • Whether the update server is configured

Common Questions

Do I need to manage updates on Vercel?

No. Cloud-hosted deployments are updated automatically through Vercel's deployment pipeline. The Updates page will show version info but hide update management controls.

How are updates applied in self-hosted mode?

Updates are distributed as .tar.gz archives. The updater service extracts and applies them. See the updater logs for details on each update operation.

Who can access the Updates page?

Only Admin users can view system information and manage updates.

What version format is used?

MineSync uses semantic versioning (e.g., v0.1.0). Version comparison uses the semver standard.

Theme

Customize your organization's visual appearance with theme presets.

User Management

Invite, create, and manage organization members and their roles.

On this page

OverviewKey ConceptsDeployment ModesVersion InformationUpdate MechanismHow to UseViewing System InformationChecking for Updates (Self-Hosted Only)Viewing Applied UpdatesViewing Pending UpdatesUpdater LogsUpdate Server ConfigurationCommon QuestionsDo I need to manage updates on Vercel?How are updates applied in self-hosted mode?Who can access the Updates page?What version format is used?