Monitor

Simple cronjob monitoring tool for your servers

Installation and usage

Use Nixpacks to build the frontend and backend images and run them with Docker.

Note that the project requires configuration in .env files, see the example files in the src/backend and src/frontend directories.

Frontend

The frontend optionally requires the following environment variables to be set:

• VITE_TOLGEE_API_URL - the URL of the Tolgee API
• VITE_TOLGEE_API_KEY - the API key for the Tolgee API

These two are only required if you want to do development.

Backend

The backend requires the following environment variables to be set:

• DATABASE_URL - a Postgres database URL
• REDIS_URL - a Redis database URL
• EMAIL_* - SMTP server configuration to send email notifications when a system is down
• COOKIE_KEY - a 64-byte key to encrypt cookies (see below for instructions on how to generate one)
• SITE_URL - the URL of the frontend site

Note that the backend requires the PRODUCTION environment variable to be set to true to send emails.

Generate a cookie key

To generate a cookie key, you need to spin up a new Rust project with cargo new your_project_name and paste the following code:

# Cargo.toml
rand = "0.9.0-alpha.1"
axum-extra = { version = "0.9.3", features = ["cookie-private"]}

// src/main.rs
use axum_extra::extract::cookie::Key;
use rand::{Rng, thread_rng};

fn main() {
    // Generate a cryptographically random key of 64 bytes
    let mut rng = thread_rng();
    let mut random_key = [0u8; 64];
    rng.fill(&mut random_key);
    match Key::try_from(&random_key[..]) {
        Ok(key) => {
            println!("Random key: {:?}", key.master());
        }
        Err(e) => {
            println!("Error: {:?}", e);
        }
    }
}

Then run the project with cargo run and copy the cookie key to the .env file in the backend directory.

Cd into the both frontend and back end directories and run the following commands:

cd src/frontend
nixpacks build .
cd ../backend
nixpacks build .

Then run the command provided by Nixpacks to run the images.

Remember to set the environment variables while deploying to prod as .env won't be copied over to the Docker container.

Development

To run the frontend and backend in development mode, you can use the following commands:

cd src/frontend
pnpm install
pnpm dev

cd src/backend
cargo run

License

This project is licensed under the MIT License, see the LICENSE file for details.