Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/noraworld/mastodon-to-slack
A very simple Slack integrations tool for posting Mastodon statuses to Slack channel
https://github.com/noraworld/mastodon-to-slack
mastodon slack
Last synced: 2 days ago
JSON representation
A very simple Slack integrations tool for posting Mastodon statuses to Slack channel
- Host: GitHub
- URL: https://github.com/noraworld/mastodon-to-slack
- Owner: noraworld
- License: mit
- Created: 2018-10-13T12:26:45.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-18T17:27:16.000Z (about 6 years ago)
- Last Synced: 2024-05-02T05:54:14.871Z (7 months ago)
- Topics: mastodon, slack
- Language: Ruby
- Size: 496 KB
- Stars: 4
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mastodon-to-Slack
Mastodon-to-Slack is a simple Slack integrations tool to post a toot to a Slack channel by using [Incoming Webhooks](https://api.slack.com/incoming-webhooks).
## Setup
To use this tool you need a few configurations.
### Create a File of Environment Variables
1. Copy `.env.sample` file
```
$ cp .env.sample .env
```
2. Fill in `MASTODON_INSTANCE_HOST` and `MASTODON_USERNAME`
- `MASTODON_INSTANCE_HOST` is a Mastodon instance hostname with which you want to integrate Slack. **A URL scheme and a trailing slash must not exist**.
- `MASTODON_USERNAME` is your username, not a display name. **`@` and a Mastodon instance hostname must not exist**.
```
# Bad
MASTODON_INSTANCE_HOST='https://mastodon.social'
MASTODON_INSTANCE_HOST='mastodon.social/'
# Good
MASTODON_INSTANCE_HOST='mastodon.social'
```
```
# Bad
MASTODON_USERNAME='@noraworld'
MASTODON_USERNAME='[email protected]'
MASTODON_USERNAME='@[email protected]'
# Good
MASTODON_USERNAME='noraworld'
```
### Generate a Mastodon Access Token
1. Access `https:///settings/applications/new`
2. Create a new application by following the screenshot below
| Item | Value |
|:---:|:---:|
| Application name | Anything is OK |
| Application website | Anything is OK |
| Redirect URI | `urn:ietf:wg:oauth:2.0:oob` (default) |
| Scopes | Only read |
3. Click the `SUBMIT` button
4. Copy your access token
5. Paste it to `MASTODON_ACCESS_TOKEN` in `.env`
### Create an Incoming Webhook
1. Access [Slack App Directory](https://slack.com/apps)
2. Search Incoming WebHooks
3. Click the `Add Configuration` button
4. Select a channel you want to integrate
5. Click the `Add Incoming WebHooks integration` button
6. Copy your Webhook URL
7. Paste it to `SLACK_WEBHOOK_URI` in `.env`
8. [OPTIONAL] Change integration settings
### Install RubyGems
```
$ bundle install
```
## Usage
The usage is very simple. All you need to do is run the following command:
```
$ ruby src/mastodon_to_slack.rb
```
Note that you must run this command in a project root directory:
```
# Bad
$ cd src
$ ruby mastodon_to_slack.rb
# Good
$ ruby src/mastodon_to_slack.rb
```
Toot something, and this tool will post a Mastodon status URL to a Slack channel!
### How to Stop
To stop this tool just send SIGINT signal (press `Ctrl-C`).
### Verbose Mode
When a connection closes or an error occurs, it outputs nothing because a log file is filled with tons of connection close and error messages!! If you want to output all of the statuses just append `--verbose` to the command.
```
$ ruby src/mastodon_to_slack.rb --verbose
```
## License
All codes of this repository are available under the MIT license. See the [LICENSE](./LICENSE) for more information.