Skip to content

twilsonco/UptimeKuma-DiscordBot

 
 

Repository files navigation

GitHub stars GitHub forks

Uptime Kuma X Discord

You might have wondered if there's a tool to set your service statuses in Discord, whether it's your Minecraft server or your website. There are players who are curious to see the status but are too lazy to open the URL.

You've found the tool! 😄

As you can see in the screenshot below, the bot is able to send a message on a certain interval and edit it. With the help of a couple of emojis, it is clear for your audience if something is happening with the services.

Screenshot

Installation and Configuration:

  1. Clone the repository:

    git clone https://github.com/twilsonco/UptimeKuma-DiscordBot.git
    cd UptimeKuma-DiscordBot
  2. Install Uptime Kuma and configure it:

  3. Create a Discord bot

  4. Choose your setup method:

    • Standard Setup

      1. Create a web server capable of running PHP
      2. Install Node JS
    • Docker Setup

      • Either use docker-compose:

        • Modify the paths in docker-compose.yml to match your system
        • Run docker-compose up -d
      • Or use these docker commands:

        # Build the image
        docker build -t uptime-kuma-discord-bot /path/to/UptimeKuma-DiscordBot
        
        # Run the container
        docker run -d \
          --name uptime-kuma-discord-bot \
          -v /path/to/config.json:/app/config.json:ro \
          -e TZ=<YourTimeZone> \
          --network bridge \
          uptime-kuma-discord-bot
      • Replace /path/to/UptimeKuma-DiscordBot and /path/to/config.json with the actual paths on your system

      • Lookup your time zone string on Wikipedia

  5. Follow these back-end instructions

  6. Follow these bot instructions

Future Plans:

We plan to implement Uptime Kuma Incidents report in a Discord Embed. Currently, it's not possible because Uptime Kuma doesn't share this data in its metrics API.

Feel free to fork or reuse this code!

For any assitance or information, I kindly redirect you to my Discord account.

Keywords:

  • Minecraft server status
  • Discord bot integration
  • Uptime monitoring
  • Service status updates
  • Discord notifications
  • Interval-based messaging
  • Emojis for service status
  • Uptime Kuma integration
  • Uptime Kuma Discord bot
  • Uptime Kuma Discord integration
  • Discord Embeds for server status

About

A Discord bot that will monitor your Uptime Kuma instances

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 77.4%
  • PHP 17.7%
  • Dockerfile 4.4%
  • Shell 0.5%