Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/v0idp/Mellow

Mellow can communicate with several APIs like Ombi, Sonarr, Radarr and Tautulli which are related to home streaming to use those services directly in your Discord client.
https://github.com/v0idp/Mellow

api bot commands discord docker mellow movies ombi plex plex-server plexpy radarr series sonarr streaming tautulli telegram

Last synced: 4 days ago
JSON representation

Mellow can communicate with several APIs like Ombi, Sonarr, Radarr and Tautulli which are related to home streaming to use those services directly in your Discord client.

Awesome Lists containing this project

README 

        
# Mellow [![Paypal](https://img.shields.io/badge/PayPal-Donate-Green.svg?logo=Paypal&style=flat-square)](https://www.paypal.com/donate?hosted_button_id=CQ6VM34ZC68HE) [![Docker](https://img.shields.io/badge/Docker-Hub-lightblue.svg?logo=docker&style=flat-square)](https://cloud.docker.com/u/voidp/repository/docker/voidp/mellow) [![Run on Repl.it](https://repl.it/badge/github/v0idp/Mellow)](https://repl.it/github/v0idp/Mellow)





   





   Mellow can communicate with several APIs like Ombi, Sonarr, Radarr and Tautulli which are related to home streaming to use those services directly in your Discord client.




## Features



* Search for Movies & TV Shows in Ombi or Sonarr / Radarr

* Request Movies & TV Shows in Ombi or Sonarr / Radarr

* Get a list of all Libraries on your Server in Tautulli

* Additional Features following soon!



## Requirements



* [NodeJS 12.4.1 LTS or higher](https://nodejs.org/en/download/)



## Create Bot



Go to this website: https://discordapp.com/developers/applications/ and press ``new Application``. Copy the Client ID first, you will need that later.

After you have done that go to the Settings Tab to the left and select Bot and press ``Add Bot``. You can now copy the Token from the Bot which you will

need for the Mellow Configuration later on.



## Invite Bot



Before your Bot actually listen to the channels on your server you will have to invite it first. I recommend using this for beginners: https://discordapi.com/permissions.html

Select the Permissions from below and paste the Client ID down there which you copied earlier. After that just click the link on the bottom and you will

be redirect to a new page where you can select the server you want to invite the Bot too.



* Read Messages

* Embed Links

* Read Message History

* Use External Emojis

* Send Messages

* Manage Messages

* Attach Files

* Mention @everyone

* Add Reactions



## Installation



Go into the Mellow root folder and type

```sh

npm install

```



To start the bot just simply type

```sh

npm start

```



## Configuration



After starting the bot you will need to configure it by visiting ``youripordomain:port`` and filling out the Bot Settings which will start the bot with your token.

The default login credentials are username: ``mellow`` password: ``default``. Please change these as soon as possible!

Note: It's recommended to set a username and password in General Settings. This way only you can access the web interface.



## Docker Setup & Start



If you want to use this bot in a docker container you have to follow these steps:

* Pull from docker hub: ``docker pull voidp/mellow``

* Run docker image:

```

docker run -d --restart=unless-stopped --name mellow \

   -v /opt/appdata/mellow/:/usr/src/app/data/ \

   -e JWT_SECRET=secret_password \

   -e PORT=5060 \

   -p 5060:5060 \

   voidp/mellow

```

* if you want persistent data create a folder in ``/opt/appdata/mellow/`` or use docker compose. A yaml file is provided for this purpose.



## Contributing



1. Fork it ()

2. Create your feature branch (`git checkout -b feature/fooBar`)

3. Commit your changes (`git commit -am 'Add some fooBar'`)

4. Push to the branch (`git push origin feature/fooBar`)

5. Create a new Pull Request