mfiscus/ref-bot repository overview

https://github.com/mfiscus/ref-bot⁠

⁠ref-bot

A Discord bot that provides real-time status information for amateur radio reflectors. Supports reflectors running mfiscus⁠'s URFD API⁠ or the default MREFD API bundled with KC1AWV⁠'s gomrefdash⁠.

⁠Commands

All responses are ephemeral (visible only to the user who ran the command).

⁠Prerequisites

• A Discord application and bot token — create one at discord.com/developers⁠
• A running URF or MREF reflector with a compatible JSON API
• Node.js 22+ (for local deployment) or Docker

⁠Configuration

Copy config.json-example to config.json and fill in your values:

{
    "token": "your-bot-token",
    "clientId": "your-application-id",
    "guildId": "your-server-id",
    "icon": "https://example.com/your-icon.png",
    "url": "https://your-reflector-dashboard-url"
}

⁠Deployment

⁠Docker (recommended)

services:
  ref-bot:
    image: mfiscus/ref-bot:latest
    container_name: ref-bot
    volumes:
      - /opt/ref-bot:/config
    restart: unless-stopped

Place your config.json at /opt/ref-bot/config.json on the host, then:

docker compose up -d

⁠Local

npm install
node deploy-commands.js   # register slash commands with Discord (run once)
node index.js

⁠Development

npm install
npx eslint .        # lint
node index.js       # run

⁠Docker Hub

Pre-built multi-architecture images (linux/amd64, linux/arm64) are published automatically to hub.docker.com/r/mfiscus/ref-bot⁠ on every push to main, on tagged releases, and on a monthly schedule to pick up base image updates.

⁠License

GPL-3.0-or-later⁠