Sports alert notifications powered by ESPN, EPG, and your preferred push service.
+He's slow. Your alerts aren't.
+ +A self-hosted sports alert system. NHL, NBA, NFL, Soccer, Golf, F1, and more — straight to your phone.
+ +--- + +## Meet the Alertle Turtle 🐢 + +The Alertle Turtle is our mascot, our spirit animal, and our greatest irony. He is notoriously slow. He does not rush for anyone. And yet somehow, he always makes sure your game alerts arrive on time. + +Don't miss a game. The Alertle Turtle's got you. + +## ⚡ Vibe Coded + +This entire project was built through conversation with Claude AI — no code was written by hand. No documentation was read. No Stack Overflow tabs were opened. Just vibes, prompts, and one very good turtle idea. + +If it works, great. If something breaks, that's also the vibes. PRs are welcome. So is asking an AI about it. --- ## Quick Start -```bash -# Pull and run with Docker Compose -curl -o docker-compose.yml https://raw.githubusercontent.com/Deekerman/Alertle-V2/main/docker-compose.yml -curl -o config.yaml https://raw.githubusercontent.com/Deekerman/Alertle-V2/main/config.yaml.example -# Edit config.yaml with your settings, then: -docker compose up -d +```yaml +services: + alertle-v2: + image: ghcr.io/deekerman/alertle-v2:b4f36b8 + container_name: alertle-v2 + pull_policy: always + restart: unless-stopped + environment: + TZ: America/Toronto + ports: + - 8888:8888 + volumes: + - ./alertle-v2/config.yaml:/config/config.yaml + - alertle_data:/app/data +volumes: + alertle_data: null +networks: {} ``` -Or pull the image directly: - ```bash -docker pull ghcr.io/deekerman/alertle-v2:latest +# Create the config directory and grab the example config +mkdir -p alertle-v2 +curl -o alertle-v2/config.yaml https://raw.githubusercontent.com/Deekerman/Alertle-V2/main/config.yaml.example + +# Edit config.yaml, then: +docker compose up -d ``` -The web UI will be available at `http://localhost:8888`. +The web UI will be available at `http://localhost:8888`. The first-start wizard will walk you through the rest. --- @@ -39,6 +69,8 @@ The web UI will be available at `http://localhost:8888`. - Fully configurable notification templates with per-endpoint overrides - 7-day lookahead scan with configurable daily scan time - Web UI for managing subscriptions, endpoints, settings, and viewing upcoming alerts +- First-start setup wizard so you're not staring at a blank config +- Backup and restore — including import from V1 ## How It Works @@ -80,22 +112,15 @@ sudo journalctl -u alertle-v2 -f ### Docker ```bash -git clone https://github.com/Deekerman/Alertle-V2.git -cd Alertle-V2 -cp config.yaml.example config.yaml -# Edit config.yaml with your settings +mkdir -p alertle-v2 +curl -o alertle-v2/config.yaml https://raw.githubusercontent.com/Deekerman/Alertle-V2/main/config.yaml.example +curl -o docker-compose.yml https://raw.githubusercontent.com/Deekerman/Alertle-V2/main/docker-compose.yml +# Edit alertle-v2/config.yaml, then: docker compose up -d ``` The web UI will be available at `http://localhost:8888`. -```yaml -# docker-compose.yml mounts -volumes: - - ./config.yaml:/config/config.yaml - - alertle_data:/data -``` - ## Configuration Copy `config.yaml.example` to `config.yaml` and edit. The web UI at `/settings` can manage most options after first launch. diff --git a/config.py b/config.py index 6d19d52..9758a23 100644 --- a/config.py +++ b/config.py @@ -17,13 +17,19 @@ def _load_raw() -> dict: - if not CONFIG_PATH.exists(): + if not CONFIG_PATH.exists() or CONFIG_PATH.is_dir(): return {} with CONFIG_PATH.open() as f: return yaml.safe_load(f) or {} def _save_raw(data: dict) -> None: + if CONFIG_PATH.is_dir(): + raise RuntimeError( + f"Config path '{CONFIG_PATH}' is a directory, not a file. " + "On the host, run: rm -rf ./alertle-v2/config.yaml && " + "curl -o alertle-v2/config.yaml{time} {channels} {broadcast}
+ {venue} {context} {odds} {score}
+ {description} {home} {away} {home_abbrev} {away_abbrev}
+ {league} {sport}
{venue} {context} {odds} {odds_spread}
{odds_ou} {odds_home_ml} {odds_away_ml}
{score} {home} {away} {home_abbrev}
{away_abbrev} {league} {sport}
- Leave empty to use default: time, channels, venue, context, odds, score
+ Leave empty to use default: description, time, venue, channels
{description} (EPG program description).
- Leave empty to use default: score, time, channels, description.
+ Used for Final Score notifications. Same variables as above, plus {score} for the final result.
+ Leave empty to use default: time, score.
{channels} variable includes the full broadcast schedule with time slots.
- Leave empty to use default: context, time, channels.
+ Leave empty to use default: event name, start time, channels.