Skip to content

Installation

Pull and run the Docker image:

sh
docker run --name stremthru -p 8080:8080 \
  -e STREMTHRU_PROXY_AUTH=username:password \
  muniftanjim/stremthru

This starts StremThru on port 8080 with basic proxy authorization.

Docker Compose

  1. Create a compose.yaml file:
yaml
services:
  stremthru:
    container_name: stremthru
    image: muniftanjim/stremthru
    ports:
      - 8080:8080
    env_file:
      - .env
    restart: unless-stopped
    volumes:
      - ./data:/app/data
  redis:
    image: redis:7-alpine
    ports:
      - 8089:6379
  postgres:
    image: postgres:16.6-alpine
    ports:
      - 8088:5432
    environment:
      POSTGRES_DB: stremthru
      POSTGRES_USER: stremthru
      POSTGRES_PASSWORD: stremthru
    restart: always
    volumes:
      - ./data/postgres:/var/lib/postgresql/data
  1. Create a .env file with your configuration:
sh
STREMTHRU_PROXY_AUTH=username:password
  1. Start the services:
sh
docker compose up -d stremthru

TIP

Redis and PostgreSQL are optional. StremThru uses in-memory caching and SQLite by default. See Database & Redis for details.

From Source

Prerequisites

Build and Run

sh
git clone https://github.com/MunifTanjim/stremthru
cd stremthru

# configure
export STREMTHRU_PROXY_AUTH=username:password

# run directly
make run

# or build and run the binary
make build
./stremthru