brian/helperbot
1
0
Fork 0
Code Issues 1 Pull Requests Releases Wiki Activity

Update Readme

Browse Source
This commit is contained in:
Brian Buller 2019-11-22 13:08:05 -06:00
parent 69e3af3626
commit 973a0944d4
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -6,11 +6,22 @@ It uses a bolt db for all data storage.
## Installation ## Installation
The script `package.sh` will build all plugins from source and the helperbot binary then create a tgz file in the
current directory containing:
* `helperbot` - The binary
* `helperbot.service` - A systemd service to run helperbot (You WILL need to customize this to your needs)
* `plugins/` - The directory containing the compiled plugins source
Just copy that archive to the server you want to run it on and extract it where you want it.
Run the binary manually the first time, to trigger the setup walkthrough stuff.
On first run, the app will prompt the user for: On first run, the app will prompt the user for:
* Slack Token: The bot uses this to connect to your slack * Slack Token: The bot uses this to connect to your slack
* Admin User DM ID: This is the 'admin users' DM ID, it's a 9 character Slack ID that starts with a `D`. * Admin User DM ID: This is the 'admin users' DM ID, it's a 9 character Slack ID that starts with a `D`.
This is the Direct Message ID for the admin user. This is the Direct Message ID for the admin user.
Use `Ctrl-C` to quit.
## Included Plugins: ## Included Plugins:
### Advent of Code ### Advent of Code