sdatacode/mavis repository overview

⁠Mavis - MÓDULO ADMINISTRATIVO VISIONAMOS

Bienvenido al proyecto Mavis. Este documento te guiará paso a paso para configurar y ejecutar el proyecto utilizando Docker.

⁠Requisitos previos

Antes de comenzar, asegúrate de tener los siguientes componentes y requisitos:

• Docker: Instalar Docker⁠
• Docker Compose: Instalar Docker Compose⁠
• Base de datos mySQL 10.x ó superior con acceso reomoto y sus datos de acceso

⁠Cómo usar esta imagen

⁠Configuración previa

⁠Variables de entorno

se deben definir las variables de entorno en el sistema donde desea ejecutar la imagen de mavis, se recomienda crear un archivo llamado .env con las siguientes variables:

⁠Plantilla para archivo .env

SECRET_KEY=
DEBUG=
APP_VERSION=
DB_HOST=
DB_PORT=
DB_USER=
DB_PASSWORD=
DB_NAME=
EXTRA_ALLOWED_HOSTS=

⁠Ejecutar el proyecto con Docker

A continuación se detalla las opciones para ejecutar el proyecto usando docker compose o directamente docker run

⁠Usando docker compose

• Crear un archivo docker-compose.yml con la siguiente estructura

    name: mavis
    services:
      mavis:
        image: sdatacode/mavis:${APP_VERSION}
        container_name: mavis
        environment:
          SECRET_KEY: ${SECRET_KEY}
          DEBUG: ${DEBUG}
          EXTRA_ALLOWED_HOSTS: ${EXTRA_ALLOWED_HOSTS}
          DATABASE_URL: mysql://${DB_USER}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_NAME}
        ports:
          - "9010:9010"
  

  Copy

• Ejecutar el comando para iniciar el contenedor

  docker compose up -d
  

  Copy

⁠Usando docker run

Define las variables de entorno en tu terminal para permitir la lectura correcta en el comando del contenedor

set -a && source .env && set +a

Ejecuta directamente el contenedor con el siguiente comando

docker run --env-file .env -e DATABASE_URL=mysql://${DB_USER}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_NAME} --name mavis -p 9010:9010 -d sdatacode/mavis:${APP_VERSION}