1212# SteamCMD API
1313
1414Read-only API interface for steamcmd app_info. The official API is reachable on
15- [ api.steamcmd.net] ( https://api.steamcmd.net ) but can be fairly easily self-hosted.
16- Read more about the public API on [ www.steamcmd.net ] ( https://www.steamcmd.net ) .
15+ [ api.steamcmd.net] ( https://api.steamcmd.net ) and it's documentation can be found
16+ on [ www.steamcmd.net ] ( https://www.steamcmd.net ) .
1717
1818## Self-hosting
1919
20-
21- ## Container
22-
23- The API can easily be run via a Docker image which contains the API code and the
20+ The API can easily be run via a container image which contains the API code and the
2421` uvicorn ` tool to be able to respond to web requests. With every new version of
2522the API the Docker images is automatically rebuild and pushed to the Docker Hub:
2623``` bash
@@ -32,8 +29,16 @@ docker pull steamcmd/api:1.10.0
3229``` bash
3330docker run -p 8000:8000 -d steamcmd/api:latest
3431```
35- However during development, using Docker Compose is preferred. See the
36- [ Development] ( #development ) section for information.
32+ The API consists of 2 services; the ** Web** and the ** Job** service and the Redis
33+ cache. The ** Job** service and the Redis cache are both optional but are both required
34+ if you want to run the ** Job** service.
35+
36+ Details on how the official API is hosted can be found in the
37+ [ platform] ( https://github.com/steamcmd/platform ) repository. This repository contains
38+ all the infrastructure as code that is used to deploy the API on a Kubernetes cluster.
39+
40+ See the [ Development] ( #development ) section for more information on running
41+ the API and Job services directly via Python.
3742
3843## Configuration
3944
@@ -48,7 +53,7 @@ that you will need to set the corresponding cache settings for that type as well
4853when using the ** redis** type).
4954
5055All the available options in an ` .env ` file:
51- ```
56+ ``` shell
5257# general
5358VERSION=1.0.0
5459
0 commit comments