Speakr is a personal, self-hosted web application designed for transcribing audio recordings
Python
updated setup
Murtaza Nasirf0fac3c262af
diff --git a/.gitignore b/.gitignoreindex 9fb64d1d..3d9d256c 100644--- a/.gitignore+++ b/.gitignore@@ -11,4 +11,5 @@ __pycache__/.migrate/project_files.md*.md-notes.md\ No newline at end of file+notes.md+docker-compose.yml\ No newline at end of filediff --git a/docker-compose.example.yml b/docker-compose.example.ymlnew file mode 100644index 00000000..b1e9a957--- /dev/null+++ b/docker-compose.example.yml@@ -0,0 +1,40 @@+version: '3.8'++services:+ app:+ image: learnedmachine/speakr:latest+ container_name: speakr+ restart: unless-stopped+ ports:+ - "8899:8899"+ volumes:+ - speakr-uploads:/data/uploads+ - speakr-instance:/data/instance+ environment:+ # Database and upload folder configuration+ - SQLALCHEMY_DATABASE_URI=sqlite:////data/instance/transcriptions.db+ - UPLOAD_FOLDER=/data/uploads++ # Text model configuration+ - TEXT_MODEL_BASE_URL=https://openrouter.ai/api/v1+ - TEXT_MODEL_API_KEY=your_text_model_api_key_here+ - TEXT_MODEL_NAME=openai/gpt-4o-mini++ # Whisper model configuration+ - TRANSCRIPTION_BASE_URL=http://your_local_api_url:port/v1/+ - TRANSCRIPTION_API_KEY=your_transcription_api_key_here+ - WHISPER_MODEL=Systran/faster-distil-whisper-large-v3++ # Application settings+ - ALLOW_REGISTRATION=false++ # Admin user creation+ - ADMIN_USERNAME=admin+ - ADMIN_PASSWORD=securepassword++volumes:+ speakr-uploads:+ name: speakr-uploads+ speakr-instance:+ name: speakr-instancediff --git a/portainer-stack.yml b/portainer-stack.ymlnew file mode 100644index 00000000..aaea99b6--- /dev/null+++ b/portainer-stack.yml@@ -0,0 +1,40 @@+services:+ app:+ image: learnedmachine/speakr:latest+ container_name: speakr+ restart: unless-stopped+ ports:+ - "8899:8899"+ volumes:+ - speakr-uploads:/data/uploads+ - speakr-instance:/data/instance+ environment:+ # Database and upload folder configuration+ - SQLALCHEMY_DATABASE_URI=sqlite:////data/instance/transcriptions.db+ - UPLOAD_FOLDER=/data/uploads++ # Text model configuration+ - TEXT_MODEL_BASE_URL=https://openrouter.ai/api/v1+ - TEXT_MODEL_API_KEY=your_text_model_api_key_here+ - TEXT_MODEL_NAME=openai/gpt-4o-mini++ # Whisper model configuration+ - TRANSCRIPTION_BASE_URL=http://your_local_api_url:port/v1/+ - TRANSCRIPTION_API_KEY=your_transcription_api_key_here+ - WHISPER_MODEL=Systran/faster-distil-whisper-large-v3++ # Application settings+ - ALLOW_REGISTRATION=false++ # Admin user creation+ - ADMIN_USERNAME=murtaza+ - ADMIN_PASSWORD=ukX8!jHKAR^XJN++volumes:+ speakr-uploads:+ external: true+ name: speakr-uploads+ speakr-instance:+ external: true+ name: speakr-instancediff --git a/readme.md b/readme.mdindex 86bf8c19..75946ef9 100644--- a/readme.md+++ b/readme.md@@ -85,17 +85,53 @@ The easiest way to deploy Speakr is using Docker and docker-compose.volumes:- ./uploads:/data/uploads- ./instance:/data/instance- env_file:- - .env+ environment:+ # Database and upload folder configuration+ - SQLALCHEMY_DATABASE_URI=sqlite:////data/instance/transcriptions.db+ - UPLOAD_FOLDER=/data/uploads++ # Text model configuration+ - TEXT_MODEL_BASE_URL=https://openrouter.ai/api/v1+ - TEXT_MODEL_API_KEY=your_text_model_api_key_here+ - TEXT_MODEL_NAME=openai/gpt-4o-mini++ # Whisper model configuration+ - TRANSCRIPTION_BASE_URL=http://your_local_api_url:port/v1/+ - TRANSCRIPTION_API_KEY=your_transcription_api_key_here+ - WHISPER_MODEL=Systran/faster-distil-whisper-large-v3++ # Application settings+ - ALLOW_REGISTRATION=false```-2. **Create a .env file** with your configuration (see the Configuration section below).+ Alternatively, you can copy the example file:+ ```bash+ cp docker-compose.example.yml docker-compose.yml+ ```+ Then edit the file to update the environment variables with your actual values.-3. **Start the container:**+2. **Start the container:**```bashdocker compose up -d```+#### Option A.1: Deploying with Portainer++If you're using Portainer to manage your Docker containers:++1. **In Portainer:**+ - Go to Stacks → Add stack+ - Name your stack (e.g., "speakr")+ - Upload the `docker-compose.example.yml` file or paste its contents+ - Edit the environment variables with your actual values+ - Click "Deploy the stack"++2. **Important Notes for Portainer:**+ - Make sure to update all environment variables with your actual values+ - For volume persistence, you can either:+ - Use named volumes as shown in the example file+ - Or modify the volumes to use bind mounts to specific directories on your host+#### Option B: Building Locally1. **Clone the Repository:**