Speakr is a personal, self-hosted web application designed for transcribing audio recordings
Python
v0.6.1: Offline deployment improvements and HuggingFace model caching
Murtaza Nasirc2711f4c20ad
diff --git a/README.md b/README.mdindex fedfa827..298e08b1 100644--- a/README.md+++ b/README.md@@ -9,7 +9,7 @@<a href="https://www.gnu.org/licenses/agpl-3.0"><img alt="AGPL v3" src="https://img.shields.io/badge/License-AGPL_v3-blue.svg"></a><a href="https://github.com/murtaza-nasir/speakr/actions/workflows/docker-publish.yml"><img alt="Docker Build" src="https://github.com/murtaza-nasir/speakr/actions/workflows/docker-publish.yml/badge.svg"></a><a href="https://hub.docker.com/r/learnedmachine/speakr"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/learnedmachine/speakr"></a>- <a href="https://github.com/murtaza-nasir/speakr/releases/latest"><img alt="Latest Version" src="https://img.shields.io/badge/version-0.6.0-brightgreen.svg"></a>+ <a href="https://github.com/murtaza-nasir/speakr/releases/latest"><img alt="Latest Version" src="https://img.shields.io/badge/version-0.6.1-brightgreen.svg"></a></p><p align="center">@@ -145,18 +145,15 @@ Complete documentation is available at **[murtaza-nasir.github.io/speakr](https:- [Troubleshooting](https://murtaza-nasir.github.io/speakr/troubleshooting) - Common issues and solutions- [FAQ](https://murtaza-nasir.github.io/speakr/faq) - Frequently asked questions-## Latest Release (v0.6.0)+## Latest Release (v0.6.1)-**Feature Release** - Multi-user job queue and processing improvements+**Maintenance Release** - Offline deployment improvements-- **Multi-User Job Queue** - Fair round-robin scheduling ensures equitable processing across users-- **Unified Progress Tracking** - Single consolidated view of uploads and processing status-- **Smart Polling** - Intelligent polling that only runs when needed, reducing server load-- **Compact Processing Queue UI** - Redesigned progress popup with status indicators-- **Video Format Support** - Added comprehensive video format support (MP4, MKV, AVI, MOV, etc.)-- **Firefox System Audio** - Fixed system audio recording in Firefox+- **HuggingFace Model Caching** - Embedding model now persists across container restarts+- **Offline Documentation** - Added comprehensive offline deployment guidance+- **Inquire Mode Reliability** - Model loads from cache after initial download, no network required-Fully backward compatible with v0.5.10. No configuration changes required.+Fully backward compatible with v0.6.0. No configuration changes required.### Previous Release (v0.5.10)diff --git a/VERSION b/VERSIONindex 60f63432..14909610 100644--- a/VERSION+++ b/VERSION@@ -1 +1 @@-v0.6.0+v0.6.1diff --git a/docs/faq.md b/docs/faq.mdindex e932aaf2..85e3503f 100644--- a/docs/faq.md+++ b/docs/faq.md@@ -56,6 +56,16 @@ docker run -d -p 9000:9000 \Note: If you don't need speaker identification in your transcriptions, you can use Speakr with the standard Whisper API instead, which doesn't require this additional container.+### Can Speakr run offline?++Yes, Speakr can run completely offline once set up. The Docker image contains all dependencies. For offline use:++- Use a local ASR endpoint (like the WhisperX container) for transcription+- Use Ollama or another local LLM for summaries+- **Inquire Mode**: The embedding model downloads automatically on first use and caches to `instance/huggingface/`. After the initial download, it loads from cache without needing internet access.++Run Speakr once with internet access to cache the embedding model, then disconnect - everything works offline.+### How do I backup my Speakr data?Your Speakr data consists of three essential components: the SQLite database in the `instance/` directory, audio files and transcriptions in the `uploads/` directory, and your configuration in the `.env` file. To create a complete backup, stop the container first to ensure database consistency, then backup all three directories:diff --git a/docs/troubleshooting.md b/docs/troubleshooting.mdindex cda85d7a..0d4fcc2a 100644--- a/docs/troubleshooting.md+++ b/docs/troubleshooting.md@@ -159,6 +159,8 @@ In many jurisdictions, you must inform participants they're being recorded. EnabSpeakr can run completely offline as all dependencies are built into the Docker image. For offline deployments, use local models via Ollama for [text generation](features.md#automatic-summarization) and ensure your ASR endpoint is hosted locally. The system will work without internet access once properly configured.+**Inquire Mode (Semantic Search)**: If you use Inquire Mode, the embedding model (all-MiniLM-L6-v2) is automatically cached in the persistent `instance/huggingface/` directory on first use. Run Speakr once with internet access to download the model, then it will load from cache on subsequent restarts - no network required.+### Non-Docker InstallationWhile Docker is the only officially supported installation method, you can attempt manual installation using npm and Python. You'll need to handle dependencies, environment setup, and configuration yourself. This approach is not recommended for regular use and you'll need to troubleshoot issues independently.