Saltar al contenido principal

Integración domótica UrBackup, gratuita y de código abierto

Integración UrBackup para Gladys Assistant

Sus clientes de UrBackup en Gladys: en línea, últimas copias y una alerta si una falla o se retrasa.

UrBackup es un sistema libre de copias de seguridad cliente/servidor: un servidor copia los archivos (y, en Windows, las imágenes de disco) de los ordenadores de su casa u oficina. Esta integración lleva los clientes de un servidor UrBackup a Gladys: cada cliente (un ordenador copiado) se convierte en un dispositivo con su estado, si está en línea, sus últimas copias de archivos y de imagen, la copia en curso y su progreso. Las escenas pueden reaccionar cuando cualquier copia se completa, falla o tiene retraso, un widget del panel muestra primero los clientes fallidos, y una escena puede iniciar una copia incremental de archivos.

Probada con un servidor UrBackup 2.5 real (imagen Docker uroni/urbackup-server 2.5.37, cliente uroni/urbackup-client 2.5.31): inicio de sesión con y sin usuarios, una copia que se completa, una que falla, una copia iniciada desde la integración, un cliente desconectado. Aún no probada en un Gladys real: sus comentarios son bienvenidos en las issues.

Lo que necesita​

  • Gladys Assistant 5.1.0 o posterior.
  • Un servidor UrBackup accesible desde la máquina de Gladys, con su interfaz web (puerto 55414 por defecto).
  • Un usuario de esa interfaz web (Ajustes → Usuarios): el admin, o mejor un usuario dedicado con los permisos status, progress, lastacts, logs y start_backup (este último solo para iniciar copias desde Gladys). Un servidor sin ningún usuario acepta a cualquiera: la integración funciona entonces sin contraseña, pero proteja su servidor.

La integración lee UrBackup cada 5 minutos por defecto (cada 30 segundos durante una copia): tres peticiones ligeras en su propia red.

Primeros pasos​

1. Preparar el servidor UrBackup​

En la interfaz web de UrBackup, Ajustes → Usuarios → Crear usuario: un nombre (gladys por ejemplo), una contraseña y los permisos indicados arriba. Con la cuenta admin, no hay nada que hacer.

2. Configurar la integración​

En Gladys, Integraciones → UrBackup → Configuración:

  • Dirección de UrBackup: http://192.168.1.2:55414 por ejemplo. Una dirección sola (192.168.1.2) equivale a http:// en el puerto 55414; una dirección copiada del navegador también sirve. Detrás de un proxy inverso, su dirección https:// (con un certificado válido).
  • Usuario y Contraseña: el usuario de la interfaz web.
  • Intervalo de actualización: 1, 5 (por defecto) o 15 minutos.
  • Con retraso tras: cuándo un cliente sin copia correcta pasa a tener retraso. Automático (por defecto) sigue a UrBackup: un cliente tiene retraso cuando UrBackup ya no marca sus copias de archivos como OK (ninguna copia en el intervalo de sus ajustes, el de la incremental por defecto). O un plazo fijo, de 12 horas a una semana, desde su última copia correcta, de archivos o de imagen.
  • Permitir iniciar copias: permite que funcione la acción de escena «Iniciar una copia de archivos». Desactívelo si nadie debe iniciar una copia desde Gladys.
  • Idioma de los nombres: idioma de los nombres de las funciones, de los estados y de los resultados de escena.

Probar la conexión lee UrBackup y resume: el número de clientes, en línea, fallidos y con retraso.

3. Añadir los clientes​

En la pestaña Descubrir, añada los clientes que quiera seguir, y el dispositivo «UrBackup» para el servidor. Los disparadores de escena funcionan para todos los clientes, añadidos o no.

Los dispositivos​

Cada cliente:

FunciónValor
EstadoCorrecto, Fallido, Con retraso, En curso o Sin copia
En línea1 cuando el cliente está conectado al servidor
Última copia de archivosdía/mes horas:minutos, «-» si no hay
Horas desde la copia de archivosen horas
Última copia de imagendía/mes horas:minutos, «-» si no hay
Horas desde la copia de imagenen horas
Copia en curso1 mientras se ejecuta una copia de este cliente
Progresoen %, de la copia en curso
Errores de la última copiaerrores en el registro de su última copia

El dispositivo «UrBackup», para el servidor, cuenta:

  • Clientes en línea;
  • Copias en curso;
  • Clientes fallidos;
  • Clientes con retraso.

Una copia «falla» cuando su registro contiene errores: una copia que UrBackup no pudo completar, o que terminó con errores. Un cliente desconectado recibe la insignia «inaccesible» en Gladys. El estado muestra primero lo que requiere atención: un cliente fallido muestra «Fallido» aunque también tenga retraso.

Panel​

El widget UrBackup muestra el número de clientes fallidos, con retraso y en línea, y después una fila por cliente: fallidos primero, luego con retraso, en curso, sin copia, correctos, con la última copia (o el progreso de la que está en curso); un cliente correcto desconectado aparece en gris. Todos los clientes por defecto, o los elegidos en sus ajustes. El botón Actualizar vuelve a leer UrBackup.

Escenas​

Disparadores​

  • Una copia se completa: una copia (archivos o imagen) termina sin errores. Información: cliente, tipo (archivos, imagen), duración (minutos), tamaño transferido.
  • Una copia falla: una copia termina con errores en su registro. Información: cliente, tipo, primer error, errores.
  • Un cliente tiene retraso: un cliente no ha tenido una copia correcta desde hace más que el plazo «Con retraso tras». Una vez, y de nuevo tras un nuevo éxito. Información: cliente, horas desde el último éxito, último éxito.

