/ephemeral-enforcer

A slack bot that deletes messages for ephemerality sake!

Primary LanguageJavaScript

ephembot Version Badge

Build Status

A slack bot that deletes messages for ephemerality sake!

How to use

Install

Via NPM (preferred)

npm install --global ephembot
ephembot -p 3000

Docker (soon to be preferred)

export SLACK_TOKEN=<slack token>
docker pull zachjamesgreen/ephembot
docker run -d --name ephembot \
-e SLACK_TOKEN=${SLACK_TOKEN} \
-e EPHEMBOT_PORT=<container port> \
-p <host port>:<container port>
zachjamesgreen/ephembot

Make sure to export your slack token.

Git clone

git clone https://github.com/Denver-Devs/ephemeral-enforcer.git
cd ephemeral-enforcer

npm start will run ephembot on port 3000.

You can also install ephembot globally or npm link from inside the repo and run ephembot -p 4000 which will run it on port 4000. Choose whatever port you want.

Configure slack

Add a slash command to your slack organization that POSTs to <your server>:<your port>/ephemeral

Name the slash command whatever. Traditionally it is /ephemeral

Commands

Ephembot runs only in the channel from which the command is used this allows for per-channel configuration.

Setting ephembot's level tells it to delete messages that are older than the level. ex. /ephemeral level 20 minutes will tell ephembot to delete messages that are older than 20 minutes, every 20 minutes.

/ephemeral on

Turns ephembot on at the default interval 15 minutes for the current channel

/ephemeral off

Turns ephembot off for the current channel

/ephemeral level <15 minutes | 1 hour | 30 seconds>

Turns ephembot on at the given interval for the current channel

/ephemeral status

Responds with the current channels level

Issues

If you have any issues with ephembot feel free to submit them here

js-standard-style