https://github.com/huntie/minecraft-status-notifier

Simple status notifier utility for Minecraft Server on Supervisord
https://github.com/huntie/minecraft-status-notifier

minecraft-server supervisord webhooks

Last synced: 16 days ago
JSON representation

Simple status notifier utility for Minecraft Server on Supervisord

• Host: GitHub
• URL: https://github.com/huntie/minecraft-status-notifier
• Owner: huntie
• License: gpl-3.0
• Created: 2017-02-05T23:16:46.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-06-10T21:46:34.000Z (over 7 years ago)
• Last Synced: 2024-10-30T08:57:33.598Z (about 2 months ago)
• Topics: minecraft-server, supervisord, webhooks
• Language: JavaScript
• Homepage:
• Size: 24.4 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Minecraft server status notifier

A small Node.js utility to listen to [Supervisord](http://supervisord.org/) events and publish status messages to a webhook receiver such as [Discord](https://discordapp.com/), [Telegram](https://telegram.org/) or [Slack](https://slack.com/).

## 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](http://supervisord.org/events.html#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.