Update README and documentation for Linux support and Docker usage

- Revised README to include links for downloading the latest releases for macOS, Windows, and Linux.
- Added detailed instructions for running Voicebox with Docker, including Docker Compose usage.
- Updated installation documentation to reflect Linux availability and provide specific download options for AppImage and Deb packages.
- Enhanced clarity in Docker documentation regarding accessing the web UI.
This commit is contained in:
Jamie Pine
2026-02-02 03:34:20 -08:00
parent 53b1e8868c
commit 732d35ca89
4 changed files with 56 additions and 20 deletions
+21 -13
View File
@@ -80,28 +80,35 @@ Download a voice model, clone any voice from a few seconds of audio, and compose
| Platform | Download |
| --------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| macOS (Apple Silicon) | [voicebox_aarch64.app.tar.gz](https://github.com/jamiepine/voicebox/releases/download/v0.1.0/voicebox_aarch64.app.tar.gz) |
| macOS (Intel) | [voicebox_x64.app.tar.gz](https://github.com/jamiepine/voicebox/releases/download/v0.1.0/voicebox_x64.app.tar.gz) |
| Windows (MSI) | [voicebox_0.1.0_x64_en-US.msi](https://github.com/jamiepine/voicebox/releases/download/v0.1.0/voicebox_0.1.0_x64_en-US.msi) |
| Windows (Setup) | [voicebox_0.1.0_x64-setup.exe](https://github.com/jamiepine/voicebox/releases/download/v0.1.0/voicebox_0.1.0_x64-setup.exe) |
| macOS (Apple Silicon) | [Download latest release](https://github.com/jamiepine/voicebox/releases/latest) |
| macOS (Intel) | [Download latest release](https://github.com/jamiepine/voicebox/releases/latest) |
| Windows (MSI) | [Download latest release](https://github.com/jamiepine/voicebox/releases/latest) |
| Windows (Setup) | [Download latest release](https://github.com/jamiepine/voicebox/releases/latest) |
| Linux (AppImage) | [Download latest release](https://github.com/jamiepine/voicebox/releases/latest) |
| Linux (Deb) | [Download latest release](https://github.com/jamiepine/voicebox/releases/latest) |
> **Linux desktop builds coming soon** — Currently blocked by GitHub runner disk space limitations.
### Docker
### Docker (Server Deployment)
Run Voicebox with the web UI in Docker:
Run Voicebox with the web UI in Docker - perfect for servers and headless deployments:
```bash
# CPU-only (supports amd64 and arm64)
docker run -p 8000:8000 -v voicebox-data:/app/data \
ghcr.io/jamiepine/voicebox:latest
# NVIDIA GPU
# NVIDIA GPU (recommended for performance)
docker run --gpus all -p 8000:8000 -v voicebox-data:/app/data \
ghcr.io/jamiepine/voicebox:latest-cuda
```
See [Docker Deployment Guide](docs/plans/DOCKER_DEPLOYMENT.md) for full documentation.
Or use Docker Compose:
```bash
docker compose up -d
```
Open http://localhost:8000 to access the web UI.
See [Docker Deployment Guide](docs/overview/docker.mdx) for cloud deployments, GPU setup, and more.
---
@@ -153,9 +160,10 @@ Create multi-voice narratives, podcasts, and conversations with a timeline-based
### Flexible Deployment
- **Local mode** — Everything runs on your machine
- **Remote mode** — Connect to a GPU server on your network
- **One-click server** — Turn any machine into a Voicebox server
- **Desktop app** — Native apps for macOS, Windows, and Linux
- **Docker** — Deploy to servers with the web UI included
- **Remote mode** — Connect desktop app to a remote GPU server
- **Cloud ready** — Deploy to AWS, GCP, DigitalOcean, or any cloud provider
---
+4 -4
View File
@@ -23,7 +23,7 @@ Voicebox is available as Docker images that include both the backend API and web
ghcr.io/jamiepine/voicebox:latest-cuda
```
Open http://localhost:8000 in your browser.
Then open http://localhost:8000 to access the web UI.
</Tab>
<Tab title="CPU Only">
@@ -33,7 +33,7 @@ Voicebox is available as Docker images that include both the backend API and web
ghcr.io/jamiepine/voicebox:latest
```
Open http://localhost:8000 in your browser.
Then open http://localhost:8000 to access the web UI.
</Tab>
<Tab title="Docker Compose">
@@ -44,10 +44,10 @@ Voicebox is available as Docker images that include both the backend API and web
docker compose up -d
# CPU-only variant
docker compose -f docker-compose.cpu.yml up -d
docker compose -f docker-compose-cpu.yml up -d
```
Open http://localhost:8000 in your browser.
Then open http://localhost:8000 to access the web UI.
</Tab>
</Tabs>
+31 -3
View File
@@ -5,15 +5,18 @@ description: "Download and install Voicebox on macOS, Windows, or Linux"
## Download
Voicebox is available for macOS and Windows, with Linux builds coming soon.
Voicebox is available for macOS, Windows, and Linux.
<CardGroup cols={3}>
<CardGroup cols={4}>
<Card title="macOS" icon="apple">
Download for Apple Silicon or Intel Macs
</Card>
<Card title="Windows" icon="windows">
Download MSI installer or Setup executable
</Card>
<Card title="Linux" icon="linux">
Download AppImage or Deb package
</Card>
<Card title="Docker" icon="docker" href="/overview/docker">
Run with web UI in a container
</Card>
@@ -63,8 +66,33 @@ Voicebox is available for macOS and Windows, with Linux builds coming soon.
### Linux
<Tabs>
<Tab title="AppImage">
Download: [voicebox_x86_64.AppImage](https://github.com/jamiepine/voicebox/releases/latest)
```bash
# Make executable
chmod +x voicebox_x86_64.AppImage
# Run
./voicebox_x86_64.AppImage
```
</Tab>
<Tab title="Debian/Ubuntu">
Download: [voicebox_amd64.deb](https://github.com/jamiepine/voicebox/releases/latest)
```bash
# Install
sudo dpkg -i voicebox_amd64.deb
# Run
voicebox
```
</Tab>
</Tabs>
<Note>
Linux desktop builds are coming soon. For server deployments, use [Docker](/overview/docker).
For headless server deployments, use [Docker](/overview/docker) instead of the desktop app.
</Note>
## First Launch
Binary file not shown.