Skip to content

Installation

Jump to bottom
OhneB edited this page Oct 17, 2026 · 1 revision

Desktop

Download your installer from Releases.

System File
Windows 10/11, 64-bit twitch-drops-miner-VERSION-windows-x64-setup.exe
macOS 12 or newer, Intel or Apple silicon twitch-drops-miner-VERSION-macos.dmg
Linux, 64-bit, Ubuntu 22.04 or newer twitch-drops-miner-VERSION-linux-x64.AppImage or .deb

Docker

Install Docker Engine and Compose on a Linux server, or Docker Desktop on Windows, macOS or Linux desktop. Save this as compose.yaml in a new folder:

services:
  twitch-drops-miner:
    image: ghcr.io/ohne-b/twitch-drops-miner:latest
    container_name: twitch-drops-miner
    user: "1000:1000"
    ports:
      - "127.0.0.1:8080:8080"
    volumes:
      - ./data:/app/data
      - ./logs:/app/logs
    restart: unless-stopped

Create data and logs folders beside it. On Linux, make them writable by the UID/GID in the file (1000:1000 above). From that folder, run:

docker compose up -d

Open http://127.0.0.1:8080 and add your Twitch account. Keep Docker running and the computer awake while mining.

The port is available only on this machine. For access from your phone or another computer, see Data and access or HTTPS and PWA.

The same amd64/arm64 image is also on Docker Hub as ohneb/twitch-drops-miner:latest. latest follows stable releases. Use a version tag for a specific release. edge contains manually published changes from main; its image revision label identifies the commit.

Build from a checkout

With Git and Docker installed:

git clone https://github.com/ohne-b/twitch-drops-miner.git
cd twitch-drops-miner

Create writable data and logs folders as above, then run:

docker compose up -d --build

The repository's Compose file builds the image locally and uses the same folders and loopback port.

Run without Docker

Install Rust, Node.js 24 and Git. Windows also needs Visual Studio C++ build tools. The repository pins the Rust toolchain.

git clone https://github.com/ohne-b/twitch-drops-miner.git
cd twitch-drops-miner
npm --prefix frontend ci
npm --prefix frontend run build
cargo run --locked -- --host 127.0.0.1

Open http://127.0.0.1:8080. Data and logs go in data/ and logs/ in the working directory. To build an executable with the dashboard included, run cargo build --release --locked --bin twitch-drops-miner after building the frontend. It is written to target/release/ and does not need Node.js to run. Use --help for options.

For desktop development, see CONTRIBUTING.md.

Home

Clone this wiki locally