Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jeffvestal/sabot


https://github.com/jeffvestal/sabot

Last synced: 5 days ago
JSON representation

Awesome Lists containing this project

README

        

# SA Bot
Jeff Vestal

A bot that saves slack messages when an emoji is triggered
Also provides search of saved messages, and app search engines
Maybe some other stuff at some point

## Help Output
> Hi There!, I know how to do the following:
>
> Saving Slack Messages
>
> When you see a message in Slack you think is useful, helpful, or worth
> saving for easy retrieval in the future: Tag any message with the
> :sa-save: reaction
>
> You will get sent back a message asking for your help tagging the
> message, to make it easier to find in the future

>
> Commands I understand
>
> `help` - You are reding this now
>
> `search [search terms]` - Search for previously saved Slack Messages
>
> `docs [search terms]` - Search Elastic Docs
>
> `search advanced` - Bring up the advanced search form
>
> `listtags` - List tags of previously saved Slack messages

## Example Usage
### Tagging a message
When you tag a message with `sabot` response
1. `@sabot` will also use the same response to ack it
2. you will get a popup, only visable to you, asking to help categorize the message
CleanShot 2022-08-31 at 13 42 32@2x

3. Second level categorization popup

CleanShot 2022-08-31 at 13 42 45@2x

CleanShot 2022-08-31 at 13 42 59@2x

### Searching
The easiest way to search is with `@sabot search `

This will search previously searched slack messages, Elastic Docs, and Elastic Blogs.

You can search any of those individually with the specific command `slack`, `docs`, or `blogs` followed by the search terms

CleanShot 2022-08-31 at 13 44 53@2x

CleanShot 2022-08-31 at 13 45 23@2x

CleanShot 2022-08-31 at 13 45 36@2x

## Example video

https://user-images.githubusercontent.com/53237856/187762232-60b35362-bbaa-4f5d-8d85-ea06ce8765de.mp4

# Environment Variables that must be set

- "sabot_cloud_id":
- "sabot_cloud_es_user": ""
- "sabot_cloud_es_pass": ""
- "discourse_user": ""
- "discourse_api": ""
- "discourse_server": "
- "SLACK_APP_TOKEN": ""
- "SLACK_BOT_TOKEN": ""
- "sabot_appsearch_api": ""
- "sabot_appsearch_url": ""
- "ELASTIC_APM_SECRET_TOKEN": ""
- "ELASTIC_APM_SERVICE_NAME": ""
- "ELASTIC_APM_SERVER_URL": "<_ess_apm_server_url>"