mirror of
https://github.com/netbirdio/netbird.git
synced 2026-08-25 09:01:29 +02:00
ad98b99fc5
Stop the UI before a silent Windows update and suppress the installer reboot On silent MSI updates msiexec could reboot the machine on its own. The running UI holds a lock on its own exe, and since msiexec runs as LocalSystem it cannot close the interactive user's UI via Restart Manager, so the MSI scheduled the file replacement for the next reboot and marked the install restart-required. Terminate netbird-ui.exe before launching the installer and wait until its image file is released; the existing deferred restart brings it back after the install on every exit path Run msiexec with /norestart REBOOT=ReallySuppress so it never reboots on its own Treat exit codes 3010/1641 as success with a warning instead of a failure --------- Co-authored-by: Viktor Liu <viktor@netbird.io>
121 lines
5.0 KiB
Go
121 lines
5.0 KiB
Go
// Package installer provides functionality for managing NetBird application
|
|
// updates and installations across Windows, macOS. It handles
|
|
// the complete update lifecycle including artifact download, cryptographic verification,
|
|
// installation execution, process management, and result reporting.
|
|
//
|
|
// # Architecture
|
|
//
|
|
// The installer package uses a two-process architecture to enable self-updates:
|
|
//
|
|
// 1. Service Process: The main NetBird daemon process that initiates updates
|
|
// 2. Updater Process: A detached child process that performs the actual installation
|
|
//
|
|
// This separation is critical because:
|
|
// - The service binary cannot update itself while running
|
|
// - The installer (EXE/MSI/PKG) will terminate the service during installation
|
|
// - The updater process survives service termination and restarts it after installation
|
|
// - Results can be communicated back to the service after it restarts
|
|
//
|
|
// # Update Flow
|
|
//
|
|
// Service Process (RunInstallation):
|
|
//
|
|
// 1. Validates target version format (semver)
|
|
// 2. Determines installer type (EXE, MSI, PKG, or Homebrew)
|
|
// 3. Downloads installer file from GitHub releases (if applicable)
|
|
// 4. Verifies installer signature using reposign package (cryptographic verification in service process before
|
|
// launching updater)
|
|
// 5. Copies service binary to tempDir as "updater" (or "updater.exe" on Windows)
|
|
// 6. Launches updater process with detached mode:
|
|
// - --temp-dir: Temporary directory path
|
|
// - --service-dir: Service installation directory
|
|
// - --installer-file: Path to downloaded installer (if applicable)
|
|
// - --dry-run: Optional flag to test without actually installing
|
|
// 7. Service process continues running (will be terminated by installer later)
|
|
// 8. Service can watch for result.json using ResultHandler.Watch() to detect completion
|
|
//
|
|
// Updater Process (Setup):
|
|
//
|
|
// 1. Receives parameters from service via command-line arguments
|
|
// 2. Terminates the UI so the installer does not have to replace a locked image
|
|
// file, which would otherwise leave the install needing a reboot
|
|
// 3. Runs installer with appropriate silent/quiet flags:
|
|
// - Windows EXE: installer.exe /S
|
|
// - Windows MSI: msiexec.exe /i installer.msi /qn /norestart REBOOT=ReallySuppress /l*v msi.log
|
|
// - macOS PKG: installer -pkg installer.pkg -target /
|
|
// - macOS Homebrew: brew upgrade netbirdio/tap/netbird
|
|
// 4. Installer terminates the daemon
|
|
// 5. Installer replaces binaries with new version
|
|
// 6. Updater waits for installer to complete. On Windows, MSI exit codes 3010
|
|
// (ERROR_SUCCESS_REBOOT_REQUIRED) and 1641 (ERROR_SUCCESS_REBOOT_INITIATED)
|
|
// are a pending-reboot outcome, not a failure: the install succeeded, but
|
|
// some files are only replaced on the next restart (the reboot itself is
|
|
// suppressed via /norestart and REBOOT=ReallySuppress), and the flow
|
|
// continues as on success
|
|
// 7. Updater restarts daemon:
|
|
// - Windows: netbird.exe service start
|
|
// - macOS/Linux: netbird service start
|
|
// 8. Updater restarts UI:
|
|
// - Windows: Launches netbird-ui.exe using CreateProcessAsUser in every
|
|
// session it was terminated in, falling back to the active console session
|
|
// - macOS: Uses launchctl asuser to launch NetBird.app for console user
|
|
// - Linux: Not implemented (UI typically auto-starts)
|
|
// 9. Updater writes result.json with success/error status (a pending reboot is
|
|
// recorded as success)
|
|
// 10. Updater process exits
|
|
//
|
|
// # Result Communication
|
|
//
|
|
// The ResultHandler (result.go) manages communication between updater and service:
|
|
//
|
|
// Result Structure:
|
|
//
|
|
// type Result struct {
|
|
// Success bool // true if installation succeeded
|
|
// Error string // error message if Success is false
|
|
// ExecutedAt time.Time // when installation completed
|
|
// }
|
|
//
|
|
// Result files are automatically cleaned up after being read.
|
|
//
|
|
// # File Locations
|
|
//
|
|
// Temporary Directory (platform-specific):
|
|
//
|
|
// Windows:
|
|
// - Path: %ProgramData%\Netbird\tmp-install
|
|
// - Example: C:\ProgramData\Netbird\tmp-install
|
|
//
|
|
// macOS:
|
|
// - Path: /var/lib/netbird/tmp-install
|
|
// - Requires root permissions
|
|
//
|
|
// Files created during installation:
|
|
//
|
|
// tmp-install/
|
|
// installer.log
|
|
// updater[.exe] # Copy of service binary
|
|
// netbird_installer_*.[exe|msi|pkg] # Downloaded installer
|
|
// result.json # Installation result
|
|
// msi.log # MSI verbose log (Windows MSI only)
|
|
//
|
|
// # API Reference
|
|
//
|
|
// # Cleanup
|
|
//
|
|
// CleanUpInstallerFiles() removes temporary files after successful installation:
|
|
// - Downloaded installer files (*.exe, *.msi, *.pkg)
|
|
// - Updater binary copy
|
|
// - Does NOT remove result.json (cleaned by ResultHandler after read)
|
|
// - Does NOT remove msi.log (kept for debugging)
|
|
//
|
|
// # Dry-Run Mode
|
|
//
|
|
// Dry-run mode allows testing the update process without actually installing:
|
|
//
|
|
// Enable via environment variable:
|
|
//
|
|
// export NB_AUTO_UPDATE_DRY_RUN=true
|
|
// netbird service install-update 0.29.0
|
|
package installer
|