Cada disparador puede limitarse a algunos clientes (vacío: todos).

Acciones​

  • Estado de un cliente: lee el estado de un cliente para las siguientes acciones: fallido, con retraso, en línea, el estado en palabras, el cliente, el último éxito, horas desde el último éxito (-1 si no hay), y una frase lista («laptop-anna: Fallido, última copia 18/10 02:05.»).
  • Iniciar una copia de archivos: inicia ahora una copia incremental de archivos del cliente. Rechazada cuando «Permitir iniciar copias» está desactivado, o por UrBackup cuando el cliente está desconectado.

Ideas de escenas​

  • Una copia falla → enviar un mensaje con el cliente y su primer error, tomados de la información del disparador.
  • Un cliente tiene retraso → avisar con el cliente y las horas desde su último éxito: el portátil lleva días sin encenderse.
  • Cada domingo a las 10:00 → Estado de un cliente → enviar la frase; o iniciar una copia de archivos del ordenador de la oficina a las 19:00 con Iniciar una copia de archivos.

Solución de problemas​

  • «UrBackup no responde»: compruebe la dirección y el puerto desde la máquina de Gladys (http://…:55414, el puerto de la interfaz web, no 55413 ni 55415).
  • «usuario o contraseña rechazados por UrBackup»: vuelva a introducirlos; son los de un usuario de la interfaz web.
  • «a este usuario de UrBackup le falta un permiso»: dé al usuario los permisos status, progress, lastacts, logs (y start_backup). Sin logs, los estados se muestran pero no se anuncia ninguna copia completada o fallida.
  • «UrBackup no inició la copia»: el cliente está desconectado, o ya hay una copia suya en curso.
  • «UrBackup está actualizando su base de datos»: tras una actualización de UrBackup; espere a que termine.
  • Un cliente nunca tiene retraso: en Automático, un cliente con las copias de archivos desactivadas, o nunca copiado, no tiene retraso; elija un plazo fijo para las copias de imagen.
  • Para ver más, ponga la variable LOG_LEVEL de la integración en debug.

Límites​

  • Un solo servidor UrBackup por integración.
  • Tras un corte, solo se anuncian las copias terminadas en las últimas 24 horas; las más antiguas se registran sin aviso.
  • Una copia se conoce al terminar, por su registro: los disparadores llegan en la lectura siguiente (5 minutos por defecto).
  • La integración no restaura, borra ni configura copias: las vigila, e inicia copias incrementales de archivos si está permitido.
  • HTTPS solo con un certificado firmado por una autoridad conocida (un proxy inverso).
  • Sin relación con UrBackup. Comunique un problema o una idea en las issues.

Parámetros de configuración​

Estos son los parámetros que UrBackup te pide en su pantalla de configuración en Gladys.

ParámetroTipoObligatorioDescripción
Su servidor UrBackupsectionNoLa interfaz web del servidor UrBackup (puerto 55414). Introduzca su dirección y un usuario de esa interfaz, y después añada los clientes desde la pestaña Descubrir.
Dirección de UrBackupstringSíLa dirección de la interfaz web, puerto 55414 por defecto. https:// detrás de un proxy inverso.
UsuariostringNoUn usuario de la interfaz web (Ajustes → Usuarios), admin o con los permisos status, progress, lastacts, logs y start_backup.
ContraseñasecretNoSu contraseña. Vacía para un servidor sin ningún usuario (no recomendado).
OpcionessectionNo
Intervalo de actualizaciónselectNoCon qué frecuencia se lee UrBackup. Cada 30 segundos durante una copia.
Con retraso trasselectNoUn cliente sin copia correcta desde hace este tiempo tiene retraso. Automático: según UrBackup, por el intervalo de copias de archivos de sus ajustes.
Permitir iniciar copiasbooleanNoPermite que la acción de escena «Iniciar una copia de archivos» inicie una copia incremental de archivos en UrBackup.
Idioma de los nombresselectNoIdioma de los nombres de las funciones (fijados al añadir un dispositivo), de los estados y de los resultados de escena.

Cómo instalar UrBackup en Gladys​

  1. En Gladys, abre Integraciones: UrBackup aparece en el catálogo junto a las integraciones nativas, con una insignia de comunidad.
  2. Haz clic en Instalar. Gladys descarga la imagen Docker (ghcr.io/guim31/gladys-urbackup:1.0.1), la ejecuta en un entorno aislado del núcleo y genera la interfaz de la integración (dispositivos, descubrimiento y configuración).
  3. Abre la pantalla de Configuración de la integración, rellena los parámetros y guarda.
  4. También puedes instalarla directamente desde la URL de su repositorio: https://github.com/guim31/gladys-urbackup.

UrBackup requiere Gladys >=5.1.0. El catálogo de Gladys se actualiza cada hora, así que una nueva versión está disponible como máximo una hora después de publicarse.

¿Todavía no usas Gladys? Es gratuito y de código abierto: sigue la guía de instalación para empezar.

Sobre las integraciones externas​

UrBackup es una integración externa: una integración comunitaria empaquetada como contenedor Docker y publicada en GitHub. Gladys la instala con un clic y la ejecuta en un entorno aislado del núcleo. La publica y mantiene guim31, no el equipo principal de Gladys.

Suscríbete a la newsletter de Gladys Assistant

Unos pocos correos al mes sobre nuevas versiones y novedades del proyecto. Enviados por Pierre-Gilles Leymarie, fundador del proyecto. Puedes darte de baja cuando quieras 🙂