Mellow - n05urpr1532-MHA-Team/PTS-Team GitHub Wiki

Table of Contents

  1. Intro
  2. Access Information
  3. General Configuration
  4. Summary

1. Intro

Mellow creates a Discord Bot which can communicate with several APIs like Ombi, Sonarr, Radarr and Tautulli. From the bot, in Discord, you can search and request in Ombi, get a list of all content from Tautulli and more !

2. Access Information

i. General Access

Protocol Address Notes
traefik** mellow:5060 Only for Internal App-to-App Communication
https mellow.domain.com Traefik must be Deployed; Remote Servers
http domain.com:5060 Poor Security Practice - Stop with PTS Port Guard
http ipv4:5060 Ideal Only for Local Servers

** Ideal for Apps to communicate between with one another. Click Here for more info!

3. General Configuration

a. Discord Bot Creation

Before setting Mellow up, you'll need a Discord server with your bot inside. You can check the official Discord website for more information: https://discordapi.com/permissions.html

The bot will need following permissions:

  • Read Messages
  • Embed Links
  • Read Message History
  • Use External Emojis
  • Send Messages
  • Manage Messages
  • Attach Files
  • Mention @everyone
  • Add Reactions

You'll need 2FA enabled to add some of theses permissions.

TODO - Check on Google the Bot creation for now!

b. Mellow Configuration

Access Mellow to start setting it up.

General

You can setup a username/password if you need to.

Remember, yoiu should have activated PTS Shield !

Bot

  • Token
  • Owner ID
    • Your Discord ID. To get it from the desktop app, enable "Developer Mode" under "Appearance" advanced settings.
  • Command Prefix
    • Eg. /mybot, or !mellow

Ombi

  • Define your ombi host, port, and API key.
  • As of 23/04/2019, there is a know issue if you leave "Ombi Username" empty. Put your Ombi username.

4. Usage

This wiki will assume your prefix is /mybot.

Use /mybothelp or /mybot help to view the commands list.

The main commands are

  • Ombi

    • movie: search and request movies in ombi
    • tv: search and request tv shows in ombi

  • Tautulli

    • libraries: get a list of all libraries on your server
    • refreshlibraries: refresh all libraries in tautulli