This deposit is now deprecated. The new StreamProxy deposit is now a modular service with a backend and a frontend exclusivly designed for the stream proxy. Other services specificaly designed for Dota 2 and the FroggedTV will be created in a new deposit.
The grenouilleAPI repository is composed of 4 main parts: the Database, the Web API, the DotaBOT section and the RTMP Server.
The Database part is a generic storage for the API and also connected to the DotaBOT. It can take different form: a sqlite file storage for development, or a shared mysql/postgres/maria/..., or the docker image prepared with a postgres database.
The RTMP Server is a simple nginx with the RTMP plugin. It is used to receive streamer intake to feed to a OBS-STUDIO instance running on the host machine.
The Web API is a Flask application hosted in a Python Tornado web server, listening to HTTP requests. Endpoints are secured with API_KEY defined in the configuration file.
The Game section is dedicated to hosting Dota games for the French leagues, managed by automated bots. The Authentication section is dedicated to login users using Steam login, generating JWT for other requests (not ready to use yet). The User section is dedicated to user logged inside the database (not ready to use yet).
The DotaBOT is a Python3 Greenlet, listening to the database for games to hosts for the French leagues.
The master manager spawns 1 slave greenlet for each game, simulating a Dota client using ValvePython/dota2 library.
The Web API documentation for endpoints is generated with the command make refresh-docs in the backend/docs folder.
This is a simple web page to open in a browser stored at backend/docs/index.html.
If you host the API (dev or prod), the doc will be available at //docs/index.html.
Install system dependencies for dev with:
sudo apt install make python python3-pip libpq-dev libffi-dev
sudo pip3 install --upgrade pip
sudo pip3 install virtualenv
Install virtual environment in a .venv directory with make dev-install.
Run the API code in dev environment with make dev-run and the BOT code with make dev-botrun.
Clean development files (virtual environment) with make dev-clean.
Flask production and development app use a setting file backend/cfg/settings.cfg.
You have to create it to match your target system.
A setting file example is available at backend/settings-example.cfg.
If you use docker to run postgres (which is the case in production), you have to setup the environment variables in docker/grenouilleapi_postgres/conf.env.
A environment file example is available at docker/grenouilleapi_postgres/conf.example.env
Development run with make dev-run with no modification to the configuration file uses a SQLite file saved in backend/cfg/sqlite.db
You can use any Postgres database as long as you use the good connection url in backend/cfg/settings.cfg.
Commands to apply to setup the database
psql -c "create user grenouilleapi;"
psql -c "alter user grenouilleapi with superuser;"
psql -c "alter user grenouilleapi with password 'password';"
psql -c "create database grenouilleapi;
Production uses a Docker Postgres image with a persistent volume saving data into /home/docker/grenouilleapi_postgres/.
The same database is usable in development on your machine. Use make db-docker-start and make db-docker-stop to manage it.
Once settings.cfg file is configured for your database setup, you can apply migration commands to the database.
Apply all migrations to the database with make db-upgrade or make db-docker-upgrade depending if your database is isolated inside a docker or not.
Backtrack the latest migration on the database with make db-downgrade or make db-docker-downgrade depending if your database is isolated inside a docker or not.
Generate a new migration file into backend/migrations/versions by comparing backend/models.py with the running database (upgrade will be applied before the compare) with make db-migrate. Use a dev database to generate this migration.
Production run inside docker images. A postgres image hosts the database, and 3 Debian images with tornado/python and dota lib hosts the API, the DotaBot and the RTMP server.
Start everything with make prod-start and stop everything with make prod-stop.
NOTE: You can even use these commands in development because docker ensure isolation. However, the docker image is built after each code modification, so it's not efficient.