Uptime Mate is a terminal-based monitoring tool to track the uptime and status of your servers and applications. With its interactive interface, dynamic layout, and real-time monitoring, it's your go-to solution for server health checks in the terminal! 🌟
- 🖥 Monitor Multiple Services
Track the uptime, status, and performance of multiple servers and applications. - 🧩 Dynamic Mosaic Layout
Displays monitoring data in an organized, visually appealing format. - 🛠 Customizable Add-ons
Extend the tool's functionality with plugins tailored to your needs. - 📜 Real-Time Logs
Get live logs and server feedback directly in the terminal. - 🎛 Interactive Interface
User-friendly, keyboard-driven terminal UI for easy navigation.
- Node.js (v16 or newer)
- npm or yarn
- Clone the repository:
git clone https://github.com/makis-san/uptime-mate.git
- Navigate to the project directory:
cd uptime-mate - Install dependencies:
npm install
- Run the app:
npm start
Once you start the application, you'll see an interactive terminal interface. From here, you can:
- Add new servers to monitor.
- Check server statuses in real time.
- View logs for insights.
- Monitor all your applications in a mosaic-style layout.
All monitored servers and their configurations are stored in a YAML file named monitored.yml. Here's an example of the structure:
- _id: unique-server-id
address: https://example.com
addon: HTTPS
lastStatus:
success: true
message: "Server is UP"
timestamp: 2025-01-24T19:46:40.489Z
- _id: another-server-id
address: mc.example.net
addon: Minecraft
lastStatus:
success: false
message: "Server is DOWN"
timestamp: 2025-01-24T19:47:12.123ZModify the file to add, update, or remove servers.
| Key | Action |
|---|---|
| Tab | Move focus between sections |
| Arrow Keys | Navigate options |
| Enter | Select or interact |
| Escape | Return to the main menu |
| Ctrl + C | Exit the application |
Add-ons allow Uptime Mate to monitor different types of services (e.g., HTTP, Minecraft). The default add-ons include:
- HTTPS Monitoring
- Minecraft Server Monitoring
To add a custom add-on:
- Place your add-on file in the
addonsdirectory. - Implement your monitoring logic using the provided API.
We welcome contributions! Here's how you can help:
- Fork the repository. 🍴
- Create a feature branch:
git checkout -b feature-name🚀 - Commit your changes:
git commit -m "Add feature"✅ - Push to your fork:
git push origin feature-name📤 - Open a pull request. 📨
This project is licensed under the MIT License. See the LICENSE file for details.
If you encounter any issues or have questions, feel free to open an issue or contact us via email.
Enjoy using Uptime Mate to simplify your server monitoring! 🎉