Skip to content

giuem/uptimerobot-page

Repository files navigation

UptimeRobot Page

Another status page based on UptimeRobot

Travis Docker Build Status Codecov GitHub package version license Renovate enabled

Requirements

  • Node.js >= 10
  • Uptime Robot API key
  • Docker and docker-compose (optional)

Deploy

wget https://raw.githubusercontent.com/giuem/uptimerobot-page/master/docker-compose.yml
docker-compose up -d

Configure

There are two ways to configure:

The file loading order is default.yml < ${NODE_ENV}.yml < environment variables. It's recommend to set secrets (e.g. API key) via environment variables and something complex (e.g. array and object) via files.

Parser Usage

We use the parser to analyze groups name, monitors name and group index (optional) which included in your original monitor's name. Default Parser is %group/%name, there are 3 variables now:

  • %group
  • %name
  • %index

You can change the backslash / to any separator you like, as long as it won't used in your group & monitor name (and index). To put index into your parser, you will able to sort your group in page manually. Easily write index for each group once (also for all if you like), and leave the blank of the index for other monitors in the same group.

There is example: Group Name/Index/Monitor Name

%group/%index/%name

For this format, you should write index in original name at Uptimerobots Control Panel for each group once:

GroupA/1/MonitorA

And leave the blank of the index for other monitors in the same group.

GroupA//MonitorB