Scriberr
Transcription / Self-hosted
AI/ML
Installation
10-19-2024

Scriberr is available as a Docker container. You can use the docker-compose provide below to deploy Scriberr.

---
services:
  scriberr:
    image: ghcr.io/rishikanthc/scriberr:0.3.0
    # build:
    #  context: .
    #  dockerfile: Dockerfile
    depends_on:
      redis:
        condition: service_started
      pocketbase:
        condition: service_started

    ports:
      - "3000:3000" # Scriberr UI
      - "9243:9243" # Optionally expose JobQueue UI
      - "8080:8080" # Optionally expose Database Management UI
    environment:
      - OPENAI_API_KEY=>
      - OPENAI_ENDPOINT=http://ollama:11434/v1
      - OPENAI_MODEL=llama3.2 # Ensure this model matches in `ollama-models` service
      - OPENAI_ROLE=user
      - POCKETBASE_ADMIN_EMAIL=admin@example.com
      - POCKETBASE_ADMIN_PASSWORD=1234567890
      - POCKETBASE_URL=http://pocketbase:8080
      - REDIS_HOST=redis
      - REDIS_PORT=6379
      - SCRIBO_FILES=/scriberr
      - DEV_MODE=false
      - NVIDIA=false # set to true if you have one
      - CONCURRENCY=1 # Adjut cautiously according to hardware limits
    volumes:
      - ./scriberr/pb_data:/app/db
      - ./scriberr:/scriberr
      - ./scriberr/models:/models

  redis:
    image: redis:7-alpine
    volumes:
      - ./.dockerdata/redis:/data

  pocketbase:
    image: ghcr.io/rishikanthc/pocketbase:22.22
    environment:
      - POCKETBASE_ADMIN_EMAIL=admin@example.com  # Replace with your admin email
      - POCKETBASE_ADMIN_PASSWORD=1234567890  # Replace with your admin password
    ports:
      - "8080:8080"  # Expose PocketBase on port 8080
    volumes:
      - ./pb_data:/pb/pb_data  # Mount the PocketBase data directory for persistence
    restart: unless-stopped  # Always restart unless explicitly stopped
Key Format Description
OPENAI_API_KEY string Your Ollama or OpenAI ChatGPT API Key
OPENAI_ENDPOINT string URL endpoint for Ollama or ChatGPT
OPENAI_MODEL string Ollama model to use
OPENAI_ROLE string Role to use in chat messages
POCKETBASE_ADMIN_EMAIL string email for database admin account
POCKETBASE_ADMIN_PASSWORD string password for database admin account
POCKETBASE_URL string address of pocketbase instance with port host:port
REDIS_HOST string hostname of redis instance
REDIS_PORT number port of redis instance
SCRIBO_FILES path path to directory for Scriberr files
DEV_MODE boolean Dev mode is for adjusting paths to my local dev setup. MUST BE set to false
NVIDIA boolean Set to true if you have nvidia gpus available
CONCURRENCY number Number of transcription jobs to execute concurrently Take caution when setting this. Start with 1 and experiment up

Checkout usage for details on how to setup and use Scriberr.


BACKLINKS
Introduction