Home assistant add-on: Monica
💖 Support development
I maintain this and other Home Assistant add-ons in my free time: keeping up with upstream changes, HA changes, and testing on real hardware takes a lot of time (and some money). I use around 5 or my >110 addons so usually I install test machines that I don't use myself to better support you users
If this add-on saves you time or makes your setup easier, I would be very grateful for your support !
Addon informations
Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!
About
Monica is a Personal Relationship Manager (PRM) that helps you organize your social life and keep track of your relationships with friends, family, and colleagues. It's like a CRM, but for your personal life.
Key features:
- Track conversations, activities, and important dates
- Store contact information and relationship details
- Set reminders for birthdays, anniversaries, and follow-ups
- Document gifts given and received
- Track debts and favors
- Organize notes and memories about people
- Journal functionality
- Gift ideas tracking
- Multiple database options (SQLite, MariaDB, MySQL)
- Built-in Meilisearch full-text search engine
This addon is based on the official Monica application.
Configuration
Webui can be found at <your-ip>:8181.
Options
| Option | Type | Default | Description |
|---|---|---|---|
database |
list | sqlite |
Database type (sqlite/MariaDB_addon/Mysql_external) |
APP_KEY |
str | Application encryption key (auto-generated if empty) | |
DB_DATABASE |
str | Database name (for external MySQL/MariaDB) | |
DB_HOST |
str | Database hostname (for external MySQL/MariaDB) | |
DB_USERNAME |
str | Database username (for external MySQL/MariaDB) | |
DB_PASSWORD |
str | Database password (for external MySQL/MariaDB) | |
DB_PORT |
int | Database port (for external MySQL/MariaDB) | |
MAIL_MAILER |
str | log |
Mail driver (smtp/log/sendmail) |
MAIL_HOST |
str | SMTP server hostname | |
MAIL_PORT |
str | SMTP server port | |
MAIL_USERNAME |
str | SMTP username | |
MAIL_PASSWORD |
str | SMTP password | |
MAIL_ENCRYPTION |
str | SMTP encryption (tls/ssl) | |
MAIL_FROM_ADDRESS |
str | From email address | |
MAIL_FROM_NAME |
str | From email name |
Example Configuration
database: "sqlite"
APP_KEY: "" # Will be auto-generated
MAIL_MAILER: "smtp"
MAIL_HOST: "smtp.gmail.com"
MAIL_PORT: "587"
MAIL_USERNAME: "your-email@gmail.com"
MAIL_PASSWORD: "your-app-password"
MAIL_ENCRYPTION: "tls"
MAIL_FROM_ADDRESS: "your-email@gmail.com"
MAIL_FROM_NAME: "Monica"
Database Configuration
SQLite (Default):
- No additional configuration required
- Data stored in addon directory
- Suitable for single-user setups
MariaDB Addon:
- Set
databasetoMariaDB_addon - Requires MariaDB addon to be installed and running
- Addon will auto-configure database connection
External MySQL/MariaDB:
- Set
databasetoMysql_external - Configure all
DB_*options with your database details
Email Configuration
Configure SMTP settings to enable:
- Password reset emails
- Invitation emails
- Notification emails
- Reminder emails
Custom Scripts and Environment Variables
This addon supports custom scripts and environment variables through the addon_config mapping:
- Meilisearch full-text search: The addon ships with an embedded Meilisearch service that Monica uses by default. The search API listens on
http://127.0.0.1:7700inside the container. OverrideMEILISEARCH_URLviaenv_varsif you prefer an external Meilisearch instance—the init script will detect that and skip starting the bundled daemon. You can further tweak Meilisearch by defining extra environment variables through theenv_varsoption if needed. To secure (or disable) Meilisearch authentication without custom env vars, set themeilisearch_keyadd-on option; the init script will pass it to both Monica and the bundled Meilisearch instance. - Custom scripts: See Running Custom Scripts in Addons
- env_vars option: Use the add-on
env_varsoption to pass extra environment variables (uppercase or lowercase names). See https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon-2 for details.
Installation
The installation of this add-on is pretty straightforward and not different in comparison to installing any other Hass.io add-on.
- Add my Hass.io add-ons repository to your Hass.io instance.
- Install this add-on.
- Configure database and email settings as needed.
- Click the
Savebutton to store your configuration. - Start the add-on.
- Check the logs of the add-on to see if everything went well.
- Open the webUI to set up your Monica account.
First Setup
After installation and startup:
- Open the webUI at
<your-ip>:8181 - Create your first user account
- Complete the setup wizard
- Start adding your contacts and relationships
Support
Create an issue on github, or ask on the home assistant community forum
For more information about Monica, visit: https://www.monicahq.com/
