From bcc60064f7b1769ddcd5af7b8c89571f0bc24a7a Mon Sep 17 00:00:00 2001 From: dreth Date: Sat, 28 Sep 2024 13:50:24 +0200 Subject: [PATCH] update docs and docker compose --- README.md | 4 ++++ docker-compose.yml | 1 + 2 files changed, 5 insertions(+) diff --git a/README.md b/README.md index 79b51aa..b7dd9ed 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,8 @@ The application usage is very straightforward: 2. Add birthdays 3. Receive reminders +If a default bot is set in the env. variable HBD_DEFAULT_BOT_API_KEY, the user will receive reminders through that bot. Otherwise, the user will receive reminders through the bot they set up. + ## hbd-cli Hbd has a frontend which you can use to interact with the API, but you can also use the [hbd-cli](https://github.com/dreth/hbd-cli), which is a companion command-line tool that interacts directly with the hbd API. It allows you to interact with any hbd instance, not just the one you have running. @@ -55,6 +57,7 @@ services: - ENVIRONMENT=development - CUSTOM_DOMAIN=https://hbd.lotiguere.com - GIN_MODE=debug + - HBD_DEFAULT_BOT_API_KEY=${HBD_DEFAULT_BOT_API_KEY} # Optionally for backups of the birthday database to S3 or S3-compatible services - HBD_ENABLE_BACKUP=true - HBD_USER_ACCESS_KEY_ID=${HBD_USER_ACCESS_KEY_ID} @@ -90,6 +93,7 @@ services: - ENVIRONMENT=production - CUSTOM_DOMAIN=https://hbd.lotiguere.com - GIN_MODE=release + - HBD_DEFAULT_BOT_API_KEY=${HBD_DEFAULT_BOT_API_KEY} # Optionally for backups of the birthday database to S3 or S3-compatible services - HBD_ENABLE_BACKUP=true - HBD_USER_ACCESS_KEY_ID=${HBD_USER_ACCESS_KEY_ID} diff --git a/docker-compose.yml b/docker-compose.yml index d0809fe..6c7249b 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -17,6 +17,7 @@ services: - ENVIRONMENT=development - CUSTOM_DOMAIN=https://hbd.lotiguere.com - GIN_MODE=debug + - HBD_DEFAULT_BOT_API_KEY=${HBD_DEFAULT_BOT_API_KEY} # Optionally for backups of the birthday database to S3 or S3-compatible services - HBD_ENABLE_BACKUP=true - HBD_USER_ACCESS_KEY_ID=${HBD_USER_ACCESS_KEY_ID}