iothost/api-irrigation repository overview

⁠API Irrigation - Docker Hub Deployment Guide

Este documento proporciona las instrucciones detalladas para desplegar la API de Irrigación Profesional utilizando las imágenes oficiales de Docker Hub.

⁠🚀 Despliegue Rápido (Línea de Comandos)

Para ejecutar el contenedor pasando las variables de entorno directamente en la línea de comandos, utilice el siguiente comando:

docker container run --restart=always -d \
  -e POSTGRES_PASSWORD=Passw0rd123* \
  -e JWT_SECRET=eSTEesTremisecretcode2025* \
  -e DATABASE_HOST=192.168.0.10 \
  -e DATABASE_PORT=5432 \
  -p 3000:3000 \
  -p 3443:3443 \
  --name irrigation_api_hub \
  iothost/api-irrigation:1.0.0

⁠📄 Despliegue con Archivo de Entorno (.env)

Para una gestión más limpia y profesional de las configuraciones, se recomienda el uso de un archivo .env.prod.

⁠1. Preparar el archivo .env.prod

Cree un archivo llamado .env.prod basado en el ejemplo proporcionado en el repositorio (.env.prod.example).

⁠2. Ejecutar el contenedor

Utilice el flag --env-file para cargar todas las configuraciones automáticamente:

docker container run --restart=always -d \
  --env-file=.env.prod \
  -p 3000:3000 \
  -p 3443:3443 \
  --name irrigation_api_hub_02 \
  iothost/api-irrigation:latest

⁠🛠️ Configuración de Variables de Entorno

A continuación se muestra un ejemplo de la estructura necesaria para el archivo .env.prod:

# Base de Datos
POSTGRES_DB=db_irrigation
POSTGRES_USER=user
POSTGRES_PASSWORD=Passw0rd123*
DATABASE_HOST=192.168.0.10
DATABASE_PORT=5432

# Seguridad
JWT_SECRET=eSTEesmTremsisecretcode2025*
ENCRYPTION_KEY=IoT-Irrigati0n-B4ckend-2025!

# Puertos Internos
HTTP_PORT=3000
HTTPS_PORT=3443

⁠📚 Documentación y Soporte

Para consultar la documentación técnica completa, esquemas de base de datos y guías de integración, visite nuestro portal oficial:

🔗 Documentación Online: https://api.iothost.org/api/v1/docs#/⁠