koko004/zfs-telegram-notifier_app repository overview

⁠ZFS Telegram Notifier 🔔

ZFS Telegram Notifier es una aplicación que te permite recibir notificaciones sobre el estado de tus pools de ZFS directamente en Telegram. Es una herramienta ideal para administradores de sistemas y entusiastas de ZFS que desean una monitorización proactiva y en tiempo real.

Esta aplicación está diseñada para ser fácil de desplegar usando Docker Compose, simplificando la configuración y la gestión de las dependencias.

⁠Cómo empezar

La forma más sencilla de desplegar la aplicación es usando Docker Compose. Necesitarás un archivo docker-compose.yml con la siguiente configuración:

version: '3.8'

services:
  db:
    image: postgres:15-alpine
    restart: always
    environment:
      POSTGRES_USER: ${POSTGRES_USER:-user}
      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-password}
      POSTGRES_DB: ${POSTGRES_DB:-zfs_notifier}
    volumes:
      - postgres_data:/var/lib/postgresql/data
    ports:
      - "${POSTGRES_PORT:-5432}:5432"

  app:
    image: koko004/zfs-telegram-notifier_app
    restart: always
    ports:
      - "3000:3000"
    depends_on:
      - db
    environment:
      - DATABASE_URL=postgresql://${POSTGRES_USER:-user}:${POSTGRES_PASSWORD:-password}@db:${POSTGRES_PORT:-5432}/${POSTGRES_DB:-zfs_notifier}
      - POSTGRES_HOST=db
    command: >
      sh -c "
        npx wait-on tcp:db:5432 &&
        npx tsx src/lib/schema.ts && 
        npm start
      "

volumes:
  postgres_data:

⁠Pasos de despliegue

1. Crea un archivo llamado docker-compose.yml y copia el contenido anterior en él.

2. Despliega la aplicación ejecutando el siguiente comando en tu terminal:

   docker-compose up -d
   

   Copy

Esto iniciará los servicios de la base de datos de PostgreSQL y la aplicación, asegurando que estén configurados y conectados correctamente.

Para hacer la llamada a la API accede a http://host:3000/api/cron⁠