anoa/matrix-reminder-bot

Matrix Reminder Bot

Matrix Reminder Bot是一个基于https://github.com/anoadragon453/nio-template%E5%BC%80%E5%8F%91%E7%9A%84Matrix%E8%81%8A%E5%A4%A9%E6%9C%BA%E5%99%A8%E4%BA%BA%EF%BC%8C%E4%B8%93%E6%B3%A8%E4%BA%8E%E6%8F%90%E4%BE%9B%E4%BE%BF%E6%8D%B7%E7%9A%84%E6%8F%90%E9%86%92%E7%AE%A1%E7%90%86%E5%8A%9F%E8%83%BD%EF%BC%8C%E6%94%AF%E6%8C%81%E4%B8%AA%E4%BA%BA%E3%80%81%E6%88%BF%E9%97%B4%E6%8F%90%E9%86%92%E5%8F%8A%E6%8C%81%E4%B9%85%E5%8C%96%E5%AD%98%E5%82%A8%EF%BC%8C%E9%80%82%E7%94%A8%E4%BA%8E%E7%AB%AF%E5%88%B0%E7%AB%AF%E5%8A%A0%E5%AF%86%E6%88%BF%E9%97%B4%E7%8E%AF%E5%A2%83%E3%80%82

核心功能和特性

• 灵活提醒设置：支持个人提醒（!remindme）和房间提醒（!remindroom）
• 提醒持久化：机器人重启后，所有提醒数据不会丢失
• 闹钟功能：设置持续通知的闹钟，直到手动静音（!silence）
• 加密房间支持：兼容端到端加密（E2E）房间，保护提醒内容安全
• 多样化定时方式：支持自然语言时间（如"明天中午"）、重复周期（如"每1周"）及Cron表达式（复杂周期性提醒）

适用场景

• 个人任务管理：设置日常待办事项提醒（如"明天早上8点开会"）
• 团队协作：在团队房间中发送全员提醒（如"下午3点项目同步会"）
• 加密环境使用：在端到端加密房间内安全地设置私密提醒
• 重要事项提醒：通过闹钟功能确保关键事项（如吃药、截止日期）不被忽略

安装与配置

前置要求

• Docker环境（推荐，简化依赖管理）
• 可访问的Matrix homeserver（如Synapse）
• 机器人账号（需在Matrix homeserver注册）

Docker安装（推荐）

1. 获取配置文件

首先创建本地目录用于存储配置和数据：

bash
mkdir -p matrix-reminder-bot/{config,data}

复制样本配置文件并修改（配置文件可从https://github.com/anoadragon453/matrix-reminder-bot%E8%8E%B7%E5%8F%96%EF%BC%89%EF%BC%9A

bash
# 下载样本配置（若无法访问GitHub，可手动创建config.yaml）
wget https://raw.githubusercontent.com/anoadragon453/matrix-reminder-bot/main/sample.config.yaml -O matrix-reminder-bot/config/config.yaml

2. 编辑配置文件

修改matrix-reminder-bot/config/config.yaml，至少配置以下参数：

yaml
matrix:
  homeserver: "https://your-matrix-homeserver.com"  # Matrix服务器地址
  user_id: "@reminder-bot:your-domain.com"          # 机器人账号ID
  password: "your-bot-password"                     # 机器人账号密码
storage:
  database: "sqlite:///data/reminders.db"           # 数据存储路径（默认SQLite，支持PostgreSQL）

3. 启动容器

通过Docker运行机器人，挂载配置和数据目录：

bash
docker run -d \
  --name matrix-reminder-bot \
  -v $(pwd)/matrix-reminder-bot/config:/config \  # 配置文件目录
  -v $(pwd)/matrix-reminder-bot/data:/data \      # 数据持久化目录
  --restart unless-stopped \
  anoa/matrix-reminder-bot

原生安装（复杂，不推荐）

需手动安装依赖（如libolm加密库、Python环境等），详情参考https://github.com/anoadragon453/matrix-reminder-bot#native-installation%E3%80%82

使用方法

基本提醒命令

设置个人提醒

plaintext
!remindme <时间>; <提醒文本>

示例：

• !remindme tomorrow at noon; 参加产品评审会
• !remindme in 30 minutes; 提交周报

设置房间提醒

plaintext
!remindroom <时间>; <提醒文本>

示例：

• !remindroom on friday at 5pm; 团队聚餐地点确认

重复提醒

周期重复提醒

plaintext
!remindme every <周期>; <开始时间>; <提醒文本>

示例：

• !remindme every 1w; monday at 9am; 每周例会
• !remindroom every 2d; tomorrow; 项目进度同步

Cron表达式提醒（复杂周期）

plaintext
!remindme cron <cron表达式>; <提醒文本>

示例：

• !remindme cron * 9 * * mon-fri; 工作日早上9点打卡（每周一至周五9点）
• !remindme cron 0/30 9-18 * * mon,wed,fri; 每30分钟休息一次（周一/三/五9点至18点，每30分钟）

管理提醒

列出所有提醒

plaintext
!listreminders

输出示例：

10分钟后 提交周报
明天中午12点 参加产品评审会
每周一9点 每周例会（每1周）

取消提醒

plaintext
!cancelreminder <提醒文本>

示例：!cancelreminder 提交周报

闹钟功能

设置闹钟

plaintext
!alarmme <时间>; <提醒文本>  # 个人闹钟
!alarmroom <时间>; <提醒文本>  # 房间闹钟

示例：

• !alarmme in 5 minutes; 吃药（5分钟后开始持续提醒）
• !alarmroom every 1d; tomorrow 8am; 起床打卡（每天8点持续提醒，直到静音）

静音闹钟

plaintext
!silence <提醒文本>

示例：!silence 吃药

开发与贡献

如需参与开发或提交改进，参考项目https://github.com/anoadragon453/matrix-reminder-bot/blob/main/CONTRIBUTING.md%E3%80%82