Recordatorios personales para Telegram, instalables en NAS con Docker Compose.
2.1K
Tu asistente personal de recordatorios en Telegram. Fechas naturales, recurrencias, notas y alertas para tu NAS o tu vida personal, en un bot ligero con Docker.
La etiqueta latest ofrece imágenes linux/amd64 y linux/arm64. Docker selecciona automáticamente la arquitectura compatible.
Si quieres crear tu propio docker-compose.yml sin clonar el repositorio, puedes partir de este ejemplo. Sustituye los valores de ejemplo por los tuyos antes de arrancar:
Importante recuerdame, en el compose, va sin tilde, para evitar que dé errores el contenedor.
services:
mibot:
image: valkm/recuerdame_bot:latest
container_name: recuerdame_bot
restart: unless-stopped
init: true
environment:
BOT_TOKEN: "PEGA_AQUI_EL_TOKEN_DE_BOTFATHER"
ALLOWED_USER_IDS: "123456789"
ALERT_API_TOKEN: "CAMBIA_ESTO_POR_UN_SECRETO_LARGO_Y_ALEATORIO"
TZ: Europe/Madrid
volumes:
- ./data:/app/data
ports:
- "8787:8080"
healthcheck:
test:
- CMD
- python
- -c
- "import urllib.request; urllib.request.urlopen('http://127.0.0.1:8080/health', timeout=10)"
interval: 1m
timeout: 15s
retries: 3
start_period: 60s
security_opt:
- no-new-privileges:true
cap_drop:
- ALL
networks:
- mibot-net
logging:
driver: json-file
options:
max-size: "10m"
max-file: "3"
networks:
mibot-net:
El puerto 8787 queda accesible desde la red local del NAS. La API requiere ALERT_API_TOKEN; no configures un reenvío de este puerto desde Internet. Desde esa carpeta, arranca el bot con:
mkdir -p data
docker compose pull
docker compose up -d
Para fijar una versión, cambia latest por la etiqueta deseada, por ejemplo valkm/recuerdame_bot:1.1.1.
Abre el bot en Telegram y envía /menu. La guía de instalación completa y la configuración de Synology están más abajo.
Versión documentada: v1.1.1 · Consulta el historial de cambios.
/recordar./cancelar seguido de la ID, Ej, /cancelar 21,22,23/menu y menú de comandos nativo./donate para apoyar voluntariamente el proyecto; no desbloquea funciones adicionales.Busca @userinfobot en Telegram y ejecuta /start para consultar tu ID numérico.
Copia o clona este repositorio en una carpeta del servidor. En Synology, por ejemplo, /volume1/docker/recuerdame-bot.
Edita docker-compose.yml y cambia BOT_TOKEN, ALLOWED_USER_IDS y ALERT_API_TOKEN por tus valores.
Crea la carpeta persistente /data y prepara los permisos. Antes de arrancar el contenedor, crea el directorio de datos para la SQlite:
mkdir -p data
La aplicación se ejecuta dentro del contenedor con un usuario sin privilegios (UID/GID 10001:10001).
Para que SQLite pueda crear y modificar la base de datos, el directorio persistente debe pertenecer a ese usuario.
En Synology y otros sistemas Linux, ejecuta:
sudo chown -R 10001:10001 data
sudo chmod 755 data
A continuación, descarga la imagen y arranca el servicio:
docker compose pull
docker compose up -d
Importante: si SQLite muestra el error unable to open database file, comprueba los permisos del directorio /data y verifica que el usuario 10001 tiene permisos de escritura.
Cuando el contenedor haya arrancado, revisa el estado y los registros:
docker compose ps
docker compose logs --tail=50
El contenedor debe aparecer como healthy y los registros deben mostrar que el bot ha iniciado el polling correctamente.
Abre el bot en Telegram y envía /start o /menu.
El bot usa long polling: no requiere dominio, certificado HTTPS ni puertos entrantes en el router. La API de alertas queda accesible en la red local mediante el puerto 8787 del NAS.
| Variable | Obligatoria | Valor inicial | Descripción |
|---|---|---|---|
BOT_TOKEN | Sí | — | Token del bot emitido por BotFather. |
ALLOWED_USER_IDS | Sí | — | ID o lista de ID de Telegram separados por comas. Solo estos usuarios pueden usar el bot y recibir alertas. |
ALERT_API_TOKEN | Sí | — | Secreto de acceso a la API de alertas. Usa una cadena larga y aleatoria. |
TIMEZONE | No | Europe/Madrid | Zona horaria para fechas y horas de recordatorios. |
TZ | No | Europe/Madrid | Zona horaria del contenedor. |
API_HOST | No | 0.0.0.0 | Interfaz donde escucha la API dentro del contenedor. |
API_PORT | No | 8080 | Puerto interno de la API. |
DB_PATH | No | /app/data/mibot.db | Ruta de SQLite dentro del contenedor. |
REMINDER_REPEAT_MINUTES | No | 30 | Minutos entre avisos persistentes (admite de 5 a 1440). |
REMINDER_MAX_RETRIES | No | 3 | Número máximo de reintentos (admite de 0 a 10; 0 los desactiva). |
LOG_LEVEL | No | INFO | Nivel de registro, por ejemplo INFO o DEBUG. |
Para más de un usuario, escribe los ID separados por comas, por ejemplo 111111111,222222222. No uses nombres de usuario como sustituto de los ID.
Para generar ALERT_API_TOKEN puedes generarlo con el comando:
openssl rand -hex 32
Los comandos del menú nativo y de /help siguen este orden:
| Nº | Comando | Uso |
|---|---|---|
| 1 | /menu | Abrir el menú interactivo. |
| 2 | /recordar | Crear un recordatorio. También puedes enviar directamente el texto sin comando. |
| 3 | /cancelar ID[, ID, ...] | Cancelar uno o varios recordatorios, o detener recurrencias, conservando el historial. |
| 4 | /hoy | Ver los recordatorios de hoy. |
| 5 | /semana | Ver los próximos siete días. |
| 6 | /proximos | Mostrar los próximos recordatorios ordenados por fecha. |
| 7 | /lista [#etiqueta] | Mostrar recordatorios activos; opcionalmente filtrar por etiqueta. |
| 8 | /etiqueta ID #Libros #Casa | Asignar o quitar etiquetas. |
| 9 | /nota ID texto | Añadir o cambiar una nota. Usa /nota ID borrar para quitarla. |
| 10 | /frecuencia ID diaria|semanal|mensual | Cambiar la periodicidad de una recurrencia. |
| 11 | /pausar ID | Pausar una recurrencia. |
| 12 | /reactivar ID | Reactivar una recurrencia pausada. |
| 13 | /historial [límite] | Consultar acciones recientes (límite de 1 a 20; por defecto 15). |
| 14 | /estadisticas [días] | Resumen de actividad (de 1 a 365 días; por defecto 30). |
| 15 | /salir | Salir de una acción guiada en curso. |
| 16 | /help | Ver ayuda y ejemplos. |
| 17 | /estado | Consultar el estado del bot y la configuración de avisos persistentes. |
| 18 | /donate | Información para apoyar voluntariamente el proyecto; no desbloquea funciones adicionales. |
/start también abre el menú interactivo como alias de inicio.
Ejemplos:
Recuérdame comprar leche mañana a las 18:30
/recordar renovar certificado dentro de 20 días
/recordar revisar copias cada semana #NAS nota: comprobar el último backup
/cancelar 22, 21, 20
/proximos
/lista #NAS
/nota 12 descargar en epub
/etiqueta 12 #Libros
/etiqueta 12 borrar
Si no indicas una hora, el bot usa las 09:00 en la zona horaria configurada.
Desde el propio servidor, define en la terminal el mismo ALERT_API_TOKEN que configuraste en docker-compose.yml y envía un aviso con:
# Define ALERT_API_TOKEN con el mismo valor del Compose antes de usar curl.
curl -X POST "http://127.0.0.1:8787/notify" \
-H "Authorization: Bearer $ALERT_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"NAS","message":"El backup ha terminado","severity":"info"}'
La API admite info, warning y critical; el título y el mensaje son obligatorios. El endpoint /health sirve para comprobar que la API está activa:
curl "http://127.0.0.1:8787/health"
El puerto 8787 queda publicado en las interfaces de red del NAS. Para que otro contenedor acceda a la API, ambos servicios deben compartir una red Docker y ese contenedor debe usar http://mibot:8080/notify junto con el token. No configures un reenvío desde Internet.
La base SQLite vive en data/ y persiste al recrear el contenedor. Se crea por primera vez al crear el contenedor. Haz una copia antes de actualizar o migrar el NAS. Para una copia SQLite consistente mientras el bot está en uso, puedes usar la API de backup integrada de Python dentro del contenedor:
stamp=$(date +%Y%m%d-%H%M%S)
docker compose exec -T -e BACKUP="/app/data/mibot-backup-$stamp.sqlite3" mibot \
python -c 'import os, sqlite3; src=sqlite3.connect("/app/data/mibot.db"); dst=sqlite3.connect(os.environ["BACKUP"]); src.backup(dst); dst.close(); src.close(); print("Copia creada:", os.environ["BACKUP"])'
Para actualizar a la imagen publicada más reciente, sin borrar data/:
docker compose pull
docker compose up -d
Si prefieres construir desde el código fuente, usa el archivo adicional:
docker compose -f docker-compose.yml -f docker-compose.source.yml up -d --build
docker-compose.yml después de reemplazar los valores de ejemplo por credenciales reales. .gitignore excluye la base de datos y sus copias.ALERT_API_TOKEN y se publica en la red local del NAS. No configures un reenvío del puerto desde Internet.ALLOWED_USER_IDS.Consulta la guía completa en GitHub, incluyendo todas las variables, comandos de Telegram y configuración de Synology.
Content type
Image
Digest
sha256:c527905c6…
Size
51.4 MB
Last updated
1 day ago
docker pull valkm/recuerdame_bot