Implement autoupdater functionality and enhance icon management

- Added a new UpdateNotification component to inform users about available updates and facilitate installation. - Integrated useAutoUpdater hook for managing update checks and installations. - Updated package.json with new build and generate scripts for release preparation and key generation. - Enhanced tauri configuration to support autoupdater with signing keys and endpoints. - Created scripts for preparing signed releases and updating icons, ensuring a streamlined workflow for asset management. - Added detailed documentation for autoupdater setup and icon update workflow.
2026-09-16 13:20:39 -07:00 · 2026-01-25 15:38:31 -08:00
parent 0e38d47855
commit 7d1ee4c1b9
65 changed files with 1624 additions and 55 deletions
@@ -0,0 +1,224 @@
+# Tauri v2 Autoupdater Setup
+
+The autoupdater has been configured for this project. Follow these steps to complete the setup.
+
+## 1. Generate Signing Keys
+
+Run this command to generate your signing keypair:
+
+```bash
+cd tauri && bun tauri signer generate -w ~/.tauri/voicebox.key
+```
+
+This creates:
+- **Private key**: `~/.tauri/voicebox.key` (keep this secret!)
+- **Public key**: `~/.tauri/voicebox.key.pub`
+
+## 2. Update Configuration
+
+Copy the content from `~/.tauri/voicebox.key.pub` and replace the placeholder in `tauri/src-tauri/tauri.conf.json`:
+
+```json
+{
+  "plugins": {
+    "updater": {
+      "pubkey": "PASTE_PUBLIC_KEY_CONTENT_HERE",
+      "endpoints": [
+        "https://github.com/YOUR_USERNAME/voicebox/releases/latest/download/latest.json"
+      ]
+    }
+  }
+}
+```
+
+Update the endpoint URL with your actual GitHub username/organization.
+
+## 3. Building with Signatures
+
+When building releases, set these environment variables:
+
+**macOS/Linux:**
+```bash
+export TAURI_SIGNING_PRIVATE_KEY="$(cat ~/.tauri/voicebox.key)"
+export TAURI_SIGNING_PRIVATE_KEY_PASSWORD=""
+bun run build
+```
+
+**Windows PowerShell:**
+```powershell
+$env:TAURI_SIGNING_PRIVATE_KEY = Get-Content ~/.tauri/voicebox.key -Raw
+$env:TAURI_SIGNING_PRIVATE_KEY_PASSWORD = ""
+bun run build
+```
+
+## 4. GitHub Release Setup
+
+When you create a GitHub release, the build process will generate:
+- Installers for each platform
+- `.sig` signature files
+- `latest.json` update manifest
+
+### Manual Release Process
+
+1. Build the app with signing keys set
+2. Create a new GitHub release
+3. Upload all files from `tauri/src-tauri/target/release/bundle/`
+4. Create `latest.json` in your release assets:
+
+```json
+{
+  "version": "0.2.0",
+  "notes": "Bug fixes and improvements",
+  "pub_date": "2026-01-25T12:00:00Z",
+  "platforms": {
+    "darwin-aarch64": {
+      "signature": "CONTENT_FROM_.app.tar.gz.sig",
+      "url": "https://github.com/YOUR_USERNAME/voicebox/releases/download/v0.2.0/voicebox_0.2.0_aarch64.dmg"
+    },
+    "darwin-x86_64": {
+      "signature": "CONTENT_FROM_.app.tar.gz.sig",
+      "url": "https://github.com/YOUR_USERNAME/voicebox/releases/download/v0.2.0/voicebox_0.2.0_x64.dmg"
+    },
+    "linux-x86_64": {
+      "signature": "CONTENT_FROM_.AppImage.sig",
+      "url": "https://github.com/YOUR_USERNAME/voicebox/releases/download/v0.2.0/voicebox_0.2.0_amd64.AppImage"
+    },
+    "windows-x86_64": {
+      "signature": "CONTENT_FROM_.msi.sig",
+      "url": "https://github.com/YOUR_USERNAME/voicebox/releases/download/v0.2.0/voicebox_0.2.0_x64_en-US.msi"
+    }
+  }
+}
+```
+
+### Automated GitHub Actions (Recommended)
+
+Create `.github/workflows/release.yml`:
+
+```yaml
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  release:
+    strategy:
+      matrix:
+        platform: [macos-latest, ubuntu-22.04, windows-latest]
+
+    runs-on: ${{ matrix.platform }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Install dependencies (Ubuntu)
+        if: matrix.platform == 'ubuntu-22.04'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libwebkit2gtk-4.1-dev libappindicator3-dev librsvg2-dev patchelf
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Build
+        env:
+          TAURI_SIGNING_PRIVATE_KEY: ${{ secrets.TAURI_SIGNING_PRIVATE_KEY }}
+          TAURI_SIGNING_PRIVATE_KEY_PASSWORD: ${{ secrets.TAURI_SIGNING_PRIVATE_KEY_PASSWORD }}
+        run: bun run build
+
+      - name: Upload Release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: tauri/src-tauri/target/release/bundle/**/*
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+Add your private key to GitHub secrets:
+- Go to Settings → Secrets and variables → Actions
+- Add `TAURI_SIGNING_PRIVATE_KEY` with the content of `~/.tauri/voicebox.key`
+- Add `TAURI_SIGNING_PRIVATE_KEY_PASSWORD` (empty string if no password)
+
+## 5. Implementing Update Check in Frontend
+
+Add the updater package:
+
+```bash
+bun add @tauri-apps/plugin-updater
+```
+
+Example implementation:
+
+```typescript
+import { check } from '@tauri-apps/plugin-updater';
+import { relaunch } from '@tauri-apps/plugin-process';
+
+async function checkForUpdates() {
+  try {
+    const update = await check();
+
+    if (update?.available) {
+      console.log(`Update available: ${update.version}`);
+
+      // Show UI to user
+      const shouldUpdate = confirm(
+        `Version ${update.version} is available. Install now?`
+      );
+
+      if (shouldUpdate) {
+        await update.downloadAndInstall();
+        await relaunch();
+      }
+    }
+  } catch (error) {
+    console.error('Update check failed:', error);
+  }
+}
+
+// Check on app startup
+checkForUpdates();
+
+// Or add a manual check button
+```
+
+## Security Notes
+
+- Never commit your private key to version control
+- Store private keys securely (use GitHub secrets for CI/CD)
+- The public key in `tauri.conf.json` is safe to commit
+- Updates are cryptographically verified before installation
+- HTTP endpoints are blocked by default (HTTPS only)
+
+## Testing Updates
+
+1. Build version 0.1.0 and install it
+2. Update version in `tauri.conf.json` to 0.2.0
+3. Build version 0.2.0 with signatures
+4. Create a local server or GitHub release with `latest.json`
+5. Run version 0.1.0 and trigger update check
+6. Verify update downloads and installs correctly
+
+## Troubleshooting
+
+**"Invalid signature" error:**
+- Verify public key matches the private key used to sign
+- Ensure signature files (.sig) are uploaded correctly
+
+**"No update available" when one exists:**
+- Check endpoint URL is correct
+- Verify `latest.json` format matches specification
+- Ensure version in latest.json is higher than current version
+
+**Build fails with signing:**
+- Confirm environment variables are set correctly
+- Check private key file exists and is readable
+- Verify private key format (should start with `dW50cnVzdGVkIGNvbW1lbnQ6`)
@@ -0,0 +1,150 @@
+# Icon Update Workflow for voicebox
+
+## Prerequisites
+- Xcode Command Line Tools installed (`xcode-select --install`)
+- Your icon designed in Icon Composer and saved as `voicebox.icon` in the project root
+
+## Directory Structure
+```
+voicebox/
+├── voicebox.icon/              # macOS 26 Liquid Glass icon bundle
+│   ├── icon.json
+│   └── Assets/
+│       └── Voicebox.png        # Your source image
+├── tauri/
+│   ├── assets/
+│   │   └── voicebox_exports/   # Your 1024x1024 exports
+│   └── src-tauri/
+│       ├── gen/                # Auto-generated at build time
+│       │   ├── Assets.car      # Liquid Glass assets
+│       │   ├── voicebox.icns   # Generated fallback icon
+│       │   └── partial.plist
+│       └── icons/              # Tauri fallback icons (all platforms)
+│           ├── icon.icns
+│           ├── icon.ico
+│           ├── 32x32.png
+│           ├── 128x128.png
+│           └── ...
+```
+
+## Step 1: Update the Liquid Glass Icon
+
+Edit `voicebox.icon/` in Icon Composer (or manually update `icon.json` and `Assets/`).
+
+The build script (`build.rs`) automatically compiles this during `cargo build`.
+
+## Step 2: Regenerate Fallback Icons
+
+After updating the `.icon` bundle, regenerate the fallback icons:
+
+```bash
+cd tauri/src-tauri
+
+# Trigger rebuild to generate new icns
+cargo build
+
+# Copy the generated icns to icons folder
+cp gen/voicebox.icns icons/icon.icns
+
+# Generate PNGs from the icns
+sips -s format png -z 32 32 gen/voicebox.icns --out icons/32x32.png
+sips -s format png -z 64 64 gen/voicebox.icns --out icons/64x64.png
+sips -s format png -z 128 128 gen/voicebox.icns --out icons/128x128.png
+sips -s format png -z 256 256 gen/voicebox.icns --out icons/[email protected]
+sips -s format png -z 512 512 gen/voicebox.icns --out icons/icon.png
+
+# Windows Square logos
+for size in 30 44 71 89 107 142 150 284 310; do
+  sips -s format png -z $size $size gen/voicebox.icns --out "icons/Square${size}x${size}Logo.png"
+done
+```
+
+## Step 3: Rebuild the App
+
+```bash
+cd tauri && bun run tauri build
+```
+
+## Step 4: Clear Icon Cache (if icons don't update)
+
+```bash
+sudo rm -rf /Library/Caches/com.apple.iconservices.store
+sudo killall Finder
+sudo killall Dock
+```
+
+---
+
+## How It Works
+
+| File | Purpose |
+|------|---------|
+| `voicebox.icon/` | Source for macOS 26 Liquid Glass icon |
+| `build.rs` | Compiles `.icon` → `Assets.car` + `voicebox.icns` at build time |
+| `gen/Assets.car` | Liquid Glass assets (macOS 26+) |
+| `gen/voicebox.icns` | Auto-generated fallback icon |
+| `icons/icon.icns` | Tauri's fallback for older macOS |
+| `icons/*.png` | Tauri's fallback for other platforms |
+| `Info.plist` | Points to `voicebox` as icon name |
+| `tauri.conf.json` | Bundles `gen/*` to Resources root |
+
+## Key Config Files
+
+### `build.rs` — Compiles the icon
+
+```rust
+xcrun actool --app-icon voicebox ... voicebox.icon
+```
+
+### `tauri.conf.json` — Bundles generated assets to Resources root
+
+```json
+"resources": {
+  "gen/Assets.car": "./",
+  "gen/voicebox.icns": "./",
+  "gen/partial.plist": "./"
+}
+```
+
+### `Info.plist` — Tells macOS which icon to use
+
+```xml
+<key>CFBundleIconFile</key>
+<string>voicebox</string>
+<key>CFBundleIconName</key>
+<string>voicebox</string>
+```
+
+## Quick Reference Script
+
+Save this as `scripts/update-icons.sh`:
+
+```bash
+#!/bin/bash
+set -e
+
+cd "$(dirname "$0")/../tauri/src-tauri"
+
+echo "Building to generate new icons..."
+cargo build
+
+echo "Copying icns to icons folder..."
+cp gen/voicebox.icns icons/icon.icns
+
+echo "Generating PNG icons..."
+sips -s format png -z 32 32 gen/voicebox.icns --out icons/32x32.png
+sips -s format png -z 64 64 gen/voicebox.icns --out icons/64x64.png
+sips -s format png -z 128 128 gen/voicebox.icns --out icons/128x128.png
+sips -s format png -z 256 256 gen/voicebox.icns --out icons/[email protected]
+sips -s format png -z 512 512 gen/voicebox.icns --out icons/icon.png
+
+echo "Generating Windows Square logos..."
+for size in 30 44 71 89 107 142 150 284 310; do
+  sips -s format png -z $size $size gen/voicebox.icns --out "icons/Square${size}x${size}Logo.png"
+done
+
+echo "Done! Icons updated."
+echo "Run 'bun run tauri build' to rebuild the app."
+```
+
+Make it executable: `chmod +x scripts/update-icons.sh`