Speakr
Application Docker from learnedmachine's Repository
Vue d'ensemble
Speakr is a self-hosted AI transcription and intelligent note-taking platform. Transform your audio recordings into organized, searchable, and intelligent notes with speaker identification, AI chat, semantic search, and collaboration features.
Key Features:
- AI-powered transcription with speaker identification
- Voice profiles for automatic speaker recognition
- Interactive chat with your recordings
- Semantic search across all recordings (Inquire Mode)
- Internal sharing and group collaboration
- Smart tagging with custom AI prompts
- Auto-deletion and retention policies
- Automated export to Obsidian/Logseq
- Full internationalization (EN, ES, FR, DE, ZH)
- Light/dark themes with customizable colors
IMPORTANT: Requires API keys for OpenAI/OpenRouter or local AI services for transcription and text generation.
Exigences
Before starting, you MUST configure API keys:
1. Create a .env file or use environment variables
2. Set TEXT_MODEL_API_KEY (OpenRouter or OpenAI)
3. Set TRANSCRIPTION_API_KEY (OpenAI Whisper)
4. Set ADMIN_USERNAME and ADMIN_PASSWORD
See the GitHub documentation for complete setup instructions.
Arguments d'exécution
- Interface utilisateur Web
http://[IP]:[PORT:8899]- Réseau
bridge- Coquille
sh- Privilégié
- false
Configuration du modèle
Web interface port
- Cible
- 8899
- Défaut
- 8899
- Valeur
- 8899
Storage for uploaded audio files
- Cible
- /data/uploads
- Défaut
- /mnt/user/appdata/speakr/uploads
- Valeur
- /mnt/user/appdata/speakr/uploads
Database and application state
- Cible
- /data/instance
- Défaut
- /mnt/user/appdata/speakr/instance
- Valeur
- /mnt/user/appdata/speakr/instance
Exported transcriptions (for Obsidian, etc.)
- Cible
- /data/exports
- Défaut
- /mnt/user/appdata/speakr/exports
- Valeur
- /mnt/user/appdata/speakr/exports
Watch directory for automatic file processing
- Cible
- /data/auto-process
- Défaut
- /mnt/user/appdata/speakr/auto-process
- Valeur
- /mnt/user/appdata/speakr/auto-process
API key for OpenRouter or OpenAI (required for summaries)
- Cible
- TEXT_MODEL_API_KEY
API endpoint for text generation
- Cible
- TEXT_MODEL_BASE_URL
- Défaut
- https://openrouter.ai/api/v1
- Valeur
- https://openrouter.ai/api/v1
Model name for text generation
- Cible
- TEXT_MODEL_NAME
- Défaut
- openai/gpt-4o-mini
- Valeur
- openai/gpt-4o-mini
OpenAI API key for Whisper transcription (required)
- Cible
- TRANSCRIPTION_API_KEY
Whisper API endpoint
- Cible
- TRANSCRIPTION_BASE_URL
- Défaut
- https://api.openai.com/v1
- Valeur
- https://api.openai.com/v1
Whisper model to use
- Cible
- WHISPER_MODEL
- Défaut
- whisper-1
- Valeur
- whisper-1
Initial admin username
- Cible
- ADMIN_USERNAME
- Défaut
- admin
- Valeur
- admin
Initial admin email
- Cible
- ADMIN_EMAIL
- Défaut
- admin@example.com
- Valeur
- admin@example.com
Initial admin password (CHANGE THIS!)
- Cible
- ADMIN_PASSWORD
Allow new user registration (true/false)
- Cible
- ALLOW_REGISTRATION
- Défaut
- false
- Valeur
- false
Timezone for date/time display (e.g., America/New_York)
- Cible
- TIMEZONE
- Défaut
- UTC
- Valeur
- UTC
Logging level: DEBUG, INFO, WARNING, ERROR
- Cible
- LOG_LEVEL
- Défaut
- INFO
- Valeur
- INFO
Maximum tokens for AI summaries
- Cible
- SUMMARY_MAX_TOKENS
- Défaut
- 8000
- Valeur
- 8000
Maximum tokens for chat responses
- Cible
- CHAT_MAX_TOKENS
- Défaut
- 5000
- Valeur
- 5000
Split large files for API limits (true/false)
- Cible
- ENABLE_CHUNKING
- Défaut
- true
- Valeur
- true
Chunk size limit (e.g., 20MB or 1200s)
- Cible
- CHUNK_LIMIT
- Défaut
- 20MB
- Valeur
- 20MB
Overlap between chunks in seconds
- Cible
- CHUNK_OVERLAP_SECONDS
- Défaut
- 3
- Valeur
- 3
Enable AI-powered semantic search across recordings (true/false)
- Cible
- ENABLE_INQUIRE_MODE
- Défaut
- false
- Valeur
- false
Watch directory for automatic file processing (true/false)
- Cible
- ENABLE_AUTO_PROCESSING
- Défaut
- false
- Valeur
- false
Processing mode: admin_only, user_directories, or single_user
- Cible
- AUTO_PROCESS_MODE
- Défaut
- admin_only
- Valeur
- admin_only
Check interval for new files (seconds)
- Cible
- AUTO_PROCESS_CHECK_INTERVAL
- Défaut
- 30
- Valeur
- 30
Automatically export transcriptions to markdown (true/false)
- Cible
- ENABLE_AUTO_EXPORT
- Défaut
- false
- Valeur
- false
Include transcription in exports (true/false)
- Cible
- AUTO_EXPORT_TRANSCRIPTION
- Défaut
- true
- Valeur
- true
Include summary in exports (true/false)
- Cible
- AUTO_EXPORT_SUMMARY
- Défaut
- true
- Valeur
- true
Enable automatic deletion of old recordings (true/false)
- Cible
- ENABLE_AUTO_DELETION
- Défaut
- false
- Valeur
- false
Days to retain recordings (0 = disabled)
- Cible
- GLOBAL_RETENTION_DAYS
- Défaut
- 90
- Valeur
- 90
Deletion mode: audio_only or full_recording
- Cible
- DELETION_MODE
- Défaut
- audio_only
- Valeur
- audio_only
Allow users to delete their own recordings (true/false)
- Cible
- USERS_CAN_DELETE
- Défaut
- true
- Valeur
- true
Enable user-to-user sharing (true/false)
- Cible
- ENABLE_INTERNAL_SHARING
- Défaut
- false
- Valeur
- false
Display usernames in interface (true/false)
- Cible
- SHOW_USERNAMES_IN_UI
- Défaut
- false
- Valeur
- false
Allow public share links (true/false)
- Cible
- ENABLE_PUBLIC_SHARING
- Défaut
- true
- Valeur
- true
Database connection string
- Cible
- SQLALCHEMY_DATABASE_URI
- Défaut
- sqlite:////data/instance/transcriptions.db
- Valeur
- sqlite:////data/instance/transcriptions.db
Télécharger les statistiques
Total des téléchargements au fil du temps
Détails
learnedmachine/speakrExécutez Speakr sur Unraid.
Speakr est listé dans Community Apps pour Unraid OS. Explorez Unraid pour créer un serveur domestique flexible, un NAS ou un laboratoire domestique.