pingdash

0.1.5 • Public • Published

Pingdash

A simple status dashboard for all your services.

Usage

Create a config and run pingdash config.json, a beautiful realtime monitoring page will be instantly setup on http://localhost:3000.

The config file is defined as below:

config.json sample

{
  "title": "Hello Pingdash",
  "port": 3000,
  "data": [
    // send a GET request to Google every 3 seconds
    {
      "name": "Google",
      "url": "https://google.com",
      "interval": 3
    },
    // ping GitHub once every minute
    {
      "name": "GitHub",
      "method": "ping github.com -c 1",
      "interval": 60
    },
    // ...
  ]
}

For more examples, you can checkout the default.json file in this repo.

Install

You could use npm or yarn to install it globally (recommand node.js version >= 6.0):

npm i pingdash -g

Or use yarn:

yarn global add pingdash

Options

$ pingdash --help
 
  Usage: pingdash [options] <config file>
 
  Options:
 
    -h, --help         output usage information
    -V, --version      output the version number
    -p, --port <port>  server's listen port, 3000 default
    -s, --silent       don't output any logs
 

License

The MIT license.

Readme

Keywords

none

Package Sidebar

Install

npm i pingdash

Weekly Downloads

0

Version

0.1.5

License

MIT

Last publish

Collaborators

  • quietshu