This guide will walk you through installing stamon, a lightweight, self-hosted status monitoring tool written in Rust.

📥 Prerequisites

Before installing stamon, make sure you have the following dependencies installed:

• Docker (for containerized deployment) → Install Docker
• Rust (for manual installation) → Install Rust
• Node.js & PNPM (for frontend development) → Install Node.js & PNPM

🐳 Install via Docker (Recommended)

The easiest way to get Stamon up and running is using Docker.

Run with Docker CLI

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

Run with Docker Compose

Create a docker-compose.yml file:

version: "3"
services:
  stamon:
    image: k4htoo/stamon
    environment:
      JWT_SECRET: "A_very_secure_secret"
    ports:
      - "3000:3000"

Then run:

docker compose up -d

Now visit http://localhost:3000.

⚙️ Manual Installation (Rust)

For those who prefer running Stamon without Docker:

1. Clone the Repository

git clone https://github.com/krivahtoo/stamon.git
cd stamon

2. Build and Run

cargo build --release
./target/release/stamon

By default, the server runs on port 3000.

🏗️ Development Setup

To set up a development environment:

Backend

cargo run

Frontend

cd frontend
pnpm install
pnpm dev

Then visit http://localhost:5173.

📝 Configuration

You can customize Stamon using environment variables:

To set these values, create a .env file:

JWT_SECRET="super_secret_key"
PORT=3000