Documentation

How it works?

Monitoror is a single file app, divided into two parts:

Core

Core is the server-side Monitoror's HTTP API, configured by the environment variables or .env file.

UI

UI is the client-side Monitoror loaded in browser, which is the wallboard itself.

Installation

Run the Core

Linux / macOS

Open your terminal, make monitoror executable, and run it:

chmod +x monitoror
./monitoror
      

Windows

Open PowerShell or cmd, then run:

.\monitoror.exe
      

Docker

The Core is already running, go to the next step.

Access the UI

Once the Core is launched, you should be able to go to: http://localhost:8080

Note Change localhost for the Monitoror host IP if needed

Port 8080 already used? Go to Core documentation and search for MO_PORT

Create your UI configuration

As a starting point, save this in a config.json file next to monitoror binary:

{
  "version": "2.0",
  "columns": 2,
  "tiles": [
    {
      "type": "PORT",
      "label": "Welcome config example",
      "params": {
        "hostname": "127.0.0.1",
        "port": 8080
      }
    },
    {
      "type": "HTTP-RAW",
      "label": "Monitoror stars",
      "params": {
        "url": "https://github.com/monitoror/monitoror",
        "regex": "(\\d+) users starred"
      }
    }
  ]
}
      

Hey, what's that "UI configuration"?
It's a JSON file where you will define what you want to display.

Setup Core configuration

You need to tell to the Core that you have a new UI configuration. To do so, put the following in a file named .env next to monitoror binary file:

MO_CONFIG="./config.json"
      

Another configuration?
Yes! This one is mostly here to register UI configurations and to setup monitorables, which are things that you can use in your UI configurations.

Restart the Core

As you have updated the .env file, you need to stop and start again the monitoror command, and you should see that in start logs:

AVAILABLE NAMED CONFIGURATIONS

  default -> ./config.json
      

Wait, when did I need to restart?
You need to restart the Core (the monitoror binary) each time you update the .env file.

You're done! 🎉

You should now see the UI with 2 tiles, and you're ready to go!

What's next?