This guide will walk you through the process of setting up and running the GameBattle backend application.
Before you begin, ensure you have the following:
- Docker and Docker Compose installed on your system
- A Redis instance (can be local or remote)
- Firebase credentials for authentication
- A directory with game files
Set up the following environment variables:
GAMES_PATH: Path to the directory containing game filesENABLE_COMPETITION: Set to "true" to enable competition modeREPORT_WEBHOOK(optional): URL for reporting webhooksADMIN_EMAILS(optional): List of admin email addressesREDIS_HOST(optional, default: "localhost"): Redis host addressREDIS_PORT(optional, default: 6379): Redis portREDIS_DB(optional, default: 0): Redis database numberREDIS_PASSWORD(optional): Redis passwordGOOGLE_APPLICATION_CREDENTIALS: Path to your Firebase credentials file
-
Create a
docker-compose.ymlfile in your project directory:version: '3' services: gamebattle-backend: image: rizerphe/gamebattle-docker-manager ports: - "8000:8000" environment: - GAMES_PATH=/app/gamebattle - ENABLE_COMPETITION=true - REPORT_WEBHOOK=your_webhook_url - ADMIN_EMAILS=["admin1@example.com", "admin2@example.com"] - REDIS_HOST=redis - REDIS_PORT=6379 - REDIS_PASSWORD=your_redis_password - GOOGLE_APPLICATION_CREDENTIALS=/app/credentials.json volumes: - /path/to/your/credentials.json:/app/credentials.json - /path/to/your/games:/app/gamebattle - /var/run/docker.sock:/var/run/docker.sock - /tmp:/tmp networks: - gamebattle-network redis: image: redis command: redis-server --requirepass your_redis_password networks: - gamebattle-network networks: gamebattle-network: name: gamebattle
Replace the environment variable values and volume mount paths with your actual configuration.
Note: To give the container access to the Docker socket, we've added a volume mount:
- /var/run/docker.sock:/var/run/docker.sockThis allows the container to communicate with the Docker daemon on the host machine.
Additionally, we've mounted the /tmp directory:
- /tmp:/tmpThis is necessary because the application uses named pipes for inter-process communication, which are created in the /tmp directory. Mounting this directory ensures that these pipes are accessible both inside the container and on the host machine, allowing for proper communication between processes.
-
Run the Docker Compose setup:
docker-compose up -dThis command will pull the pre-built
rizerphe/gamebattle-docker-managerimage, create thegamebattlenetwork, and start both the GameBattle backend and Redis services. -
The application should now be running and accessible at
http://localhost:8000.
For local development without Docker:
-
Install Poetry:
pip install poetry -
Install dependencies:
poetry install -
Run the application:
poetry run uvicorn gamebattle_backend.api:launch_app --factory --host 0.0.0.0 --port 8000
Remember to set all required environment variables before running the application locally.
The application uses a custom Docker network named "gamebattle". This network is automatically created by Docker Compose when you run docker-compose up. It allows the GameBattle backend and Redis services to communicate with each other.
If you need to create the network manually or connect other containers to it, you can use the following command:
By default, the Docker container does not have access to the Docker socket. We've added a volume mount in the docker-compose.yml file to give the container access to the Docker socket. This allows the container to interact with the Docker daemon on the host machine.
However, please note that giving a container access to the Docker socket can pose security risks, as it essentially gives the container full access to the Docker daemon. Only do this if it's absolutely necessary for your application, and make sure to implement proper security measures within your application to prevent misuse of this access.
The pre-built rizerphe/gamebattle-docker-manager image already includes the necessary Docker CLI, so you don't need to install it separately.