11<div align =" center " >
22 <img src =" assets/logo-banner.png " alt =" OpenTranscribe Logo " width =" 400 " >
3-
3+
44 ** AI-Powered Transcription and Media Analysis Platform**
55</div >
66
@@ -165,11 +165,15 @@ curl -fsSL https://raw.githubusercontent.com/davidamacey/OpenTranscribe/master/s
165165```
166166
167167Then follow the on-screen instructions. The setup script will:
168+ - Detect your hardware (NVIDIA GPU, Apple Silicon, or CPU)
168169- Download the production Docker Compose file
169- - Configure environment variables including GPU support (default GPU device ID: 2)
170- - Help you set up your Hugging Face token (required for speaker diarization)
170+ - Configure environment variables with optimal settings for your hardware
171+ - ** Prompt for your HuggingFace token** (required for speaker diarization)
172+ - ** Automatically download and cache AI models (~ 2.5GB)** if token is provided
171173- Set up the management script (` opentranscribe.sh ` )
172174
175+ ** Note:** The script will prompt you for your HuggingFace token during setup. If you provide it, AI models will be downloaded and cached before Docker starts, ensuring the app is ready to use immediately. If you skip this step, models will download on first use (10-30 minute delay).
176+
173177Once setup is complete, start OpenTranscribe with:
174178
175179``` bash
@@ -189,7 +193,7 @@ Access the web interface at http://localhost:5173
189193 ``` bash
190194 git clone https://github.com/davidamacey/OpenTranscribe.git
191195 cd OpenTranscribe
192-
196+
193197 # Make utility script executable
194198 chmod +x opentr.sh
195199 ```
@@ -198,7 +202,7 @@ Access the web interface at http://localhost:5173
198202 ``` bash
199203 # Copy environment template
200204 cp .env.example .env
201-
205+
202206 # Edit .env file with your settings (optional for development)
203207 # Key variables:
204208 # - HUGGINGFACE_TOKEN (required for speaker diarization)
@@ -209,7 +213,7 @@ Access the web interface at http://localhost:5173
209213 ``` bash
210214 # Start in development mode (with hot reload)
211215 ./opentr.sh start dev
212-
216+
213217 # Or start in production mode
214218 ./opentr.sh start prod
215219 ```
@@ -470,7 +474,7 @@ OpenTranscribe offers flexible AI deployment options. Choose the approach that b
470474 LLM_PROVIDER=openai
471475 OPENAI_API_KEY=your_openai_key
472476 OPENAI_MODEL_NAME=gpt-4o-mini
473-
477+
474478 # Start without local LLM
475479 ./opentr.sh start dev
476480 ```
@@ -480,7 +484,7 @@ OpenTranscribe offers flexible AI deployment options. Choose the approach that b
480484 # Configure for vLLM in .env
481485 LLM_PROVIDER=vllm
482486 VLLM_MODEL_NAME=gpt-oss-20b
483-
487+
484488 # Start with vLLM service (requires 16GB+ VRAM)
485489 docker compose -f docker-compose.yml -f docker-compose.vllm.yml up
486490 ```
@@ -490,7 +494,7 @@ OpenTranscribe offers flexible AI deployment options. Choose the approach that b
490494 # Configure for Ollama in .env
491495 LLM_PROVIDER=ollama
492496 OLLAMA_MODEL_NAME=llama3.2:3b-instruct-q4_K_M
493-
497+
494498 # Edit docker-compose.vllm.yml and uncomment ollama service
495499 # Then start with both compose files
496500 docker compose -f docker-compose.yml -f docker-compose.vllm.yml up
@@ -501,7 +505,7 @@ OpenTranscribe offers flexible AI deployment options. Choose the approach that b
501505# Cloud Providers (configure in .env)
502506LLM_PROVIDER=openai # openai, anthropic, custom (openrouter)
503507OPENAI_API_KEY=your_openai_key # OpenAI GPT models
504- ANTHROPIC_API_KEY=your_claude_key # Anthropic Claude models
508+ ANTHROPIC_API_KEY=your_claude_key # Anthropic Claude models
505509OPENROUTER_API_KEY=your_or_key # OpenRouter (multi-provider)
506510
507511# Local Providers (requires additional Docker services)
@@ -511,7 +515,7 @@ LLM_PROVIDER=ollama # Local Ollama server
511515
512516** 🎯 Deployment Scenarios:**
513517- ** 💰 Cost-Effective** : OpenRouter with Claude Haiku (~ $0.25/1M tokens)
514- - ** 🔒 Privacy-First** : Local vLLM or Ollama (no data leaves your server)
518+ - ** 🔒 Privacy-First** : Local vLLM or Ollama (no data leaves your server)
515519- ** ⚡ Performance** : OpenAI GPT-4o-mini (fastest cloud option)
516520- ** 📱 Small Models** : Even 3B Ollama models can handle hours of content via intelligent sectioning
517521- ** 🚫 No LLM** : Leave ` LLM_PROVIDER ` empty for transcription-only mode
@@ -534,7 +538,7 @@ OpenTranscribe automatically downloads and caches AI models for optimal performa
534538│ ├── hub/ # WhisperX transcription models (~1.5GB)
535539│ └── transformers/ # PyAnnote transformer models
536540└── torch/ # PyTorch cache
537- ├── hub/checkpoints/ # Wav2Vec2 alignment model (~360MB)
541+ ├── hub/checkpoints/ # Wav2Vec2 alignment model (~360MB)
538542 └── pyannote/ # PyAnnote diarization models (~500MB)
539543```
540544
@@ -606,7 +610,7 @@ For production use, ensure you:
606610 # Generate strong secrets
607611 openssl rand -hex 32 # For SECRET_KEY
608612 openssl rand -hex 32 # For JWT_SECRET_KEY
609-
613+
610614 # Set strong database passwords
611615 # Configure proper firewall rules
612616 # Set up SSL/TLS certificates
@@ -616,7 +620,7 @@ For production use, ensure you:
616620 ``` bash
617621 # Use production environment
618622 NODE_ENV=production
619-
623+
620624 # Configure resource limits
621625 # Set up monitoring and logging
622626 # Configure backup strategies
@@ -628,7 +632,7 @@ For production use, ensure you:
628632 server {
629633 listen 80;
630634 server_name your-domain.com;
631-
635+
632636 location / {
633637 proxy_pass http://localhost:5173;
634638 proxy_set_header Host $host;
@@ -657,7 +661,7 @@ pytest tests/ # Run tests
657661black app/ # Format code
658662flake8 app/ # Lint code
659663
660- # Frontend development
664+ # Frontend development
661665cd frontend/
662666npm install
663667npm run dev # Development server
@@ -835,4 +839,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
835839
836840** Built with ❤️ using AI assistance and modern open-source technologies.**
837841
838- * OpenTranscribe demonstrates the power of AI-assisted development while maintaining full local control over your data and processing.*
842+ * OpenTranscribe demonstrates the power of AI-assisted development while maintaining full local control over your data and processing.*
0 commit comments