search

mariogarridopt / xBar-Uptime-Kuma

An xbar plugin to display Uptime Kuma Status on Mac taskbar
GNU General Public License v3.0
27 stars 2 forks source link
addons macbook macos plugins python taskbar uptime-kuma xbar xbar-plugin

readme

xBar-Uptime-Kuma

This is a xBar Plugin & Uptime Kuma addon that allows you to display your monitored status on the Macbook taskbar.

screenshot

How to use it

  1. Copy the uptimekuma.30s.py file into your xBar scripts folder;
  2. Make sure the file has execution permissions chmod +x uptimekuma.30s.py;
  3. Install python dependencies pip install uptime-kuma-api
  4. Open uptimekuma.30s.py file and change the following fields: 
    # -------------------------------------------
BASE_URL = 'http://localhost:3001' # uptime kuma URL no trailing slash
USERNAME = 'admin' # uptime kuma username
PASSWORD = 'admin' # uptime kuma password
# -------------------------------------------
  5. You are ready!

Dependencies

Since Uptime Kuma does not have a formal API(#8), I had to use uptime-kuma-api. This is not great because for this to work now you have to install dependencies first:

pip install uptime-kuma-api

We might remove this dependence when Uptime Kuma publishes an official API.

Contributing

This project is only possible because of your help. If you find any bug please report it at issues.

How to make a contribution

License

This project is available under the GPL-3.0 license.