Update README.md

Add disclaimer about Docker.
This commit is contained in:
sergystepanov 2021-01-06 18:59:49 +03:00 committed by Sergey Stepanov
parent 6568c83aeb
commit 162c4b9bc8
No known key found for this signature in database
GPG key ID: A56B4929BAA8556B

7
README.md vendored
View file

@ -68,13 +68,10 @@ __See the `docker-compose.yml` file for Xvfb example config.__
## Run with Docker
In case if you want to run the app as a Docker container,
use `docker-compose up --build` (`CLOUD_GAME_GAMES_PATH` is env variable for games on your host).
__The app runs as a Docker container only in Linux.__
Use makefile script: `make dev.run-docker` or Docker Compose directly: `docker-compose up --build` (`CLOUD_GAME_GAMES_PATH` is env variable for games on your host).
It will spawn a docker environment and you can access the service on `localhost:8000`.
*Note.*
Docker for Windows is not supposed to work with provided configuration, use WSL2 instead.
## Configuration
The configuration parameters are stored in the [`configs/config.yaml`](configs/config.yaml) file which is shared for