Aller au contenu

Déploiement

Prérequis et configuration

Installer Docker Compose v2, puis copier .env.example vers .env. Remplacer au minimum les mots de passe PostgreSQL/Redis, les clés internes et JWT, les secrets Discord, la licence FiveM et l'URL d'artefact FXServer. Ne jamais committer .env.

docker compose build
docker compose up -d
docker compose exec api alembic upgrade head

RUN_MIGRATIONS_ON_START=true est aussi imposé à l'API pour éviter qu'elle soit prête avec un schéma obsolète.

Documentation

Le service docs construit les sources avec MkDocs Material en mode strict, puis sert le résultat avec nginx :

docker compose build docs
docker compose up -d docs

Ouvrir http://HOTE:8001, ou le port défini par DOCS_PORT.

Endpoints publiés

  • admin : ADMIN_PORT, défaut 8080 ;
  • documentation : DOCS_PORT, défaut 8001 ;
  • FiveM : FIVEM_GAME_PORT, défaut 30120 en TCP/UDP ;
  • txAdmin : TXADMIN_PORT, défaut 40120.

Dans Portainer, renseigner les variables dans l'éditeur de stack. Les services se joignent par leur nom Docker (api, database, redis) et jamais via localhost.