Skip to content

Latest commit

 

History

141 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo

Logo credits: Alarm clock stickers created by Stickers - Flaticon


GitHub License GitHub Actions Workflow Status GitHub Tag GitHub commit activity

Remindrix

A chatbot for reminders on Matrix servers focused on multilingual support and user experience. Schedule reminders on the go in personal or group rooms - Remindrix serves as your smart, quiet assistant.

Key Features

  • ⏲️ Create reminders with the /remind command or without it.
  • 📅 Set natural language reminders with customizable default times.
  • 🌐 Individual time zones for rooms.
  • 🔤 Multilingual support both for commands and responses, with the capability to upload your own translations.
  • 📋 Send a summary of missed reminders in each room.
  • 🎹 Customizable command aliases, calling the bot without a command for quick reminders, and mentioning the bot in group chats to activate it.
  • 👩‍💻 "Pro" or CLI mode with flags for date, time, interval, and reminder delegation to other room.

Matrix Account Features

  • Login to the bot's Matrix account with a password and token, automatic device verification and backup if this is the first device for the account, and receiving a recovery key
  • Manual verification with a recovery key if the bot account has been logged in to before, and backup enabled via the command line (CLI)
  • Verification of other devices on which the bot is authorized
  • Reset all verification settings with the ability to save or delete the backup and receive a new recovery key

Feature Roadmap

Reminders Preferences:

  • Optional activation of the bot without a command
  • Optional requirement to mention the bot in group chats
  • Time zone settings
  • Individual user settings

Commands:

  • Alternative text for the bot activation command
  • Bot’s replies via reactions
  • Delegation of reminders
  • Sending a list of reminders
  • Managing reminders through reactions
  • Recurring reminders

Language and Translation:

  • Adding languages
  • Upload your own translation
  • Pro/CLI mode
  • More advanced parsing of reminder date and time from user messages

Other:

  • Database cleanup settings
  • Alarm mode
  • Learn to not be late

Screenshots

First message Interacting with the bot New reminder notification in chats list Missed reminders notification in chats list Setting a room's time zone via chat

Welcome message

Interacting with bot responses as reactions (digits are time until)

New reminder

Notification with summary of missed reminders

Setting a room's time zone

Quick Start

Docker Run

docker run -d --name reminder-bot --restart unless-stopped \
  -v reminder-bot:/app/data/reminder_bot \
  -e MATRIX_HOMESERVER=homeserver-url \
  -e MATRIX_TOKEN=your-token \
  ghcr.io/outarde/reminder-bot:latest

Docker Compose

For more persistent setup use docker-compose.yml.

Set the environment variables as shown in example.env:

  1. MATRIX_HOMESERVER — Matrix homeserver address.
  2. MATRIX_USERNAME and MATRIX_PASSWORD — bot's username and password. Create a user via Matrix Authentication Service (MAS): docker exec matrix-auth mas-cli manage register-user USERNAME --password PASSWORD.
  3. MATRIX_TOKEN — specify this variable when authenticating via token rather than username and password.

Important

Make sure the bot's data folder /app/data/reminder_bot is bound to the host in volumes section. Otherwise, the bot will create a new session each time it's started.

Optional Configuration

Language and other additional settings are stored in a config.yml file in a folder or volume that you have bound to the /app/data/reminder_bot folder inside the container. Use config.example.yml as a starting point.

Available Languages

en English 🇬🇧, de German 🇩🇪, fr French 🇫🇷, it Italian 🇮🇹, es Spanish 🇪🇸, sv Swedish, aka IKEAish 🇸🇪, pl Polish 🇵🇱, cs Czech 🇨🇿, fi Finnish 🇫🇮, ja Japanese 🇯🇵, zh Chinese Simplified 🇨🇳, ru Russian 🇷🇺, uk Ukrainian 🇺🇦.

You can also upload your custom translation.

Usage

Start a Chat

Create a conversation with the bot or add it to a room. Send the /remind, !remind or command in your chosen language to get help:

I am a reminder bot. Send: /remind and the date, time and reminder text on the same line. For example: /remind 19.08.2026 20:03 your reminder.

📅 Date

  • 19.08.2026, 19/08/2026, 19-08
  • 19 August, 19 aug
  • today, tomorrow

🕐 Time

  • 20:03, at 20:03
  • morning, afternoon, evening
  • If you do not specify the time, the reminder will come at 09:00

⚙️ Commands

  • Put / or ! at the beginning
  • r|remind - create a reminder
  • tz Europe/Paris - set the time zone

Beyond the Quick Start

⚙️ 💬 ☑️
For a full description of bot settings, see the configuration.md help page. For details on using the bot, see usage.md. For information on interacting with the Matrix homeserver and managing your account, including device verification, see matrix.md.

I am developing this bot with a focus on users, to make communication via the Matrix protocol more convenient where it is an indispensable option for personal, non-censored communication.

You can read more about the original goals of this project in this Reddit post. Your suggestions and issue reports are invaluable for me and the 🤖!

About

Remindrix is a quiet and smart reminder assistant on your Matrix server.

Resources

Stars

8 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages