Skip to content

Commit

Permalink
update docs and docker compose
Browse files Browse the repository at this point in the history
  • Loading branch information
dreth committed Sep 28, 2024
1 parent a2e3ea5 commit bcc6006
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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}
Expand Down Expand Up @@ -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}
Expand Down
1 change: 1 addition & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down

0 comments on commit bcc6006

Please sign in to comment.