search

steamcmd / api

Read-only API interface for steamcmd app_info
https://www.steamcmd.net
MIT License
56 stars 7 forks source link

Request: Build and Deploy Images to Docker Hub #36

Closed EthanC closed 1 year ago

EthanC commented 1 year ago

Deploying images to Docker Hub would allow those of us who self-host (for stability) to specify steamcmd/api:latest (for example) rather than manually building the image. The benefits of this are easier initial deployment and updates.

It's possible to automate this task using GitHub Actions.

jonakoudijs commented 1 year ago

Ah I see this is not documented in the README but this is already the case. The live API uses the Docker image from the Hub: https://hub.docker.com/r/steamcmd/api. And this is done via Github Actions as well with every new tag created in the repo (thus version).

The default settings should be sufficient for most. The port the API listens on can be changed by setting the PORT environment variable, the default is 8080. And if you would want to enable caching (only Redis is supported atm) then you can configure with environment variables as well, for example:

REDIS_SSL: "True"
REDIS_PORT: "12345"
REDIS_HOST: "my-redis-server.hosting.com"
REDIS_USERNAME: "xxxxxxxxx"
REDIS_PASSWORD: "xxxxxxxxx"

Seeing I am currently in the process of rewriting the API I have not extended the README with examples yet, hopefully I will be able to finish up soon. Let me know if you need more help setting up your own instance, otherwise I'll close this issue.

EthanC commented 1 year ago

Nice, that's what I was looking for. Thanks!