A self-hosted dashboard for monitoring Twitch streams. Track categories and channels, filter by language and viewers, get alerts via email, Discord or webhooks.

Why

Twitch lets you follow categories, but it won't notify you when a new stream goes live in one. There's no way to say "tell me when someone starts streaming this game in English with more than 50 viewers." You're left refreshing the category page manually and scrolling through hundreds of streams.

StreamRadar watches the categories and channels you pick, checks for new streams automatically, and alerts you via email, Discord, or any webhook when something matches your conditions — language, viewer count, keywords, you name it. Self-hosted, private, no account needed.

What it does

• Track categories — follow Twitch game categories (e.g. "Just Chatting", "Fortnite")
• Track channels — follow specific Twitch channels regardless of what they stream
• Live dashboard — see all live streams in one place with sorting, grouping, and filtering
• Alerts — get notified when streams go live via email, Discord, Telegram, or generic webhook
• Blacklist — block channels, keywords, or tags from appearing in results
• Dark / Light mode — system-aware theme with manual toggle
• Pin streams — pin your favorites to the top
• Export / Import — backup and restore all your settings
• Self-hosted — your data stays on your machine, SQLite database, no external services required

---

streamradar-presentation.mp4

---

Installation

Quick install (recommended)

You only need Docker Desktop installed. The install script does everything else.

Windows — open PowerShell or Command Prompt and paste:

curl -fsSL https://raw.githubusercontent.com/stmn/StreamRadar/main/install.bat -o install.bat && install.bat

Or download install.bat and double-click it.

Mac / Linux — open Terminal and paste:

curl -fsSL https://raw.githubusercontent.com/stmn/StreamRadar/main/install.sh | bash

That's it. Open http://localhost:8080 in your browser.

Manual Docker install

If you prefer to do it yourself:

git clone https://github.com/stmn/StreamRadar.git
cd streamradar
docker compose up -d

Everything is automatic — database, encryption keys, and migrations are set up on first launch.

Change the port (e.g. to 3000): add APP_PORT=3000 to .env file, then run docker compose up -d

Stop: docker compose stop

Update: git pull && docker compose up -d --build

---

Option 2: Manual installation

Requirements: PHP 8.3+, Composer, Node.js 20+, npm

git clone https://github.com/stmn/StreamRadar.git
cd streamradar

# Install dependencies
composer install
npm install

# Build the frontend
npm run build

# Set up the app
cp .env.example .env
php artisan key:generate
php artisan app:setup

# Start the server
php artisan serve

Open http://localhost:8000 in your browser.

For automatic syncing, run this in a separate terminal:

php artisan schedule:work

---

Getting started

1. Connect your Twitch account

StreamRadar needs a Twitch API key to fetch stream data. Don't worry — it only reads public data, no Twitch login is needed.

1. Go to the Twitch Developer Console
2. Log in with your Twitch account
3. Click Register Your Application
4. Fill in:
   • Name: anything (e.g. "StreamRadar")
   • OAuth Redirect URLs: http://localhost (required but not used)
   • Category: Analytics Tool
5. Click Create
6. Click Manage on your new app
7. Copy the Client ID
8. Click New Secret and copy the Client Secret
9. In StreamRadar, go to Settings → paste both values → click Save
10. Click Test Connection to verify it works

2. Track your first category

1. Go to the Tracking tab
2. Type a category name (e.g. "Just Chatting")
3. Select from the dropdown and click Track
4. StreamRadar will immediately fetch live streams for that category

3. Track a specific channel

1. In the Tracking tab, switch to Channels
2. Type a channel login (e.g. "shroud") and click Track
3. Their stream will appear on the dashboard whenever they're live

4. Set up alerts (optional)

1. Go to the Alerts tab
2. Click New Alert
3. Configure what you want to be notified about
4. Choose notification channels: Email, Discord, Telegram, and/or Webhook

Configure each channel in Settings first (SMTP for Email, webhook URL for Discord, bot token for Telegram, endpoint URL for Webhook).

---

Notifications

StreamRadar can send alerts through multiple channels:

Method	Setup
Email	Settings → Email/SMTP. Works with any SMTP server, Gmail, Mailgun, etc.
Discord	Settings → Discord. Paste a webhook URL from your server.
Telegram	Settings → Telegram. Create a bot via @BotFather, copy the bot token, send /start to the bot, then enter the bot token and your chat ID. To find your chat ID, message @userinfobot.
Webhook	Settings → Webhook. POST JSON to any URL — works with ntfy.sh, Zapier, Make, or your own endpoint.

---

Automatic syncing

StreamRadar automatically refreshes stream data. The sync frequency is configurable in Settings (default: every 5 minutes).

Docker: Automatic syncing is built-in, no extra setup needed.

Manual installation: Keep php artisan schedule:work running in a separate terminal, or add a cron job:

* * * * * cd /path/to/streamradar && php artisan schedule:run >> /dev/null 2>&1

You can also manually sync anytime by clicking the Sync button in the top bar.

---

Security

By default, StreamRadar has no login — it's designed for personal use on your local network.

To add password protection:

1. Go to Settings → Access Control
2. Set a username and password
3. Click Save

Login will be required in all new browser sessions. To disable it, click Disable Access Control or run:

php artisan auth:reset

---

Running 24/7

To keep StreamRadar running continuously (including after system restarts):

Docker (recommended): The docker-compose.yml already includes restart: unless-stopped, so the container will automatically restart after a system reboot — as long as Docker itself starts on boot.

• Windows: Docker Desktop starts with Windows by default. Check Docker Desktop → Settings → General → "Start Docker Desktop when you sign in".
• Mac: Docker Desktop starts automatically. Check Docker Desktop → Settings → General → "Start Docker Desktop when you log in".
• Linux: Enable the Docker service:

  sudo systemctl enable docker

Manual installation (without Docker): Use a process manager or system service:

• Linux (systemd):

  # Create /etc/systemd/system/streamradar.service
  [Unit]
  Description=StreamRadar
  After=network.target
  
  [Service]
  Type=simple
  User=www-data
  WorkingDirectory=/path/to/streamradar
  ExecStart=/usr/bin/php artisan serve --host=0.0.0.0 --port=8080
  Restart=always
  
  [Install]
  WantedBy=multi-user.target

  Then: sudo systemctl enable --now streamradar

• Mac (launchd): Use launchctl or a tool like pm2:

  npm install -g pm2
  pm2 start "php artisan serve --port=8080" --name streamradar
  pm2 startup   # generates auto-start config
  pm2 save

---

Tech stack

• Backend: Laravel 13, PHP 8.4, SQLite
• Frontend: Vue 3, Inertia.js 3, Tailwind CSS v4, TypeScript
• Icons: Lucide
• Deployment: Docker (nginx + PHP-FPM + scheduler in one container)

Commands

Command	Description
php artisan streams:sync	Manually sync all streams
php artisan app:setup	Initial setup (migrations + defaults)
php artisan auth:reset	Remove password protection
php artisan schedule:work	Start the scheduler (auto-sync)

License

MIT — do whatever you want with it.