zyrouge / web-status-monitor

πŸ›Έ Ping websites at regular intervals using just GitHub Actions!

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

πŸ›Έ Web Status Monitor

Ping websites at regular intervals using just GitHub Actions!

πŸ€” How does it work?

A scheduled GitHub action runs every 5 minutes that pings all the urls after which the summary is rendered. It's that simple!

πŸš€ Setting up

  • Create repo from this template
  • Add urls in config.yml
  • Done!

❔ Documentation

Configuration

config.defaults

  • Type: object
  • Required: false

config.defaults.method

  • Type: get | delete | head | options | post | put | patch
  • Required: false

config.defaults.headers

  • Type: Record<string, string>
  • Required: false

config.entities

  • Type: object[]
  • Required: true

config.entities[].url

  • Type: string
  • Required: true

config.entities[].method

  • Type: get | delete | head | options | post | put | patch
  • Required: false

config.entities[].headers

  • Type: Record<string, string>
  • Required: false

πŸ“ƒ License

License - MIT

About

πŸ›Έ Ping websites at regular intervals using just GitHub Actions!

License:MIT License


Languages

Language:TypeScript 100.0%