Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/nrkno/MMM-Slack

Slack integration for MagicMirror²
https://github.com/nrkno/MMM-Slack

Last synced: 3 months ago
JSON representation

Slack integration for MagicMirror²

Awesome Lists containing this project

README

        

# MagicMirror² Module: MMM-Slack
This is a module integrating Slack in [MagicMirror²](https://github.com/MichMich/MagicMirror). It displays messages from the a given Slack channel in config.js. The module also supports update and delete messages

## How to install

Remote into your MagicMirror box using a terminal software and go to the application folder:

cd ~/MagicMirror

Clone the repository:

git clone https://github.com/nrkno/MMM-Slack

Install dependencies:

`npm install`

Add the module to the modules array in the config/config.js file by adding the following section. You can change this configuration later when you see this works:

{
module: 'MMM-Slack',
position: 'lower_third',
config: {
slackToken: 'YOUR_SLACK_TOKEN_GOES_HERE',
slackChannelId: 'THE_CHANNEL_ID_YOU_WANT_MESSAGES_FROM'
}
},

## Configuration options


Option
Comment
Default


slackToken
You must create a test token for the [Slack API](https://api.slack.com/tokens)
aaaa-bbbbb-ccccc-dddd-12344


slackChannelId
Which Slack channel you want to display messages from. You can get the id by opening the web interface for slack, click on the actual channel and you will find the id in the url
W1234567890


showUserName
If true, the message sender's user name will be displayed with the message
true


showLatestMessageOnStartup
If true, the latest message in the channel will be displayed on startup
false