docs: clarify Docker image architecture requirements
This commit is contained in:
Yang Fan
@@ -82,6 +82,7 @@ the frozen-backend fallback mirror it for their toolchains.
|
||||
|
||||
### Docs
|
||||
|
||||
- Docker quick starts now explain the AMD64-only images and direct Apple Silicon users to the native macOS app (#1921) — thanks @yangfan-yf-yf!
|
||||
- audio.cpp (Breeze-TTS-2) is now a documented opt-in engine: prebuilt binary install, explicit GGUF download, voice modes, and the weights' research/non-commercial terms (#1891)
|
||||
|
||||
### Fixed
|
||||
|
||||
@@ -78,7 +78,7 @@ Download a package from the [latest release](https://github.com/debpalash/VoiceS
|
||||
| macOS 13.3+ | Apple Silicon DMG | [Install on macOS](docs/install/macos.md) |
|
||||
| Windows 10/11 | x64 MSI; choose the current-user build when listed to install without admin access | [Install on Windows](docs/install/windows.md#install-pre-built-msi) |
|
||||
| Linux | AppImage, x86_64 with glibc 2.39+ | [Install on Linux](docs/install/linux.md) |
|
||||
| Docker | CUDA, ROCm, CPU, and worker-only GPU profiles | [Run with Docker](docs/install/docker.md) |
|
||||
| Docker | Linux/AMD64 images; CUDA, ROCm, CPU, and worker-only GPU profiles | [Run with Docker](docs/install/docker.md) |
|
||||
|
||||
First launch creates a managed Python environment and downloads the default model. Later launches reuse both.
|
||||
|
||||
@@ -87,6 +87,11 @@ First launch creates a managed Python environment and downloads the default mode
|
||||
|
||||
### Quick Docker run
|
||||
|
||||
The published images are **`linux/amd64` only**. On Apple Silicon, use the
|
||||
[native macOS app](docs/install/macos.md) for GPU acceleration. ARM64 hosts
|
||||
should read the [architecture requirements](docs/install/docker.md#architecture)
|
||||
before pulling an image.
|
||||
|
||||
```bash
|
||||
docker run -d -p 127.0.0.1:3900:3900 -v omnivoice-data:/app/omnivoice_data --name voicestudio palashdeb/omnivoice-studio:stable
|
||||
```
|
||||
|
||||
@@ -14,12 +14,21 @@ cloning, and cinematic video dubbing — fully local, with no cloud API keys or
|
||||
|
||||
|
||||
|
||||
VoiceStudio runs entirely on your own hardware (CUDA / MPS / ROCm / CPU
|
||||
VoiceStudio runs entirely on your own hardware (CUDA / ROCm / CPU
|
||||
auto-detect) — nothing is sent to the cloud. This image is the **headless
|
||||
web-server build**: a FastAPI backend serving a pre-built React UI over HTTP, so
|
||||
you can run it on a homelab box, a GPU server, or anywhere Docker runs and open
|
||||
you can run it on an AMD64 homelab box or GPU server and open
|
||||
the UI in a browser.
|
||||
|
||||
**Architecture:** published images are **`linux/amd64` only**; there is no
|
||||
native ARM64 image. On Apple Silicon, use the
|
||||
[native macOS app](https://github.com/debpalash/VoiceStudio/blob/main/docs/install/macos.md)
|
||||
for Apple GPU acceleration; the Linux container cannot access the Mac's Apple
|
||||
GPU through MPS or MLX. Other ARM64 hosts need an AMD64 server or CPU emulation,
|
||||
which can be much slower. See the
|
||||
[architecture requirements](https://github.com/debpalash/VoiceStudio/blob/main/docs/install/docker.md#architecture)
|
||||
before pulling an image.
|
||||
|
||||
> The Tauri desktop app's auto-updater and update-channel toggle are
|
||||
> **desktop-only** and do not apply to this image — to update, pull a newer tag
|
||||
> and recreate the container.
|
||||
@@ -136,7 +145,7 @@ are mirrored on GHCR at
|
||||
- **📦 Batch Queue** — drop 50 videos and walk away; per-job progress.
|
||||
- **🤖 MCP Server** — drive VoiceStudio from Claude, Cursor, or any MCP client.
|
||||
- **🛡️ AI Watermark** — invisible AudioSeal (Meta) marking that survives compression.
|
||||
- **⚡ GPU Auto-Detect** — CUDA · MPS · ROCm · CPU, with auto-offload on ≤8 GB cards.
|
||||
- **⚡ GPU Auto-Detect** — CUDA · ROCm · CPU, with auto-offload on ≤8 GB cards.
|
||||
- **🧩 Extensible** — subclass `TTSBackend` to add any engine in ~50 lines.
|
||||
|
||||
Multiple TTS engines ship out of the box (IndexTTS, CosyVoice, Supertonic-3, and
|
||||
|
||||
@@ -7,6 +7,25 @@ it in a normal browser.
|
||||
**Official images:** [`ghcr.io/debpalash/omnivoice-studio`](https://github.com/debpalash/VoiceStudio/pkgs/container/omnivoice-studio)
|
||||
and [`palashdeb/omnivoice-studio` on Docker Hub](https://hub.docker.com/r/palashdeb/omnivoice-studio) — same images, same tags.
|
||||
|
||||
## Architecture
|
||||
|
||||
The published images are **`linux/amd64` (x86-64) only**, including `:stable`,
|
||||
`:latest`, and the ROCm variants. There is no native `linux/arm64` image.
|
||||
On an ARM64 host, pulling without an explicit platform can fail with
|
||||
`no matching manifest for linux/arm64/v8 in the manifest list entries`.
|
||||
|
||||
- **Apple Silicon (M-series Macs):** use the [native macOS app](macos.md),
|
||||
which supports Apple GPU acceleration. The Linux container cannot access
|
||||
the Mac's Apple GPU through MPS or MLX.
|
||||
- **AMD64 emulation on ARM64 (including Apple Silicon):** if your Docker
|
||||
installation supports it, place `--platform linux/amd64` **before the image
|
||||
name** in both `docker pull` and `docker run` from the CPU instructions
|
||||
below. This is an emulated CPU option, not native
|
||||
ARM64 support; inference can be much slower and is not a GPU workaround.
|
||||
Without emulation, use an AMD64 server for this Docker deployment.
|
||||
|
||||
## Image tags
|
||||
|
||||
> **Image ↔ version mapping**
|
||||
>
|
||||
> | Tag | What you get |
|
||||
|
||||
Reference in New Issue
Block a user