steamsalty/README.md
2025-08-31 04:12:04 +02:00

2.7 KiB

SteamSalty

SteamSalty notifies you on telegram about new comments on any steam profile.

Running with Docker Compose

Docker image: https://hub.docker.com/r/watn3y/steamsalty

Example compose file:

services:
  steamsalty:
    image: watn3y/steamsalty:latest # use :<branchname> to be up-to-date with any branch 
    container_name: steamsalty
    restart: unless-stopped
    volumes:
      - /etc/localtime:/etc/localtime:ro
    environment:
      #- STEAMSALTY_LOGLEVEL=
      - STEAMSALTY_TELEGRAMAPITOKEN=
      - STEAMSALTY_STEAMAPIKEY=
      - STEAMSALTY_CHATID=
      - STEAMSALTY_WATCHERS=
      #- STEAMSALTY_SLEEPINTERVAL=

Running on Linux

Grab a release from the releases page. Make sure to set your environment variables accordingly.

Environment Variables

Note

For development purposes, SteamSalty supports loading environment variables from a .env file placed in the project root directory.

Variable Description Default Required
STEAMSALTY_LOGLEVEL LogLevel as described in the zerolog documentation 1 (Info)
STEAMSALTY_TELEGRAMAPITOKEN Telegram BotToken, get it from @BotFather on Telegram None
STEAMSALTY_STEAMAPIKEY Steam API Key, get it from steamcommunity.com/dev/apikey None
STEAMSALTY_CHATID Chat to notify about new comments None
STEAMSALTY_WATCHERS SteamIDs (in SteamID64 format) to check for new profile comments None
STEAMSALTY_SLEEPINTERVAL Amount of time to wait between requests to Steam in seconds 60