🖥️ Desktop Applications

Desktop Auto-Updater Deep Dive

Automatic update mechanism for the Gauzy Desktop application.

Overview

The auto-updater uses Electron Builder's built-in update mechanism, which supports:

  • GitHub Releases (default)
  • Custom update server
  • S3/DigitalOcean Spaces

Update Flow

Diagram; its source is available below
Diagram source
sequenceDiagram
    Desktop->>UpdateServer: Check for updates
    UpdateServer-->>Desktop: New version available
    Desktop->>User: Show update notification
    User->>Desktop: Accept update
    Desktop->>UpdateServer: Download update
    UpdateServer-->>Desktop: Update package
    Desktop->>Desktop: Install & restart

Configuration

{
  "publish": {
    "provider": "github",
    "owner": "ever-co",
    "repo": "ever-gauzy"
  }
}

Update Channels

ChannelPurpose
latestStable releases
betaBeta testing
alphaEarly development

Platform-Specific

PlatformUpdate FormatAuto-Install
Windows.exe NSISYes
macOS.dmg / .zipYes (signed)
Linux.AppImageYes

Manual Check

Users can trigger an update check: Settings → About → Check for Updates

Edit this page

Copyright © 2023-Present Ever Co. LTD.Docs by Sourcey