Speakr is a personal, self-hosted web application designed for transcribing audio recordings
Python
Add PostgreSQL support and update configuration examples
Szymon Sakowiczfbd1b270e645
diff --git a/config/env.asr.example b/config/env.asr.exampleindex e9195b25..a588c15e 100644--- a/config/env.asr.example+++ b/config/env.asr.example@@ -183,5 +183,8 @@ SUMMARY_QUEUE_WORKERS=2JOB_MAX_RETRIES=3# --- Docker Settings (rarely need to be changed) ---+# Database URI - SQLite (default) or PostgreSQLSQLALCHEMY_DATABASE_URI=sqlite:////data/instance/transcriptions.db+# For PostgreSQL, use: postgresql://username:password@hostname:5432/database_name+# Example: postgresql://speakr:password@postgres:5432/speakrUPLOAD_FOLDER=/data/uploadsdiff --git a/config/env.whisper.example b/config/env.whisper.exampleindex 862b30f4..69396c52 100644--- a/config/env.whisper.example+++ b/config/env.whisper.example@@ -185,5 +185,8 @@ SUMMARY_QUEUE_WORKERS=2JOB_MAX_RETRIES=3# --- Docker Settings (rarely need to be changed) ---+# Database URI - SQLite (default) or PostgreSQLSQLALCHEMY_DATABASE_URI=sqlite:////data/instance/transcriptions.db+# For PostgreSQL, use: postgresql://username:password@hostname:5432/database_name+# Example: postgresql://speakr:password@postgres:5432/speakrUPLOAD_FOLDER=/data/uploadsdiff --git a/config/env.whisperx.example b/config/env.whisperx.exampleindex c524b707..80b56889 100644--- a/config/env.whisperx.example+++ b/config/env.whisperx.example@@ -195,5 +195,8 @@ SUMMARY_QUEUE_WORKERS=2JOB_MAX_RETRIES=3# --- Docker Settings (rarely need to be changed) ---+# Database URI - SQLite (default) or PostgreSQLSQLALCHEMY_DATABASE_URI=sqlite:////data/instance/transcriptions.db+# For PostgreSQL, use: postgresql://username:password@hostname:5432/database_name+# Example: postgresql://speakr:password@postgres:5432/speakrUPLOAD_FOLDER=/data/uploadsdiff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.mdindex f795123c..b985d84a 100644--- a/docs/getting-started/installation.md+++ b/docs/getting-started/installation.md@@ -262,6 +262,19 @@ mkdir -p auto-processchmod 755 auto-process```+#### Using PostgreSQL Instead of SQLite++By default, Speakr uses SQLite for its database, which is perfect for most installations and requires no additional setup.+However, if you need the scalability and concurrent access capabilities of PostgreSQL, Speakr fully supports it.++**Configuration:**++To use PostgreSQL, set the `SQLALCHEMY_DATABASE_URI` environment variable in your `.env` file:++```bash+SQLALCHEMY_DATABASE_URI=postgresql://username:password@hostname:5432/database_name+```+### Step 7: Launch SpeakrWith everything configured, you're ready to start Speakr. The `-d` flag runs the container in detached mode, meaning it continues running in the background:@@ -851,4 +864,4 @@ For storage performance, use SSD drives for the Docker volumes. The database ben----Next: [User Guide](../user-guide/index.md) to learn how to use all of Speakr's features\ No newline at end of file+Next: [User Guide](../user-guide/index.md) to learn how to use all of Speakr's featuresdiff --git a/requirements.txt b/requirements.txtindex a3437f4f..bf95978c 100644--- a/requirements.txt+++ b/requirements.txt@@ -21,3 +21,4 @@ numpy==1.24.3sentence-transformers==2.7.0scikit-learn==1.3.0huggingface-hub>=0.19.0+psycopg2-binary>=2.9.0