73 lines
2.4 KiB
Markdown
73 lines
2.4 KiB
Markdown
# 🖥️ iKeyMon — macOS App for Monitoring KeyHelp Servers
|
||
|
||
iKeyMon is a native macOS app written in SwiftUI that provides live monitoring for your KeyHelp servers using the KeyHelp API.
|
||
|
||
## ✅ Current Features
|
||
|
||
- Displays key system information from your KeyHelp server via the API
|
||
- Shows CPU load, memory usage, swap usage, and disk usage
|
||
- Periodic ping via `/api/ping` endpoint to check if a server is reachable
|
||
- Colored status indicator for each server in the list
|
||
- Automatic refreshes:
|
||
- Ping every 10 seconds
|
||
- Server info every 60 seconds
|
||
- Preferences dialog
|
||
- Built-in Sparkle updater (automatic checks, downloads, and relaunch once a signed release is available)
|
||
- macOS notifications if servers or services become unavailable
|
||
- Organized layout using tabs: General / Resources / Services
|
||
- Stores API keys securely in the macOS Keychain
|
||
- Native macOS look & feel using SwiftUI
|
||
|
||
## 📸 Screenshots
|
||
|
||
| General | Resources | Services | Edit Server |
|
||
|--------|-----------|----------|--------------|
|
||
|  |  |  |  |
|
||
|
||
## 🛠️ Planned Features
|
||
|
||
- iOS support is a possibility, but it is unclear if or when that will happen
|
||
|
||
## 📦 Install
|
||
|
||
### Option 1: Download the app
|
||
|
||
Download the latest release from:
|
||
|
||
https://git.24unix.net/tracer/iKeyMon/releases
|
||
|
||
Then open the DMG and move `iKeyMon.app` to your `Applications` folder.
|
||
|
||
### Option 2: Install with Homebrew
|
||
|
||
```bash
|
||
brew tap tracer/tap https://git.24unix.net/tracer/homebrew-tap.git
|
||
brew install --cask ikeymon
|
||
```
|
||
|
||
### Option 3: Build it yourself
|
||
|
||
Clone the repository, open it in Xcode, and run the app locally on macOS 14+.
|
||
|
||
## 🚀 How to Build
|
||
|
||
Clone the repo and open it in [Xcode](https://developer.apple.com/xcode/). You can build and run the app on macOS 14+.
|
||
|
||
```
|
||
git clone https://git.24unix.net/tracer/iKeyMon
|
||
cd iKeyMon
|
||
open iKeyMon.xcodeproj
|
||
```
|
||
|
||
## 📦 License
|
||
|
||
MIT — see [LICENSE](LICENSE) for details.
|
||
|
||
> You're free to build and use this app however you want, but please don't upload an unchanged version to the App Store under the same name.
|
||
> Once it's stable, I may release it on the App Store for a small fee (1–2€) to cover my Apple Developer account.
|
||
|
||
## 💬 Feedback
|
||
|
||
Join the discussion (in German) here:
|
||
🔗 https://community.keyhelp.de/viewtopic.php?t=13851
|