Standalone Deployment
Desktop application deployment
Standalone Deployment
Deploy Orbis as a single-user desktop application.
Overview
Standalone mode provides:
- Local SQLite database
- No server required
- Single-user access
- Desktop integration
- Offline capability
Building for Desktop
Prerequisites
- Rust toolchain
- Node.js 18+
- Tauri CLI
Build Commands
bash
# Install dependencies
cd orbis
bun install
# Build for current platform
bun run tauri build
# Output location
# Windows: target/release/bundle/msi/
# macOS: target/release/bundle/dmg/
# Linux: target/release/bundle/appimage/ Cross-Platform Builds
bash
# On Windows
bun run tauri build
# Output: Orbis_x.x.x_x64_en-US.msi bash
# On macOS
bun run tauri build
# Output: Orbis_x.x.x_x64.dmg bash
# On Linux
bun run tauri build
# Outputs:
# - Orbis_x.x.x_amd64.AppImage
# - Orbis_x.x.x_amd64.deb Installation
- Download
.msiinstaller - Run installer
- Follow installation wizard
- Launch from Start Menu
- Download
.dmgfile - Open DMG
- Drag Orbis to Applications
- Launch from Applications
Note: May need to allow in Security & Privacy for unsigned builds.
AppImage:
bash
chmod +x Orbis_x.x.x_amd64.AppImage
./Orbis_x.x.x_amd64.AppImage Debian/Ubuntu:
bash
sudo dpkg -i Orbis_x.x.x_amd64.deb Configuration
Data Directory
Default locations:
| Platform | Location |
|---|---|
| Windows | %APPDATA%\Orbis\ |
| macOS | ~/Library/Application Support/Orbis/ |
| Linux | ~/.config/orbis/ |
Database Location
text
[Data Directory]/
├── orbis.db # SQLite database
├── config.toml # Configuration
└── plugins/ # Plugins directory Plugin Directory
text
[Data Directory]/plugins/
├── my-plugin/
│ ├── manifest.json
│ └── plugin.wasm Distribution
Signing
Sign with code signing certificate:
json
// Set in tauri.conf.json
{
"tauri": {
"bundle": {
"windows": {
"certificateThumbprint": "YOUR_THUMBPRINT",
"digestAlgorithm": "sha256"
}
}
}
} Sign and notarize:
bash
# Set environment
export APPLE_SIGNING_IDENTITY="Developer ID Application: Your Name"
export APPLE_ID="[email protected]"
export APPLE_PASSWORD="app-specific-password"
# Build with signing
bun run tauri build No signing required for AppImage/deb.
Auto-Update
Configure in tauri.conf.json:
json
{
"tauri": {
"updater": {
"active": true,
"endpoints": [
"https://releases.yoursite.com/orbis/latest.json"
],
"dialog": true,
"pubkey": "YOUR_PUBLIC_KEY"
}
}
} Update manifest (latest.json):
json
{
"version": "1.0.1",
"notes": "Bug fixes and improvements",
"pub_date": "2025-01-01T00:00:00Z",
"platforms": {
"darwin-x86_64": {
"signature": "...",
"url": "https://releases.yoursite.com/orbis/Orbis_1.0.1_x64.dmg.tar.gz"
},
"windows-x86_64": {
"signature": "...",
"url": "https://releases.yoursite.com/orbis/Orbis_1.0.1_x64_en-US.msi.zip"
},
"linux-x86_64": {
"signature": "...",
"url": "https://releases.yoursite.com/orbis/Orbis_1.0.1_amd64.AppImage.tar.gz"
}
}
} Backup and Migration
Backup
bash
# Copy entire data directory
cp -r ~/.config/orbis/ ~/orbis-backup/ Restore
bash
# Restore from backup
cp -r ~/orbis-backup/ ~/.config/orbis/ Migration to Server
Export data for server import:
bash
# Export SQLite to SQL
sqlite3 ~/.config/orbis/orbis.db .dump > export.sql
# Import to PostgreSQL (with adjustments)
psql orbis < export.sql Troubleshooting
Application Won’t Start
-
Check logs:
- Windows: Event Viewer
- macOS: Console.app
- Linux:
~/.config/orbis/logs/
-
Reset configuration:
bash
rm -rf ~/.config/orbis/config.toml Database Corruption
- Backup current database
- Run integrity check:
bash
sqlite3 ~/.config/orbis/orbis.db "PRAGMA integrity_check;" - If corrupted, restore from backup or recreate
Plugin Issues
- Check plugin compatibility
- View plugin logs
- Disable problematic plugins:
bash
mv ~/.config/orbis/plugins/bad-plugin ~/.config/orbis/plugins-disabled/ Best Practices
- Regular backups - Backup data directory regularly
- Update plugins - Keep plugins updated
- Monitor disk space - SQLite can grow large
- Check for updates - Install security updates
On This Page
- Standalone Deployment
- Overview
- Building for Desktop
- Prerequisites
- Build Commands
- Cross-Platform Builds
- Installation
- Configuration
- Data Directory
- Database Location
- Plugin Directory
- Distribution
- Signing
- Auto-Update
- Backup and Migration
- Backup
- Restore
- Migration to Server
- Troubleshooting
- Application Won’t Start
- Database Corruption
- Plugin Issues
- Best Practices