KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#typescript #ai-agents #cli #open-source #ai #claude-code #codex #developer-tools #react #windows #deepseek-harness #ai-agent

kumatray

★ 79 Open GitHub ↗

Windows Tray Icon Application

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# KumaTray

![Version](https://img.shields.io/badge/version-1.1.0-green) ![Platform](https://img.shields.io/badge/platform-Windows-blue) ![License](https://img.shields.io/badge/license-MIT-yellow)

**KumaTray** is a lightweight system tray application for Windows that lets you monitor your [Uptime Kuma](https://github.com/louislam/uptime-kuma) instances **without opening a browser**. It only notifies you when a monitor goes **DOWN**, so you can focus on what really matters.

---

## ✨ Features

- 🔔 **Real-time notifications** – Instantly alerts you when a monitor goes down or up.

- 🖥️ **System tray integration** – Runs silently in the background, accessible from the tray icon.

- 🔄 **Auto-refreshing** – Periodically checks the status of your services.

- 🔐 **2FA support** – Compatible with two-factor authentication.

- 🌐 **HTTPS support** – Secure communication with your Uptime Kuma instance.

- 📊 **Detailed statistics** – Displays key details for each affected monitor.

## 📋 Requirements

- 💻 **Operating System**: Windows 10

- 🐍 **Python**: Version 3.9 or higher

---

## 🚀 Installation

#### 🔧 Method 1: Run from Source (Developer Mode)

1. **Clone this repository**:

```
git clone https://github.com/querylab/kumatray.git
```

2. **Install the dependencies**:

```
pip install -r requirements.txt
```

3. **Run the application**:

```
python KumaTray.py
```

#### 📦 Method 2: Run Precompiled .exe (Recommended for Users)
  1. Download the latest release from the **release/** folder.

2. Make sure the following two files are in the same folder.

3. Double-click KumaTray.exe to start the app.

```
KumaTray.exe
notification_config.json
```

📝 Important: The **notification_config.json** file must remain in the same folder as KumaTray.exe to ensure your configuration and instance data are saved correctly.

---

## ⚙️ Configuration

1. Right-click on the system tray icon.
2. Select **"Add Instance"**.
3. Enter the URL of your Uptime Kuma instance.
4. Provide your login credentials (2FA supported).
5. Click **"Test Connection"** to verify.

---

## 📁 Project Structure

```
kumatray/
├── KumaTray.py                # Main application file
├── build_compile.py           # Script to compile the app
├── convert_icons.py           # Icon conversion utility
├── notification_config.json   # Notification settings and save state
├── requirements.txt           # Python dependencies
├── LICENSE                    # MIT License
├── README.md                  # Project documentation
├── resources/                 # Icon and image resources
│   ├── icon.py                # Icon handler module
│   └── icons/                 # Icons in various sizes
│       ├── app_icon.ico
│       ├── icon16.png
│       ├── icon48.png
│       └── icon128.png
├── release/                   # Compiled application releases
│   ├── KumaTray.exe           # Executable Windows application
│   └── notification_config.json # Configuration file save state
└── src/                       # Source code
    ├── icon_main_tray.py      # Tray icon logic
    ├── ui_dialog.py           # Dialog UI components
    └── uptimekuma_api.py      # API interaction with Uptime Kuma

```

---

## 📢 Warnings

- 🧪 **Compatibility**: Tested only on Windows 10.

- 💾 **Memory Usage**: Monitoring multiple instances may increase RAM consumption.
- ⚠️ **Beta Version**: KumaTray is currently in beta. Please report any issues.

---
## ⭐ Support This Project

If you find this tool helpful, please consider giving it a ⭐

---

kumatray

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README