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

Warning

Stamon is in active development and is not usable yet, but you are welcomed to try it out. ;-)

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 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 issue 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

docker compose up stamon

Then visit http://localhost:3000.

🏗️ Development

cd ./frontend
pnpm dev

Then on other terminal start the backend

cargo run

Then visit http://localhost:5173

📝 Contributing

Thank you very much for considering contributing to this project!

We appreciate any form of contribution:

  • New issues (feature requests, bug reports, questions, ideas, ...)
  • Pull requests (documentation improvements, code improvements, new features, ...)

👷 Contributors

Contributors to krivahtoo/stamon

Made with contrib.rocks.

📜 License

This project is licensed under the MIT license.