Giter Club home page Giter Club logo

minecraft-status-notifier's Introduction

Minecraft server status notifier

A small Node.js utility to listen to Supervisord events and publish status messages to a webhook receiver such as Discord, Telegram or Slack.

Usage

npm install

Edit .env to specify a target webhook URL and Supervisor process group name to match.

Next, define a event listener in your Supervisor configuration (under /etc/supervisor/conf.d/). A subset of event types can be matched.

[eventlistener:minecraft_status]
command=node app.js
directory=/home/minecraft/minecraft-status-notifier
user=minecraft
events=PROCESS_STATE

Finally, load the updated configuration.

supervisorctl update

To match additional event types and customise broadcasted messages, edit config/messages.json.

Maintenance mode

Maintenance mode can be set from the package directory. When enabled, new event messages will be suppressed.

npm run down

This creates a MAINTENANCE_MODE file which can be deleted manually, or is removed when maintenance mode is disabled.

npm run up

Sidenote

This implementation can easily be generalised for any Supervisor-managed process, however was created as a quick personal tool and serves for reference purposes.

minecraft-status-notifier's People

Contributors

huntie avatar

Stargazers

 avatar

Watchers

 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.