[rbdr/monitorcito] / README.md

# Monitorcito

A tiny monitor that gives you the status of a handful of systemd services.

## Configuration

This project uses environment variables to change configuration.

* `MONITORCITO_SERVICES`: A comma separated list of services. Required.
* `MONITORCITO_PORT`: A comma separated list of services. Defaults to 1991.


Set `NODE_DEBUG=monitorcito` if you want to log any output. Otherwise it will
be silent.

## How to run

Set the appropriate environment variables and run `bin/monitorcito`.

## The Frontend

Monitorcito includes a public directory, this is a frontend that queries
the service and refreshes every 5 seconds. The service assumes the API
is running in `/api`.

Here's an example of how to set it up with nginx.

```
upstream monitorcito {
	server localhost:1991;
	keepalive 64;
}

server {
	listen 80;

	root /home/deploy/src/monitorcito/public;
	index index.html;

	server_name monitor.unlimited.pizza;

	location /api {
		proxy_redirect off;

		proxy_pass http://monitorcito;
	}
}
```
Commit	Line	Data
2d72aab0 RBR	1	# Monitorcito
	2
	3	A tiny monitor that gives you the status of a handful of systemd services.
	4
	5	## Configuration
	6
	7	This project uses environment variables to change configuration.
	8
	9	* `MONITORCITO_SERVICES`: A comma separated list of services. Required.
	10	* `MONITORCITO_PORT`: A comma separated list of services. Defaults to 1991.
	11
	12
	13	Set `NODE_DEBUG=monitorcito` if you want to log any output. Otherwise it will
	14	be silent.
	15
	16	## How to run
	17
	18	Set the appropriate environment variables and run `bin/monitorcito`.
	19
	20	## The Frontend
	21
	22	Monitorcito includes a public directory, this is a frontend that queries
	23	the service and refreshes every 5 seconds. The service assumes the API
	24	is running in `/api`.
	25
	26	Here's an example of how to set it up with nginx.
	27
	28	```
	29	upstream monitorcito {
	30	server localhost:1991;
	31	keepalive 64;
	32	}
	33
	34	server {
	35	listen 80;
	36
	37	root /home/deploy/src/monitorcito/public;
	38	index index.html;
	39
	40	server_name monitor.unlimited.pizza;
	41
	42	location /api {
	43	proxy_redirect off;
	44
	45	proxy_pass http://monitorcito;
	46	}
	47	}
	48	```