Sha256: 2485e93b059ae0bdc5a8e3cec050029b579c8571d22e6888ee7c1e3d73f98747

Contents?: true

Size: 1.52 KB

Versions: 3

Compression:

Stored size: 1.52 KB

Contents

# slackup
backup my slacks

## Installation

`gem install slackup`

## Usage

1. Get token for each team from https://api.slack.com/web

2. Configure a file in the backup directory called `slack_teams.yml`,
though `slack_teams.yaml` and `slack_teams.json` will also work.

The config file must contain a dictionary (hash) of 
team names (backup directories) and associated tokens.

e.g.

slack_teams.yml

```yaml
---
some-team: xxxp-some-token
another-team: xxxp-different-token
```

slack_teams.json

```json
{
  "some-team": "xxxp-some-token",
  "another-team": "xxxp-different-token"
}
```

3. Run `slackup` in your terminal

Each key/value team pair will be run in a local directory named by the key
using only the token for auth. Thus, the key (team) name can be whatever you want.

## Development

This gem is does the bare basics of backup and works for me.

It has no tests.

It depends on the ['slack-api' gem](https://github.com/aki017/slack-ruby-gem)

I run it periodically via `bash update.bash`

```bash
#!/usr/bin/env bash -l
bundle check || bundle --quiet
git commit -am "Update before update.bash"
bundle exec slackup &&
  git commit -am "Update via update.bash" &&
    git add . && git commit -am "Add new via update.bash"
```

## Contributing

1. Fork it ( https://github.com/[my-github-username]/slackup/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

MIT License

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
slackup-0.0.7 README.md
slackup-0.0.6 README.md
slackup-0.0.5 README.md