https://github.com/mariogarridopt/xbar-uptime-kuma
An xbar plugin to display Uptime Kuma Status on Mac taskbar
https://github.com/mariogarridopt/xbar-uptime-kuma
addons macbook macos plugins python taskbar uptime-kuma xbar xbar-plugin
Last synced: about 2 months ago
JSON representation
An xbar plugin to display Uptime Kuma Status on Mac taskbar
- Host: GitHub
- URL: https://github.com/mariogarridopt/xbar-uptime-kuma
- Owner: mariogarridopt
- License: gpl-3.0
- Created: 2023-01-24T11:41:25.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-02-23T09:32:05.000Z (over 2 years ago)
- Last Synced: 2024-11-06T02:37:55.248Z (11 months ago)
- Topics: addons, macbook, macos, plugins, python, taskbar, uptime-kuma, xbar, xbar-plugin
- Language: Python
- Homepage:
- Size: 79.1 KB
- Stars: 29
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
xBar-Uptime-Kuma
===
This is a [xBar Plugin](https://github.com/matryer/xbar) & [Uptime Kuma addon](https://github.com/louislam/uptime-kuma) that allows you to display your monitored status on the Macbook taskbar.
## 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:
```python
# -------------------------------------------
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](https://github.com/louislam/uptime-kuma) does not have a formal API([#8](https://github.com/mariogarridopt/xBar-Uptime-Kuma/issues/8)), I had to use [uptime-kuma-api](https://github.com/lucasheld/uptime-kuma-api).
This is not great because for this to work now you have to install dependencies first:
```bash
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](https://github.com/mariogarridopt/xBar-Uptime-Kuma/issues).
[How to make a contribution](CONTRIBUTING.md)
### License
This project is available under the [GPL-3.0 license](LICENSE).