Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/max-wittig/lunchbot
Circuit Bot to inform people about lunch and the 5moods menu
https://github.com/max-wittig/lunchbot
5moods circuit helm-chart kubernetes lunch lunchbot openshift
Last synced: 24 days ago
JSON representation
Circuit Bot to inform people about lunch and the 5moods menu
- Host: GitHub
- URL: https://github.com/max-wittig/lunchbot
- Owner: max-wittig
- License: mit
- Created: 2019-06-08T13:33:36.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T05:34:25.000Z (almost 2 years ago)
- Last Synced: 2024-03-21T05:50:41.043Z (8 months ago)
- Topics: 5moods, circuit, helm-chart, kubernetes, lunch, lunchbot, openshift
- Language: JavaScript
- Homepage:
- Size: 112 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LunchBot
Circuit Client, which uses the Javascript SDK to provide a LunchBot
## Usage
Make sure that you have a mongodb instance running on localhost listening on port 27017.
See below how to customize that.
```sh
yarn
yarn start
```
## Required environment variables
* CLIENT_ID
* CLIENT_SECRET
## Optional environment variables
* DOMAIN : domain of your Circuit enviroment. Defaults to `circuitsandbox.net`
* TEST_MODE : wether to run in test mode
* MENU_TIME_CRON : cron string, when to send the menu to the conversation. Defaults to `00 10 * * 1-5`
* WARNING_TIME_CRON : cron string, when to ask if anyone is joining. Defaults to `20 11 * * 1-5`
* LUNCH_TIME_CRON : cron string, when to send go to lunch message. Defaults to `30 11 * * 1-5`
* SCOPE : define Circuit application scopes. Defaults to `null`
* MONGO_HOST : hostname that your mongodb is running on. Defaults to `localhost`
* MONGO_PORT : port that mongodb listens on. Defaults to `27017`
* MONGO_URL : instead of using `MONGO_HOST` and `MONGO_PORT`, as direct URL can also be used
## Docker usage
```sh
# Easier way is just to use docker-compose
CLIENT_ID=$CLIENT_ID -e CLIENT_SECRET=$CLIENT_SECRET docker-compose up --build
# or you can also manually attach a mongo db instance
# build the image
docker build -t lunchbot .
# Start mongodb locally
docker run --rm -p 27017:27017 -d mongo
# run the bot
docker run --rm -d -e CLIENT_ID=$CLIENT_ID -e CLIENT_SECRET=$CLIENT_SECRET -e MONGO_HOST=localhost lunchbot
# or use the upstream image directly
docker run --rm -d -e CLIENT_ID=$CLIENT_ID -e CLIENT_SECRET=$CLIENT_SECRET -e MONGO_HOST=localhost registry.gitlab.com/max-wittig/lunchbot:latest
```
## Commands usage
You can requests the following information everytime, using slash command:
* /subscribe -> subscribe your conversation to receive the menu
* /unsubscribe -> unsubscribe from the conversation to receive the menu
* /status -> display status message, if bot is up and running
* /menu -> show lunch menu for today
* /source -> show source of the bot
* /show-subscription -> show current subscription options
* /modify-subscription -> modfiy subscription with new options
* /help -> show all available commands
### Options
While running some of the command above you can additionally also specify
some settings in yaml format.
You can always specify for which instance the command should be executed.
This is useful for debugging, when multiple instances are running with the same
variables. You can check the UUID using the `/status` command.
Examples:
```
@LunchBot /menu
uuid:
```
Special command options:
* timezone -> specifc the timezone the cron should be in. Defaults to `Europe/Zurich`
* menuCron -> specifc custom menu cron. Defaults to `0 10 * * 1-5`
* warningCron -> specifc custom warning cron. Defaults to `0 11 * * 1-5`
* lunchCron -> specifc custom lunch cron. Defaults to `30 11 * * 1-5`
```
@LunchBot /subscribe
timezone: Europe/Zurich
warningCron: 0 11 * * *
```