Minecraft hosting utility

RS-MOTD-V1
Documentation

Installation and configuration guide for displaying custom Minecraft server-list messages based on Pterodactyl server states.

PlatformUbuntu / Debian
RuntimeNode.js 16+

Installation

Step 1: Upload and extract

Upload the RS-MOTD-V1 ZIP to your VPS, then run these commands from the directory containing it.

unzip RS-MOTD-V1.zip -d rs-motd-v1
cd rs-motd-v1

Step 2: Run the installer

The installer installs dependencies and creates a systemd service. Review the script before running it on a production server.

chmod +x install.sh
sudo ./install.sh

Step 3: Configure your panel

sudo nano /opt/rs-motd-v1/config.yml

Set the correct Pterodactyl panel URL and API keys. Never share API keys or upload them to a public website.

Configuration checklist

Panel URLYour Pterodactyl panel base URL.
Application API keyRequired permissions as documented by your panel.
Client API keyUse a suitable admin account key.
MOTD port rangeDefault range begins at 4001; check for conflicts.
Security: keep config.yml private. Do not paste API keys into support chats or commit them to Git.

The supplied configuration includes example panel values. Replace every example value before starting the service. Check the original resource's licensing terms before redistribution.

Managing the service

Start service

sudo systemctl start rs-motd-v1

Enable at boot

sudo systemctl enable rs-motd-v1

Check status

sudo systemctl status rs-motd-v1 --no-pager

View live logs

sudo journalctl -u rs-motd-v1 -f

Restart after changes

sudo systemctl restart rs-motd-v1

Stop service

sudo systemctl stop rs-motd-v1

Troubleshooting

  • Service fails: run systemctl status and inspect the journal logs.
  • API errors: verify panel URL, key type, permissions, and HTTPS certificate.
  • Port conflict: check whether another service is listening on the configured ports.
  • Config changes: restart the service after saving the YAML file.