Speakr is a personal, self-hosted web application designed for transcribing audio recordings
Python
dockerhub
Murtaza Nasir49c38ac16894
diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.ymlnew file mode 100644index 00000000..5f89f1fb--- /dev/null+++ b/.github/workflows/docker-publish.yml@@ -0,0 +1,67 @@+name: Docker Build and Publish++on:+ push:+ branches: [ "main" ]+ tags: [ 'v*.*.*' ]+ pull_request:+ branches: [ "main" ]++env:+ # Use docker.io for Docker Hub if empty+ REGISTRY: docker.io+ # github.repository as <account>/<repo>+ IMAGE_NAME: ${{ github.repository }}++jobs:+ build:+ runs-on: ubuntu-latest+ permissions:+ contents: read+ packages: write+ # This is used to complete the identity challenge+ # with sigstore/fulcio when running outside of PRs.+ id-token: write++ steps:+ - name: Checkout repository+ uses: actions/checkout@v3++ # Set up Docker Buildx+ - name: Set up Docker Buildx+ uses: docker/setup-buildx-action@v2++ # Login to Docker Hub+ - name: Log into registry ${{ env.REGISTRY }}+ if: github.event_name != 'pull_request'+ uses: docker/login-action@v2+ with:+ registry: ${{ env.REGISTRY }}+ username: ${{ secrets.DOCKERHUB_USERNAME }}+ password: ${{ secrets.DOCKERHUB_TOKEN }}++ # Extract metadata (tags, labels) for Docker+ - name: Extract Docker metadata+ id: meta+ uses: docker/metadata-action@v4+ with:+ images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}+ tags: |+ type=ref,event=branch+ type=ref,event=pr+ type=semver,pattern={{version}}+ type=semver,pattern={{major}}.{{minor}}+ type=sha+ type=raw,value=latest,enable={{is_default_branch}}++ # Build and push Docker image+ - name: Build and push Docker image+ id: build-and-push+ uses: docker/build-push-action@v4+ with:+ context: .+ push: ${{ github.event_name != 'pull_request' }}+ tags: ${{ steps.meta.outputs.tags }}+ labels: ${{ steps.meta.outputs.labels }}+ cache-from: type=gha+ cache-to: type=gha,mode=maxdiff --git a/readme.md b/readme.mdindex 0518cfd8..53c82031 100644--- a/readme.md+++ b/readme.md@@ -1,6 +1,6 @@# Speakr-[](https://www.gnu.org/licenses/agpl-3.0) This project is dual-licensed. See the [License](#license) section for details.+[](https://www.gnu.org/licenses/agpl-3.0) [](https://github.com/murtaza-nasir/speakr/actions/workflows/docker-publish.yml) This project is dual-licensed. See the [License](#license) section for details.Speakr is a personal, self-hosted web application designed for transcribing audio recordings (like meetings), generating concise summaries and titles, and interacting with the content through a chat interface. Keep all your meeting notes and insights securely on your own server.@@ -42,7 +42,9 @@ Speakr is a personal, self-hosted web application designed for transcribing audi* **AI Integration:** OpenAI Python library (compatible with various endpoints like OpenAI, OpenRouter, or local servers)* **Authentication:** Flask-Login, Flask-Bcrypt, Flask-WTF* **Frontend:** Jinja2 Templates, Tailwind CSS, Vue.js (for interactive components), Font Awesome-* **Deployment:** Bash script (`setup.sh`) for Linux/Systemd environments.+* **Deployment:**+ * Bash script (`setup.sh`) for Linux/Systemd environments+ * Docker with automated builds via GitHub Actions## Prerequisites@@ -61,10 +63,41 @@ Speakr is a personal, self-hosted web application designed for transcribing audiChoose either **Docker** (recommended and currently the only working method), **Local Development**, or **Deployment**.+For information on the CI/CD setup and automated Docker image building, see [CI/CD Setup](docs/ci-cd-setup.md).+### 1. Docker InstallationThe easiest way to deploy Speakr is using Docker and docker-compose.+#### Option A: Using Pre-built Docker Images++1. **Create a docker-compose.yml file:**+ ```yaml+ version: '3.8'++ services:+ app:+ image: murtazanasir/speakr:latest+ container_name: speakr+ restart: unless-stopped+ ports:+ - "8899:8899"+ volumes:+ - ./uploads:/data/uploads+ - ./instance:/data/instance+ env_file:+ - .env+ ```++2. **Create a .env file** with your configuration (see the Configuration section below).++3. **Start the container:**+ ```bash+ docker compose up -d+ ```++#### Option B: Building Locally+1. **Clone the Repository:**```bashgit clone https://github.com/murtaza-nasir/speakr.git