Skip to content

Latest commit

 

History

History
60 lines (44 loc) · 2.94 KB

README.md

File metadata and controls

60 lines (44 loc) · 2.94 KB

Renovate

GitHub Workflow Status Docker Pulls Docker Image Size (tag)

Renovate monitors games on Steam, Battle.net, and PlayStation and notifies about updates via Discord.

Setup

A Discord Webhook is recommended for notifications.

Regardless of your chosen setup method, Renovate is intended for use with a task scheduler, such as cron.

Environment Variables:

  • LOG_LEVEL: Loguru severity level to write to the console.
  • LOG_DISCORD_WEBHOOK_URL: Discord Webhook URL to receive log events.
  • LOG_DISCORD_WEBHOOK_LEVEL: Minimum Loguru severity level to forward to Discord.
  • STEAM_TITLES: Comma-separated list of Steam title IDs to watch.
  • BATTLE_TITLES: Comma-separated list of Battle.net title IDs to watch.
  • PROSPERO_TITLES: Comma-separated list of PlayStation 5 title IDs to watch.
  • ORBIS_TITLES: Comma-separated list of PlayStation 4 title IDs to watch.
  • DISCORD_WEBHOOK_URL: Discord Webhook URL to receive available update notifications.

Docker (Recommended)

Modify the following compose.yaml example file, then run docker compose up.

services:
  renovate:
    container_name: renovate
    image: ethanchrisp/renovate:latest
    environment:
      LOG_LEVEL: INFO
      LOG_DISCORD_WEBHOOK_URL: https://discord.com/api/webhooks/YYYYYYYY/YYYYYYYY
      LOG_DISCORD_WEBHOOK_LEVEL: WARNING
      STEAM_TITLES: XXXXXXXX,YYYYYYYY,ZZZZZZZZ
      BATTLE_TITLES: XXXXXXXX,YYYYYYYY,ZZZZZZZZ
      PROSPERO_TITLES: XXXXXXXX,YYYYYYYY,ZZZZZZZZ
      ORBIS_TITLES: XXXXXXXX,YYYYYYYY,ZZZZZZZZ
      DISCORD_WEBHOOK_URL: https://discord.com/api/webhooks/XXXXXXXX/XXXXXXXX

Standalone

Renovate is built for Python 3.12 or greater.

  1. Install required dependencies using uv: uv sync
  2. Rename .env_example to .env, then provide the environment variables.
  3. Start Renovate: python renovate.py

Credits