potato

KO | EN

gitlite — search

#react #ai #typescript #llm #golang #android #machine-learning #rust #docker #java #awesome-list #vue #security #openai

(★ 23)

🍿 Mr. Potato is your slackbot for couchpotato!

potato 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Couchpotato Slackbot
[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
[![Build Status](https://travis-ci.org/RolfKoenders/potato.svg?branch=master)](https://travis-ci.org/RolfKoenders/potato)
[![Docker Pulls](https://img.shields.io/docker/pulls/rolfkoenders/potato.svg)](https://hub.docker.com/r/rolfkoenders/potato/)
[![Docker Automated buil](https://img.shields.io/docker/automated/rolfkoenders/potato.svg)](https://hub.docker.com/r/rolfkoenders/potato/)
[![](https://images.microbadger.com/badges/image/rolfkoenders/potato.svg)](https://microbadger.com/images/rolfkoenders/potato "Get your own image badge on microbadger.com")

> Add movies to your couchpotato wanted list with just a simple slack message!

![search and download example](https://raw.githubusercontent.com/RolfKoenders/potato/master/assets/images/search-download.gif)

## Features
Mr. Potato has these features:
- Search for movies
- Add a movie to the wanted list by title ('download movie Frozen')
- Add a movie to the wanted list by IMDB id ('download movie tt2788732')

## Run
To start the bot simply run the start script inside the bin directory:
```
$ ./bin/start
```
Or `npm install` and `npm start` to launch the bot!

### Docker
Pull the latest docker image from the [Docker Hub](https://hub.docker.com/r/rolfkoenders/potato/) and run it. The environment variables you need to pass are listed below.

There is a dockerfile if you want to build a docker image yourself.
Run the following inside the project directory to build the image:
```
$ docker build -t couchbot ./
```
And launch it with the following command:
```
$ docker run -d --name couch-slackbot couchbot
```

## Configuration
Configuration of your bot can either be done using a config file or pass environment variables.

### File
In the `config` folder there is a `config.json.example` file you can copy and rename to `config.json`. Once configured you are ready to start the bot.

### Environment variables
If a config file is not ideal for your setup use environment variables. You can see in the table which env var to use for each config value.

| Description | ENV | Required |
|-------------|-----|----------|
| The slack token for this slackbot | CB_SLACK_KEY | ✓ |
| The name of the slackbot | CB_SLACK_NAME | ✓ |
| Couchpotato server hostname/ip | CB_HOST | ✓ |
| Couchpotato server port | CB_PORT | ✓ |
| Couchpotato base url | CB_BASE_URL | x |
| Couchpotato API key | CB_COUCH_KEY | ✓ |

## Usage
Mr. potato is listening to the following commands / messages. It can depend per command where its available. Most of them work in a channel but some only per direct message.

### Search
**Available in:** Channel & Direct message.

To search for a movie send the following as a private message: `search movie harry potter` This will return a list with the movies it found. _(Example gif on top of the README)._ The list returned also shows the IMDB id. This identifier can be send with the download movie command.

### Download
**Available in:** Channel & Direct message.

To add a movie to the wanted list its either possible to send `download movie Bad Boys II` it will add the first search result. _When using a movie title with the download command try to be as specific as possible._ Or send the IMDB identifier `download movie tt0172156`.

### Already downloaded?
**available in:** Channel & Direct message.

Check if a movie is already on the wanted list or downloaded. Send the following message: `do i have movie sausage party`.

### Suggestions?
**available in:** Channel & Direct message.

You want some suggestions? Send `do you have some suggestions?` to the bot and you will get a nice list of some suggestions.

### help
**Available in:** Direct message.

If you cannot access this readme for documentation and needs some help with some commands. Ask Mr. Potato for some help by sending `help` in a direct message. It will respond with the available commands.

### Admin commands
Admin commands are send in a private message to the bot, but the bot will only react on it if a admin user has send the message.

#### Version
By sending `!version` it will answer with the current version of the bot your talking to and the version of couchpotato which is configured.

#### Update
You can update couchpotato by sending the `!update` command. _Check with `!version` if there is a version available._

## Donate / Support
If you like Mr. Potato and it already saved you some time, consinder buying me a coffee to show your support! Thanks in advance!
[![](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/rolfkoenders "Buy me a coffee")

### License
[MIT](https://opensource.org/licenses/MIT)

potato

potato 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

potato

potato 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README