mirror of
https://github.com/jamiepine/voicebox.git
synced 2026-09-16 13:20:39 -07:00
Jamie Pine
64dd29d35a
- 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.
85 lines
2.1 KiB
Plaintext
85 lines
2.1 KiB
Plaintext
---
|
|
title: "Auto-Updater"
|
|
description: "Configure and use the Tauri auto-updater"
|
|
---
|
|
|
|
## Overview
|
|
|
|
Voicebox uses Tauri's built-in auto-updater to deliver updates to users automatically.
|
|
|
|
## Quick Reference
|
|
|
|
For detailed setup instructions, see the existing documentation:
|
|
|
|
- [AUTOUPDATER_QUICKSTART.md](https://github.com/jamiepine/voicebox/blob/main/docs/AUTOUPDATER_QUICKSTART.md)
|
|
- [AUTOUPDATER.md](https://github.com/jamiepine/voicebox/blob/main/docs/AUTOUPDATER.md)
|
|
|
|
## How It Works
|
|
|
|
The auto-updater follows a secure update process:
|
|
|
|
1. **Check for Updates** - The Voicebox app periodically checks GitHub Releases for new versions
|
|
2. **Download Update** - If a new version is found, the update package is downloaded
|
|
3. **Verify Signature** - The downloaded package is cryptographically verified using the public key
|
|
4. **Install** - After verification, the update is installed
|
|
5. **Restart** - The app restarts with the new version
|
|
|
|
## Configuration
|
|
|
|
Updates are configured in `tauri/src-tauri/tauri.conf.json`:
|
|
|
|
```json
|
|
{
|
|
"updater": {
|
|
"active": true,
|
|
"endpoints": [
|
|
"https://github.com/jamiepine/voicebox/releases/latest/download/latest.json"
|
|
],
|
|
"dialog": true,
|
|
"pubkey": "YOUR_PUBLIC_KEY"
|
|
}
|
|
}
|
|
```
|
|
|
|
## Generating Keys
|
|
|
|
```bash
|
|
# Generate signing keys
|
|
bun run generate:keys
|
|
|
|
# Keys saved to ~/.tauri/voicebox.key
|
|
```
|
|
|
|
<Warning>
|
|
Keep your private key secure! Never commit it to the repository.
|
|
</Warning>
|
|
|
|
## Release Process
|
|
|
|
1. **Bump version** using bumpversion
|
|
2. **Push tag** to trigger CI/CD
|
|
3. **GitHub Actions** builds and signs releases
|
|
4. **Users** receive update notification
|
|
|
|
## User Experience
|
|
|
|
When an update is available:
|
|
|
|
1. User sees a notification dialog
|
|
2. User clicks "Update"
|
|
3. Update downloads in background
|
|
4. App restarts with new version
|
|
|
|
## For Developers
|
|
|
|
See the full documentation files for:
|
|
|
|
- Setting up signing keys
|
|
- Configuring GitHub releases
|
|
- Testing updates locally
|
|
- Troubleshooting update failures
|
|
|
|
<Card title="View Full Docs" href="https://github.com/jamiepine/voicebox/tree/main/docs">
|
|
Access AUTOUPDATER.md and AUTOUPDATER_QUICKSTART.md in the repository
|
|
</Card>
|