mirror of
https://github.com/jamiepine/voicebox.git
synced 2026-09-19 06:40:38 -07:00
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:
@@ -80,28 +80,35 @@ Download a voice model, clone any voice from a few seconds of audio, and compose
|
|||||||
|
|
||||||
| Platform | Download |
|
| 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 (Apple Silicon) | [Download latest release](https://github.com/jamiepine/voicebox/releases/latest) |
|
||||||
| macOS (Intel) | [voicebox_x64.app.tar.gz](https://github.com/jamiepine/voicebox/releases/download/v0.1.0/voicebox_x64.app.tar.gz) |
|
| macOS (Intel) | [Download latest release](https://github.com/jamiepine/voicebox/releases/latest) |
|
||||||
| 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 (MSI) | [Download latest release](https://github.com/jamiepine/voicebox/releases/latest) |
|
||||||
| 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) |
|
| 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 - perfect for servers and headless deployments:
|
||||||
|
|
||||||
Run Voicebox with the web UI in Docker:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# CPU-only (supports amd64 and arm64)
|
# CPU-only (supports amd64 and arm64)
|
||||||
docker run -p 8000:8000 -v voicebox-data:/app/data \
|
docker run -p 8000:8000 -v voicebox-data:/app/data \
|
||||||
ghcr.io/jamiepine/voicebox:latest
|
ghcr.io/jamiepine/voicebox:latest
|
||||||
|
|
||||||
# NVIDIA GPU
|
# NVIDIA GPU (recommended for performance)
|
||||||
docker run --gpus all -p 8000:8000 -v voicebox-data:/app/data \
|
docker run --gpus all -p 8000:8000 -v voicebox-data:/app/data \
|
||||||
ghcr.io/jamiepine/voicebox:latest-cuda
|
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
|
### Flexible Deployment
|
||||||
|
|
||||||
- **Local mode** — Everything runs on your machine
|
- **Desktop app** — Native apps for macOS, Windows, and Linux
|
||||||
- **Remote mode** — Connect to a GPU server on your network
|
- **Docker** — Deploy to servers with the web UI included
|
||||||
- **One-click server** — Turn any machine into a Voicebox server
|
- **Remote mode** — Connect desktop app to a remote GPU server
|
||||||
|
- **Cloud ready** — Deploy to AWS, GCP, DigitalOcean, or any cloud provider
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ Voicebox is available as Docker images that include both the backend API and web
|
|||||||
ghcr.io/jamiepine/voicebox:latest-cuda
|
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>
|
||||||
|
|
||||||
<Tab title="CPU Only">
|
<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
|
ghcr.io/jamiepine/voicebox:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
Open http://localhost:8000 in your browser.
|
Then open http://localhost:8000 to access the web UI.
|
||||||
</Tab>
|
</Tab>
|
||||||
|
|
||||||
<Tab title="Docker Compose">
|
<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
|
docker compose up -d
|
||||||
|
|
||||||
# CPU-only variant
|
# 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>
|
</Tab>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
|
|||||||
@@ -5,15 +5,18 @@ description: "Download and install Voicebox on macOS, Windows, or Linux"
|
|||||||
|
|
||||||
## Download
|
## 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">
|
<Card title="macOS" icon="apple">
|
||||||
Download for Apple Silicon or Intel Macs
|
Download for Apple Silicon or Intel Macs
|
||||||
</Card>
|
</Card>
|
||||||
<Card title="Windows" icon="windows">
|
<Card title="Windows" icon="windows">
|
||||||
Download MSI installer or Setup executable
|
Download MSI installer or Setup executable
|
||||||
</Card>
|
</Card>
|
||||||
|
<Card title="Linux" icon="linux">
|
||||||
|
Download AppImage or Deb package
|
||||||
|
</Card>
|
||||||
<Card title="Docker" icon="docker" href="/overview/docker">
|
<Card title="Docker" icon="docker" href="/overview/docker">
|
||||||
Run with web UI in a container
|
Run with web UI in a container
|
||||||
</Card>
|
</Card>
|
||||||
@@ -63,8 +66,33 @@ Voicebox is available for macOS and Windows, with Linux builds coming soon.
|
|||||||
|
|
||||||
### Linux
|
### 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>
|
<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>
|
</Note>
|
||||||
|
|
||||||
## First Launch
|
## First Launch
|
||||||
|
|||||||
Binary file not shown.
Reference in New Issue
Block a user