rycieos/slack-steam-status repository overview

⁠slack-steam-status

⁠

Slack app to sync Steam game status to Slack status

⁠Setup

You will need to create a new Slack app to gain the OAuth permissions from your users to modify their Slack statuses.

⁠Create app

On the Create a Slack App⁠ screen, fill out the form with "Steam Status" as the app name.

The app does not have a "bot" user, so you will probably want to turn those features off.

You will need to register a new "Slash Command":

Under Oauth scopes, you need the commands bot token scope, and the users.profile:write user token scope.

Then install the Slack app for your workspace.

⁠Steam API

You will need a Steam Web API key⁠ to access the Steam Player API.

⁠Configuration

The app API needs the app keys and tokens from Slack and Steam to function. Copy the steam_status_settings.py.dist file to steam_status_settings.py, and replace the fake strings with your own:

⁠Running

The app can be run with any ASGI server, like uvicorn, or the in the provided Docker image. The app API server and the status daemon will run in the same process.

⁠uvicorn

Running with uvicorn is simple:

uvicorn slack_api:app

⁠Docker

There is a Docker image build off of tiangolo/uvicorn-gunicorn, so any environment vars can be used from that image⁠.

⁠Docker usage

To run slack-steam-status in its own container, you only need to make a few changes.

• The steam_status_settings.py config file must be mounted in the container.
• The port that the web API server will listen on needs to be specified. Like any other HTTP server, it can sit behind a reverse proxy (and probably should, so you can enable HTTPS).
• The user.json database file is stored in a Docker volume (/var/db/) by default, but if you want to store the file in a local directory instead, you would need to mount it like -v /path/to/users.json:/var/db/users.json

All together, the run command would look like this:

docker run \
  -v ./steam_status_settings.py:/app/steam_status_settings.py:ro \
  -p 80:80 \
  rycieos/slack-steam-status

⁠Docker compose

If you want to use docker-compose:

version: '3'
services:
  slack-steam-status:
    image: rycieos/slack-steam-status
    restart: always
    ports:
      - 80:80
    volumes:
      - ./steam_status_settings.py:/app/steam_status_settings.py:ro