Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/datadog/slack-channel-manager
Slack Bot for private channel management in a public workspace.
https://github.com/datadog/slack-channel-manager
nodejs slack slackbot
Last synced: 4 days ago
JSON representation
Slack Bot for private channel management in a public workspace.
- Host: GitHub
- URL: https://github.com/datadog/slack-channel-manager
- Owner: DataDog
- License: mit
- Created: 2018-09-18T13:42:09.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-24T20:08:11.000Z (7 months ago)
- Last Synced: 2024-04-24T21:27:05.524Z (7 months ago)
- Topics: nodejs, slack, slackbot
- Language: JavaScript
- Homepage:
- Size: 1.29 MB
- Stars: 8
- Watchers: 6
- Forks: 4
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# slack-channel-manager
Slack bot for private channel management in a public slack workspace.
## Usage
Please see the [detailed usage instructions][1] on the project wiki more information.
## Roadmap
Currently, the following features are supported:
- Requesting a private channel for a specific user
- Querying a list of all active channels managed by the bot
- Joining a private channel created by another authorized user
- Marking managed channels for automatic expiry
- Managing channels that were manually created by users (unmanaged)
If you would like to see any features implemented (or see any problems with the current functionality), please submit an issue or a pull request.
## Setup Instructions
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. The deployment process will be exactly the same.
### Prerequisites
These dependencies are required before proceeding with a local installation:
- NodeJS and NPM
- MongoDB
- [ngrok][2] (or some secure localhost tunnelling service)
### Installing locally
Clone this repo
```sh
git clone [email protected]:DataDog/slack-channel-manager.git
```
Navigate to the repo and install dependencies
```sh
cd slack-channel-manager
npm install
```
### Running locally
Run the localhost tunnelling service (instructions here are for ngrok on development port 8080).
Note down the `` that appears in the output. Also, note that this subdomain changes everytime you restart the service. So, be sure to update the Slack Command Request URLs in the Slack API Dashboard.
```sh
ngrok http 8080
## You should see the following output if your ngrok account has been setup correctly
# ngrok by @inconshreveable
# Session Status online
# Account (Plan: Free)
# Version 3.8.0
# Region United States (us)
# Web Interface http://127.0.0.1:4040
# Forwarding https://.ngrok-free.app -> localhost:8080
#
# Connections ttl opn rt1 rt5 p50 p90
# 0 0 0.00 0.00 0.00 0.00
```
Start up a MongoDB server. Note: create `mongodb-data` directory at root.
```sh
mongod --dbpath=mongodb-data/
```
Run the bot
```
npm start
```
### Setting up the Slack App
IMPORTANT: Before proceeding, create a new "role account" user and make it an administrator in your Slack workspace. Use this account as the account you use to login to the [Slack Apps Dashboard][3] and perform all the following setup instructions. Otherwise, the bot will perform all actions _on behalf of your personal Slack account_, which is probably not desirable.
Go to your [Slack Apps Dashboard][3] and click on **Create New App**. Make sure not to click on the _Interested in the next generation of apps?_ section. Give the app a name (e.g. `slack-channel-manager`), select a workspace in which you will be testing the bot, and submit the form.
Navigate to the _Bot Users_ section in the sidebar, then
- Click on **Add a Bot User**
- Give it a suitable _Display name_ (e.g. "Channel Manager Bot") and a _Default username_ (e.g. "channel-manager-bot")
- Toggle **Always Show My Bot as Online** on
- Submit the form with **Add Bot User**
Navigate to the _Slash Commands_ section in the sidebar, then create the following commands:
| Command | Request URL | Short Description | Usage Hint | Escape |
| --- | --- | --- | --- | --- |
| /request-channel | https://\.ngrok-free.app/command/request-channel | Requests a private channel | [@user-to-invite] | ✓ |
| /extend-expiry | https://\.ngrok-free.app/command/extend-expiry | Extends a channel's expiry date | [number of days] | |
| /set-expiry | https://\.ngrok-free.app/command/set-expiry | Sets a channel's expiry date | YYYY-MM-DD | |
| /remove-user | https://\.ngrok-free.app/command/remove-user | Remove a user from a private channel | [@user-to-remove] | ✓ |
Navigate to the _Interactive Components_ section in the sidebar, then
- Toggle **Interactivity** on
- Set the **Request URL** to `https://.ngrok-free.app/action`
- Add an action with the following fields:
| Name | Description | Callback ID |
| --- | --- | --- |
| Request Private Channel | Request a private channel with a user. | request_channel_action |
Navigate to the _Event Subscriptions_ section in the sidebar, then
- Toggle **Enable Events** on
- Set the **Request URL** to `https://.ngrok-free.app/event`
- Note that the app must be locally running before setting the Request URL. If everything is correctly configured, a "Verified" icon should appear.
- Under the _Subscribe to Workspace Events_ section, add the following events:
```
group_archive
group_deleted
group_rename
group_unarchive
member_joined_channel
member_left_channel
```
- Under the _Subscribe to Bot Events_ section, add the following events:
```
member_joined_channel
message.im
```
Navigate to the _OAuth and Permissions_ section in the sidebar, then
- Add `https://.ngrok-free.app/oauth` to the _Redirect URLs_ section
- Click on **Select Permission Scopes** and add the following scopes:
```
channels:read
chat:write:bot
groups:read
groups:write
bot
commands
users:read
```
- After saving all changes, click on **Install App to Workspace**
Installing the app to your testing Slack workspace will supply you with all the credentials you need to set up your local environment. The example `.env` file provided in this repository provides instructions on how to set it up.
```
cp .env.example .env
# Follow the instructions inside the new .env file and fill it out
```
Finally, create an "authorization" private channel in your Slack workspace. This channel will be used as a home for all users that are allowed to interact with the Channel Manager. In other words, if a user would like to use the bot, they must be a part of this authorization channel. The name of this channel can be any valid channel name, but it must match the value of `AUTH_CHANNEL` as specified in your `.env` file.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
[1]: https://github.com/DataDog/slack-channel-manager/wiki/Usage-Instructions
[2]: https://ngrok.com/
[3]: https://api.slack.com/apps/