Update repository links and prefer Makefile workflow

Repository migration:
- Updated primary repository to GitLab: uncloseai-speech
- Original GitHub repo (russellballestrini/openedai-speech) was archived
- New GitHub mirror: matatonic/openedai-speech
- Updated git remotes to reflect new URLs

README improvements:
- Added Makefile-based workflow as recommended installation method
- Reorganized installation section: Makefile first, Docker second, manual third
- Updated voice compatibility info (removed Silero OpenAI aliases)
- Added note about optional model parameter and auto-detection
- Referenced docs/CLAUDE.md for detailed Makefile usage

🦝 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Russell Ballestrini 2025-11-09 15:19:59 -05:00
parent 32393c7665
commit 04e4e5ae84

102
README.md
View file

@ -2,11 +2,11 @@
🦝 **Raccoon Mission Fork:** Rescuing abandoned TTS models and building a unified, resilient text-to-speech system.
**Mirrors:**
- Primary: https://git.unturf.com/engineering/unturf/openedai-speech
- GitHub: https://github.com/russellballestrini/openedai-speech
**Repository:**
- Primary: https://git.unturf.com/engineering/unturf/uncloseai-speech (GitLab)
- Mirror: https://github.com/matatonic/openedai-speech (GitHub - original archived)
**Original Notice:** This software was mostly obsolete and no longer updated by the original maintainer.
**Original Notice:** The original `openedai-speech` project was archived and no longer maintained. This is the active fork.
**Raccoon Mission:** We're bringing it back to life with:
- ✅ Working Piper TTS (tts-1) - 55 voices, fast CPU inference
@ -30,10 +30,11 @@ An OpenAI API compatible text to speech server.
* A free, private, text-to-speech server with custom voice cloning
Full Compatibility:
* `tts-1`: `alloy`, `echo`, `fable`, `onyx`, `nova`, and `shimmer` (configurable)
* `tts-1`: `alloy`, `echo`, `fable`, `onyx`, `nova`, and `shimmer` (configurable, 100+ Piper voices available)
* `tts-1-hd`: `alloy`, `echo`, `fable`, `onyx`, `nova`, and `shimmer` (configurable, uses OpenAI samples by default)
* `tts-1-silero`: `alloy`, `echo`, `fable`, `onyx`, `nova`, and `shimmer` (148 total voices available)
* `tts-1-kokoro`: `alloy`, `echo`, `fable`, `onyx`, `nova`, and `shimmer` (34 total voices available)
* `tts-1-silero`: 148 voices with native names (`en_0`, `en_1`, etc.) across 5 languages (English, Russian, German, Spanish, French)
* `tts-1-kokoro`: `alloy`, `echo`, `fable`, `onyx`, `nova`, `shimmer` (OpenAI-themed voices) + 34 native voices
* `model` parameter is optional - voice auto-detection automatically selects the correct engine
* response_format: `mp3`, `opus`, `aac`, `flac`, `wav` and `pcm`
* speed 0.25-4.0 (and more)
@ -192,14 +193,47 @@ Version: 0.7.3, 2024-03-20
## Installation instructions
### Create a `speech.env` environment file
### Recommended: Makefile-based workflow
The project includes a comprehensive Makefile for deployment and development. See available commands:
```bash
make help
```
#### Quick Start with Makefile
1. **Create deployment configuration** (if deploying to remote server):
```bash
cp vars.sh.example vars.sh
# Edit vars.sh with your server details
```
2. **Deploy to remote server**:
```bash
make deploy # Sync files, rebuild container, restart
make voices # Download Piper + XTTS voice models
make test # Test the API
make logs # View live logs
```
3. **Local development**:
```bash
make local-deploy # Deploy locally with docker compose
```
See `docs/CLAUDE.md` for detailed Makefile usage and development workflow.
### Alternative: Manual Docker setup
#### Create a `speech.env` environment file
Copy the `sample.env` to `speech.env` (customize if needed)
```bash
cp sample.env speech.env
```
#### Defaults
**Defaults:**
```bash
TTS_HOME=voices
HF_HOME=voices
@ -209,7 +243,29 @@ HF_HOME=voices
#USE_ROCM=1
```
### Option A: Manual installation
#### Docker Images
**Nvidia GPU (cuda)**
```shell
docker compose up
```
**AMD GPU (ROCm support)**
```shell
docker compose -f docker-compose.rocm.yml up
```
**ARM64 (Apple M-series, Raspberry Pi)**
> XTTS only has CPU support here and will be very slow, you can use the Nvidia image for XTTS with CPU (slow), or use the piper only image (recommended)
**CPU only, No GPU (piper only)**
> For a minimal docker image with only piper support (<1GB vs. 8GB).
```shell
docker compose -f docker-compose.min.yml up
```
### Alternative: Manual Python installation
```shell
# install curl and ffmpeg
sudo apt install curl ffmpeg
@ -226,32 +282,6 @@ bash startup.sh
> On first run, the voice models will be downloaded automatically. This might take a while depending on your network connection.
### Option B: Docker Image (*recommended*)
#### Nvidia GPU (cuda)
```shell
docker compose up
```
#### AMD GPU (ROCm support)
```shell
docker compose -f docker-compose.rocm.yml up
```
#### ARM64 (Apple M-series, Raspberry Pi)
> XTTS only has CPU support here and will be very slow, you can use the Nvidia image for XTTS with CPU (slow), or use the piper only image (recommended)
#### CPU only, No GPU (piper only)
> For a minimal docker image with only piper support (<1GB vs. 8GB).
```shell
docker compose -f docker-compose.min.yml up
```
## Server Options
```shell