Installation
SoftDB ships as a native desktop app for all three major platforms. Pick your platform below and you’ll be up and running in a few minutes.
Download
Section titled “Download”Grab the latest release from the GitHub Releases page.
| Platform | File | Notes |
|---|---|---|
| Windows | SoftDB-amd64-installer.exe | NSIS installer with shortcuts and uninstaller |
| macOS | SoftDB-darwin-arm64.dmg | Apple Silicon native; Intel Macs via Rosetta 2 |
| Linux | SoftDB-linux-amd64.AppImage | Portable — no install needed |
| Linux (Debian/Ubuntu) | SoftDB-linux-amd64.deb | System package with desktop integration |
Platform Instructions
Section titled “Platform Instructions”-
Download
SoftDB-amd64-installer.exefrom the Releases page. -
Run the installer. Windows may show a SmartScreen warning for unsigned apps — click More info then Run anyway.
-
Follow the setup wizard. SoftDB installs to
%LOCALAPPDATA%\SoftDBby default and adds a Start Menu shortcut. -
Launch SoftDB from the Start Menu or desktop shortcut.
To uninstall, use Add or Remove Programs in Windows Settings.
-
Download
SoftDB-darwin-arm64.dmgfrom the Releases page. -
Open the
.dmgfile and drag SoftDB to your Applications folder. -
Launch SoftDB from Applications or Spotlight.
Allowing SoftDB on macOS
Section titled “Allowing SoftDB on macOS”Because SoftDB is distributed outside the Mac App Store and is not yet notarized by Apple, macOS Gatekeeper will block it on first launch. You’ll see a message like “SoftDB can’t be opened because Apple cannot check it for malicious software” or “SoftDB is damaged and can’t be opened”.
There are two ways to fix this:
Method 1 — System Settings (recommended)
-
Try to open SoftDB — macOS will block it. Click OK to dismiss the dialog.
-
Open System Settings → Privacy & Security.
-
Scroll down. You’ll see a message: “SoftDB was blocked from use because it is not from an identified developer.”
-
Click Open Anyway and enter your password when prompted.
-
macOS will ask one more time — click Open to confirm. SoftDB will launch normally from now on.
Method 2 — Terminal (if Method 1 doesn’t work)
If you see the “damaged and can’t be opened” error, macOS has quarantined the file. Remove the quarantine flag with:
xattr -cr /Applications/SoftDB.appThen open SoftDB again — it should launch without issues.
Install via Homebrew
Section titled “Install via Homebrew”The easiest way to install on macOS — no Gatekeeper prompts:
brew tap zane-tv/softdbbrew install --cask softdbTo update later:
brew upgrade --cask softdbAppImage (any distro):
-
Download
SoftDB-linux-amd64.AppImage. -
Make it executable:
Terminal window chmod +x SoftDB-linux-amd64.AppImage -
Run it:
Terminal window ./SoftDB-linux-amd64.AppImage
Debian/Ubuntu (.deb):
-
Download
SoftDB-linux-amd64.deb. -
Install with dpkg:
Terminal window sudo dpkg -i SoftDB-linux-amd64.deb -
Launch from your application menu or run
softdbin a terminal.
Verify Downloads
Section titled “Verify Downloads”All release binaries are signed with Sigstore for supply chain security. Each file has a corresponding .bundle signature file on the Releases page.
-
Install cosign:
Terminal window # macOSbrew install cosign# Go (any platform)go install github.com/sigstore/cosign/v2/cmd/cosign@latest -
Verify the downloaded file:
Terminal window cosign verify-blob SoftDB-amd64-installer.exe \--bundle SoftDB-amd64-installer.exe.bundle \--certificate-identity-regexp "https://github.com/zane-tv/soft-db" \--certificate-oidc-issuer https://token.actions.githubusercontent.comReplace
SoftDB-amd64-installer.exewith the filename you downloaded. The same command works for.dmg,.AppImage, and.debfiles. -
Or use the helper script (if you cloned the repo):
Terminal window ./scripts/verify-release.sh SoftDB-amd64-installer.exe
A successful verification prints Verified OK.
Build from Source
Section titled “Build from Source”If you want to run the latest development version or contribute to SoftDB, you can build it yourself.
Prerequisites:
- Go 1.22+
- Bun (or Node.js 18+)
- Wails CLI v3
-
Install the Wails CLI:
Terminal window go install github.com/wailsapp/wails/v3/cmd/wails3@latest -
Clone the repository:
Terminal window git clone https://github.com/zane-tv/soft-db.gitcd soft-db -
Start development mode (hot-reload for both Go and React):
Terminal window wails3 dev -
Build a production binary:
Terminal window wails3 buildThe compiled app lands in the
build/bin/directory.
What’s Next
Section titled “What’s Next”Once SoftDB is installed, head to the Quick Start guide to create your first database connection and run your first query.