Skip to content

A lightweight self-hosted status monitoring tool, written in Rust.

License

Notifications You must be signed in to change notification settings

krivahtoo/stamon

Repository files navigation

Shows a black logo in light color mode and a white one in dark color mode.

A lightweight self-hosted status monitoring tool, written in Rust.

Rust CI Node CI ALX Portfolio Project Docker Image Version GitHub last commit GitHub License

Note

Stamon is currently in active development and is not yet fully functional. However, you are welcome to try it out and provide feedback! ;-)

2024-09-19-180624_1366x665_scrot

✨ Features

  • Real-Time: Keep track of your services and resources with up-to-the-second updates.
  • Lightweight: Minimal resource usage, ideal for environments with limited resources.
  • More features coming soon!

🚀 Quick Start

Although some features are missing the basic monitoring is working as expected. You can try it out and open an issue if you encounter any bugs or any feature you would like to be added to stamon.

🚢 Docker

docker run

docker run -it -e JWT_SECRET="hello-world" -p 3000:3000 k4htoo/stamon

docker compose

services:
  stamon:
    image: k4htoo/stamon

    environment:
      JWT_SECRET: "A_very_secure_secret"
    ports:
      - "3000:3000"

Then, start the container:

docker compose up stamon

Visit http://localhost:3000.

🏗️ Development

To start the frontend:

cd ./frontend
pnpm dev

Then on other terminal start the backend

cargo run

Then visit http://localhost:5173

📝 Contributing

Thank you for considering contributing to Stamon! Contributions are welcome, including:

  • New Issues: Feature requests, bug reports, questions, ideas, and more.
  • Pull Requests: Documentation updates, code improvements, new features, etc.

👷 Contributors

Contributors to krivahtoo/stamon

Made with contrib.rocks.

🛣️ Roadmap

  • Implement notification system for alerts
    • Integration with third-party services (e.g., Telegram, Slack, email notifications)
  • Add more monitoring types (e.g. DNS, TCP, docker)
  • Add support for custom alert thresholds

📜 License

This project is licensed under the MIT license.