Giter Club home page Giter Club logo

mellow's Introduction

Mellow Paypal Discord Docker Run on Repl.it

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

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

npm install

To start the bot just simply type

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 (https://github.com/v0idp/Mellow/fork)
  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

mellow's People

Contributors

v0idp avatar alpha5k avatar calamityjames avatar lludlow avatar imdevinc avatar nwithan8 avatar vjfalk avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.