theritikchoure / websentry

Websentry is a powerful GitHub Action that simplifies website health monitoring. With Websentry, you can effortlessly check the availability of your websites and receive real-time reports on their status.

Websentry

Check the health of your websites and receive instant status reports with Websentry!

---

Table of Contents

• About Websentry
• Key Features
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Configuration
• Inputs
• Contributing
• License

---

About Websentry

Websentry is a powerful GitHub Action that simplifies website health monitoring. With Websentry, you can effortlessly check the availability of your websites and receive real-time reports on their status. Whether you're a website owner, developer, or operations team, Websentry provides a reliable solution for ensuring your online presence remains uninterrupted.

---

Key Features

• Website Health Monitoring: Easily check the health of your websites.
• Configurable Retries: Define the number of retries and time intervals for health checks.
• Timeout Control: Set the timeout for HTTP requests.
• GitHub Action: Seamlessly integrate Websentry into your GitHub Actions workflows.
• User-Friendly: Websentry is designed to be user-friendly and easily customizable.

---

Getting Started

Prerequisites

• A GitHub repository where you want to monitor website health.
• Basic knowledge of GitHub Actions.

Installation

To start using Websentry, add it as a step in your GitHub Actions workflow. For example, in your .github/workflows/health_check.yml file:

name: Website Health Check

on:
  schedule:
    - cron: '0 * * * *'  # Run every hour

jobs:
  website-health-check:
    runs-on: ubuntu-latest
    name: License Check
    steps:
      - uses: actions/checkout@v2
      - uses: theritikchoure/websentry@main
        with:
          website-url: 'google.com,youtube.com'  # Set the website URL you want to check
          max-retries: '10'
          retry-interval: '5s'
          request-timeout: '10s'

Usage

Websentry is designed to be simple and straightforward to use. Once integrated into your workflow, it will continuously monitor the health of your specified website and provide instant status reports.

Configuration

You can configure Websentry by specifying the following input parameters in your GitHub Actions workflow:

• website-url: The URL of the website you want to monitor.
• max-retries: The maximum number of retries for checking the website's health.
• retry-interval: The time interval between retry attempts.
• request-timeout: The timeout for HTTP requests.

Inputs

Parameter	Description	Required	Default
website-url	The URL of the website to check (e.g., example.com)	true	-
max-retries	Maximum number of retries (default: 3)	false	'3'
retry-interval	Time to wait between retries in seconds (default: 5)	false	'5s'
request-timeout	Request timeout in seconds (default: 10)	false	'10s'

Contributing

We welcome contributions from the community! If you'd like to contribute to Websentry, please follow our Contribution Guidelines.

License

Distributed under the MIT License. See LICENSE for more information.