https://github.com/ronnyfriedland/gumo-bot
https://github.com/ronnyfriedland/gumo-bot
bot debian github-actions golang
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ronnyfriedland/gumo-bot
- Owner: ronnyfriedland
- License: mit
- Created: 2023-12-20T09:14:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-06T19:25:36.000Z (over 2 years ago)
- Last Synced: 2024-04-16T19:08:06.832Z (about 2 years ago)
- Topics: bot, debian, github-actions, golang
- Language: Go
- Homepage:
- Size: 3.83 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# GUMO
## Send good morning messages to a given rocketchat or webex channel
## Parameters
The gumo application provides the following arguments which can be passed:
| Property | Description |
|---------------|--------------------------------------------------------------------------------------|
| configpath | Defines the location of the configuration files, default: /etc/gumo |
| message | Defines the (optional) message to send and skips shuffle selection from message file |
## Configuration
### gumo.properties
This file has to be placed in `/etc/gumo/` directory.
You can find an example of the properties file here: [gumo.properties.template](gumo.properties.template)
| Property | Description |
|----------|--------------------------------------------------------------------|
| target | Which target to use, possible values are "rocketchat" and "webex" |
#### Rocketchat
| Property | Description |
|-----------|---------------------------------------------------------------------------------------------------------|
| userId | The userId generated by rocketchat |
| authToken | Authentication token generated by rocketchat |
| channel | the target channel where to send the message to, has to start with "#" |
| url | the api endpoint of your rocketchat instance
see https://developer.rocket.chat/reference/api/rest-api/endpoints/messaging/chat-endpoints/postmessage |
#### Webex
| Property | Description |
|-----------|----------------------------------------------|
| authToken | Authentication token generated by rocketchat |
| room | the target room where to send the message to |
| url | the webex instance url |
### gumo.messages
This file contains the available messages to send. One random message is chosen every day.
This file has to be placed in `/etc/gumo/` directory.
## Status
### gumo.status
This file stores the status to determine if the good morning message was already send for the current day.
## Execution
### Prerequisites
The user who is executing the gumo needs write access to the status file.
During installation a `gumo` group is created which can be used to get write permissions.
### Do gumo
If your user is member of the `gumo` group or you are `root`:
```shell
gumo
```
If you do not want to add your user to the `gumo` group you can use `sudo`:
```shell
sudo gumo
```
## Releases
You can find all available releases [here](https://github.com/ronnyfriedland/gumo-bot/releases)
## License
This application is published under the [MIT license](LICENSE).