Streamdeck Uptime Kuma

Unofficial Uptime Kuma plugin for Elgato Streamdeck.

Features

• Allow to add a monitor button displaying:
  • The current state of the monitor (Background color):
    • 🟩 Green -> Up
    • 🟥 Red -> Down
    • 🟧 Orange -> Paused
    • ⬛ Grey -> Unkown status (waiting for the first status).
  • And any of this information:
    • The current ping in ms (ping of the last heartbeat).
    • The average ping in ms (on last 24 hours)
    • The uptime (%) during last 24 hours.
    • The uptime (%) during last 30 days.
• Info displayed can be changed by pressing the button (switch between current ping, average ping 24h, uptime 24h, uptime 30d).
• Buttons can also be configured to Pause/Resume the monitor on tap.
• The plugin use the Uptime Kuma SocketIO interface (like the official frontend) so monitor's states are instantly synced with the server.

Roadmap

• Add long press action binding. MarlBurroW#4
• Connect the socket only if actions are displayed on the current screen MarlBurroW#3
• Add a group of monitors action button. MarlBurroW#5
• Allow to add multiple Kuma instance. MarlBurroW#6

Installation

Install from the Elgato Streamdeck Store

https://apps.elgato.com/plugins/com.marlburrow.uptime-kuma

Or download the latest release directly from this repo

Download the latest release, and run the com.marlburrow.uptime-kuma.streamDeckPlugin file.

Or build from source

You can build the plugin from source (Only on windows because the Elgato DistributionTool is needed):

1. Clone the repository

git clone https://github.com/MarlBurroW/Streamdeck-Uptime-Kuma

2. Install node dependencies

yarn

3. Run the build.bat file

.\build.bat

The bat will build the js/css with webpack (vue-cli), then Package the plugin with the DistributionTool, then execute the plugin.

Troubleshooting

• CORS error resulting to xhr poll error message. #1 TLDR: Update your Streamdeck software

Or create an issue here https://github.com/MarlBurroW/Streamdeck-Uptime-Kuma/issues