voicebox/docs2/content/docs/AUTOUPDATER_QUICKSTART.md at 0922845101b9f5331cf860c618e34a1037facfbc

mirror of https://github.com/jamiepine/voicebox.git synced 2026-09-15 12:50:42 -07:00

Files

T

Jamie Pine 64dd29d35a Add initial setup for Fumadocs documentation migration

- Created new directory structure for documentation under `/docs2`.
- Added `.gitignore` to exclude build artifacts and dependencies.
- Introduced `package.json`, `next.config.mjs`, and `postcss.config.mjs` for project configuration.
- Implemented MDX components in `mdx-components.tsx` for rendering documentation.
- Migrated existing documentation content and created new files for auto-updater and other features.
- Established compatibility layer for Mintlify components in `mintlify-compat.tsx`.
- Set up OpenAPI documentation in `openapi.json`.
- Updated README and migration guide to reflect new structure and usage instructions.
- Ensured all components and pages are ready for development and deployment with Fumadocs.

2026-01-30 23:32:45 -08:00

3.3 KiB

Raw Blame History

title, description

title	description
Autoupdater Quick Start	Quick guide to activate the Tauri v2 autoupdater

The Tauri v2 autoupdater has been fully configured and integrated. Follow these steps to activate it.

What's Already Done

✅ Rust plugin installed and initialized ✅ Tauri configuration set up with updater settings ✅ Permissions granted for update operations ✅ GitHub Actions workflow updated with signing support ✅ Frontend components created and integrated ✅ Update notifications on app startup ✅ Manual update check in Settings tab

Required Steps (5 minutes)

1. Generate Signing Keys

bun run generate:keys

This creates:

Private key: ~/.tauri/voicebox.key (keep secret!)
Public key: ~/.tauri/voicebox.key.pub (safe to share)

2. Update Tauri Config

Open tauri/src-tauri/tauri.conf.json and:

Replace "REPLACE_WITH_YOUR_PUBLIC_KEY" with the content from ~/.tauri/voicebox.key.pub

Update the endpoint URL with your GitHub username:

"endpoints": [
  "https://github.com/YOUR_USERNAME/voicebox/releases/latest/download/latest.json"
]

3. Add GitHub Secrets

Go to your repo Settings → Secrets and variables → Actions:

Add TAURI_SIGNING_PRIVATE_KEY:
```
cat ~/.tauri/voicebox.key
```
Copy the entire output and paste as the secret value
Add TAURI_SIGNING_PRIVATE_KEY_PASSWORD: Leave empty (or add your password if you set one)

4. Test the Setup

To test locally before creating a release:

bun run build:release

This will verify your keys are set up correctly.

How It Works

For Users

App checks for updates on startup (only in Tauri builds)
If an update is available, a banner appears at the top
Users can click "Install Now" to download and install
App restarts automatically after installation

For Developers

Create a new git tag: git tag v0.2.0 && git push --tags
GitHub Actions builds signed releases for all platforms
Uploads installers and generates latest.json manifest
Users running older versions will be notified automatically

UI Components

Update Notification Banner

Shows at top of app when update is available
Appears automatically on startup
Displays download/install progress

Settings Panel

Located in Settings tab
Shows current version
Manual "Check for Updates" button
Update status and progress

Troubleshooting

"Public key not configured"

Make sure you copied the entire content from voicebox.key.pub
The key should start with dW50cnVzdGVkIGNvbW1lbnQ6

"Failed to check for updates"

Endpoint URL might be incorrect
No releases published yet (expected for first setup)

Build fails with signing error

Check that GitHub secrets are set correctly
Verify private key file exists at ~/.tauri/voicebox.key

Next Release Workflow

Update version in tauri/src-tauri/tauri.conf.json
Commit changes
Create and push tag: git tag v0.2.0 && git push --tags
GitHub Actions will automatically build and create a draft release
Review the release and publish it
Users will be notified of the update

3.3 KiB Raw Blame History