Skip to content

Discord bot that displays Uptime Kuma service statuses through a /status command with minimal or detailed views.

License

Notifications You must be signed in to change notification settings

rlko/kuma-disgo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kuma-DisGo

A Discord bot that displays Uptime Kuma service statuses in a Discord channel.

Features

  • Real-time service status monitoring from Uptime Kuma's API
  • Minimal and detailed view options
  • Automatic status updates
  • Restricted to server owners
  • Persistent storage of status message info using SQLite

Building

The project uses a Makefile for building and packaging:

# Build the binary
make build

# Build with compression (requires UPX)
make compress

# Create a Debian package with compression
make deb COMPRESS=1

# Create a tarball with compression
make tarball COMPRESS=1

# Install system-wide
make install

# Install for current user
make user-install

The binary will be created in the project directory, while packages and archives will be placed in the build directory.

Setup

  1. Create a Discord bot and get its token
  2. Look at config.yaml.example for configuration details and create a config.yaml file with your settings.
  3. Run the bot:
./kuma-disgo

You can specify a custom config file path using the -c or --config flag:

./kuma-disgo -c /path/to/your/config.yaml

Commands

  • /status [view:minimal|detailed] - Show service statuses (restricted to server owners)

Status Indicators

  • 🟢 Up
  • 🔴 Down
  • 🟡 Pending
  • 🔵 Maintenance
  • ⚪ Unknown

Storage

The bot uses SQLite to store status message info, allowing for persistent storage across restarts. The database file (status.db) is created in the same directory as the config.yaml file.

Demo

Demo

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

Discord bot that displays Uptime Kuma service statuses through a /status command with minimal or detailed views.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published