GitXplorerGitXplorer
l

kronos-discord

public
4 stars
2 forks
1 issues

Commits

List of commits on branch main.
Verified
c30cacf31816b5c1e68445596093ef748e6d3411

Merge pull request #3 from tmepy/tmepy-kronos-inspect

llramos15 committed a year ago
Unverified
eac49830f4486e2bb77f0f322c4576d0a147dbbf

Staff Role Value

ttmepy committed a year ago
Unverified
3c9e2cff2a5804a4c738b9112f117e216e86b977

Added Service ID to embed

ttmepy committed a year ago
Verified
b9f4d34f586d9e17e5a2ca67edb5a37cab5581a9

Added new staff kronos command

ttmepy committed a year ago
Verified
2579f7f74087395fe59c91ead51bc7d75a8f8251

Merge pull request #2 from tmepy/tmepy-patch-1

llramos15 committed 2 years ago
Verified
09e0556c701afde4664909ebffee809b5530f98e

Fixed typo

ttmepy committed 2 years ago

README

The README file for this repository.

Kronos Bot

Brings many commonly used Kronos dashboard features right to discord! This project integrates the Kronos service for managing plex appboxes right into discord. This project is not affiliated with the Kronos team in any manner.

A photo of a discord embed showing information about a plex appbox

Setup

A pre-requisite to using this integration is to ensure you have a WHMCS install, a valid Kronos subscription, and Docker installed on the host machine.

  1. Create a discord bot and add it to your server. Follow this guide. The bot needs the bot scope with the send messages, embed links, and use external emojis permissions.
  2. Create a Kronos API key. This can be done under the admin dashboard > Integrations > Kronos API > New API Key
  3. Copy / rename the .env.example file to .env and fill in all the values. Note the bot is able to operate in two modes, one which utilizes the internal Kronos API and requires admin credentials and another that utilizes the external API and requires an API key. The two feature sets attempt to mirror each other as closely as possible, but there are some differences. The external API is recommended, but the internal one at times may provide additional features which are not available in the external API.
  4. Build the docker image with docker build -t kronos-bot-image .
  5. Run the docker image with docker run -d --name kronos-bot kronos-bot-image
  6. 🎉 You're done! The bot should now be online and ready to use. The logs can be viewed with docker logs kronos-bot.

Usage

The bot registers a single command /Kronos. This command displays all appboxes which a user has access to. Access is determined by having their discord id linked to their WHMCS in the WHMCS database. Kronos's discord integration is not currently supported.

How to contribute

This project requires Node.js v16.x or greater. VS Code is the recommended code editor due to debugging and linting support.

  1. Fork the repository
  2. Clone the repository
  3. Run npm install
  4. Make your changes
  5. Run npm run build && npm run lint
  6. Commit your changes
  7. Open a pull request
  8. 🎉 Thanks for your contribution!

If you make any changes to the commands, running npm run registerCommands will be necessary for your app to utilize the commands.

License

This project is licensed under the MIT license. See the LICENSE file for more information.