twittermost

command module
v1.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 28, 2022 License: AGPL-3.0 Imports: 16 Imported by: 0

README

twittermost

twittermost is a Mattermost bot that will announce the tweets of the tweeps it follows on twitter.

Installing

First, install twittermost

$ go install github.com/bwesterb/twittermost@latest

Create a Twitter user (say @twitteruser) and a Mattermost user (say matteruser) for the bot. Register a new app on twitter to get consumer key, consumer secret, access token and access secret.

Copy config.json.templateto config.json in the conf folder. Now edit it with the information obtained from Twitter. Then run with twittermost.

Install Using Docker

In case you want to run twittermost in a docker container, there is a way to do it.

Create a Twitter user (say @twitteruser) and a Mattermost user (say matteruser) for the bot. Register a new app on twitter to get consumer key, consumer secret, access token and access secret.

Then clone (or download) this project. Copy config.json.templateto config.json in the conf folder. Now edit it with the information obtained from Twitter. Then run

docker build . -t twittermost
docker run -it --rm --name twittermost -v "$PWD"/conf:/go/src/app/conf twittermost

Usage

The twittermost bot will respond to command by trusted users. To add trusted users, use:

  1. @matteruser trust username

Like a chick which hasn't seen its mother yet, the twittermost bot will trust anyone initially, until it's told who to trust.

  1. @matteruser distrust username Removes the given Mattermost user from the trusted users.
  2. @matteruser follow twitterhandle Follow the given user on twitter.
  3. @matteruser unfollow twitterhandle Unfollow the given user on twitter.
  4. @matteruser check Force a twitter timeline check for updates.
  5. @matteruser clear Removes all error messages in the debug channel.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL