README.md

Mattermost holobot (holobot)

A bot for Mattermost servers that can listen for events and perform actions.

Table of Contents

• Background
• Install
  • Dependencies
• Usage
  • Starting the Bot
  • Testing the Bot
  • Stopping the Bot
• Maintainer
• Contribute
• License

Background

This code is based on mattermost-bot-sample-golang made by mattermost.

Install

1. Clone the GitHub repository.

$ git clone https://github.com/qubist/holobot.git
$ cd holobot

2. Create a config file called config.yaml and setup the values like this:

Domain: "your.chatdomain.com"
LongName: "Mattermost Bot Sample"
UserEmail: "[email protected]"
UserPassword: "somepasswordhere"
UserName: "imabot"
UserFirst: "Im A"
UserLast: "Bot."
PublicTeamName: "name-of-public-team"
PrivateTeamName: "name-of-private-team"
DebuggingTeamName: "name-of-debugging-team"
LogChannel: "debugging-for-sample-bot"
Debugging: false

3. Get the Mattermost server model package.

$ go get github.com/mattermost/mattermost-server/model

Dependencies

• golang

Usage

Starting the Bot

$ make run

You can verify the Bot is running when

• Server detected and is running version 3.X.X appears on the command line.
• Mattermost Bot Sample has started running is posted in the Debugging For Sample Bot channel.

Testing the Bot

1. Log in to the Mattermost server using the login you defined in config.yaml. ([email protected] and somepasswordhere in the given example.)

2. Join the Debugging For Sample Bot channel.

Stopping the Bot

1. In the terminal window, press CTRL+C to stop the bot. You should see Mattermost Bot Sample has stopped running posted in the Debugging For Sample Bot channel.

Maintainer

NOT Will

zippy has maintained this software in the past

Contribute

Questions can be asked in the Holochain public Mattermost server. I'd love your suggestions!

Pull requests are accepted. Contributions to the code would be greatly appreciated!

License

Apache License 2.0