Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
cpitkin committed Nov 15, 2017
1 parent ce1d481 commit f69c1a2
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,22 @@ ARCHIVEBOT_BASIC=true || false
## Rate limits

Due to Slack's strict rate limit and given that several requests need to be made per channel. The script will run each request at a rate of 1 request per 2 seconds. This will help avoid the rate limit that Slack imposes of roughly 1 req/s. Don’t run the cli more than once every hour to avoid rate limits.

## Docker

There is now a Dockerfile that can be used to build a container to run the cli.

Using environment variables
```bash
docker run --rm -d \
-e ARCHIVEBOT_NEVER_ARCHIVE=$ARCHIVEBOT_NEVER_ARCHIVE \
-e ARCHIVEBOT_SLACK_TOKEN=$ARCHIVEBOT_SLACK_TOKEN \
-e ARCHIVEBOT_INACTIVITY_DAYS=$ARCHIVEBOT_INACTIVITY_DAYS \
slack-archivebot
```

Using flags
```bash
docker run --rm -d \
slack-archivebot -n "test" -t abc123 -d 60
```

0 comments on commit f69c1a2

Please sign in to comment.