🌏 Live Demo | 📖 简体中文

Introduction

PongHub is an open-source service status monitoring website designed to help users track and verify service availability. It supports:

• 🕵️ Zero-intrusion Monitoring - Full-featured monitoring without code changes
• 🚀 One-click Deployment - Automatically built with GitHub Actions, deployed to GitHub Pages
• 🌐 Cross-platform Support - Compatible with public services like OpenAI and private deployments
• 🔍 Multi-port Detection - Monitor multiple ports for a single service
• 🤖 Intelligent Response Validation - Precise matching of status codes and regex validation of response bodies
• 🛠️ Custom Request Engine - Flexible configuration of request headers/bodies, timeouts, and retry strategies
• 🔒 SSL Certificate Monitoring - Automatic detection of SSL certificate expiration and notifications
• 📊 Real-time Status Display - Intuitive service response time and status records
• ⚠️ Exception Alert Notifications - Exception alert notifications using GitHub Actions

Quick Start

1. Star and Fork PongHub

2. Modify the config.yaml file in the root directory to configure your service checks.

3. Modify the CNAME file in the root directory to set your custom domain name.

   If you do not need a custom domain, you can delete the CNAME file.

4. Commit and push your changes to your repository. GitHub Actions will automatically run and deploy to GitHub Pages and require no intervention.

Tip

By default, GitHub Actions runs every 30 minutes. If you need to change the frequency, modify the cron expression in the .github/workflows/deploy.yml file.

Please do not set the frequency too high to avoid triggering GitHub's rate limits.

Important

If GitHub Actions does not trigger automatically, you can manually trigger it once.

Please ensure that GitHub Pages is enabled and that you have granted notification permissions for GitHub Actions.

Configuration Guide

The config.yaml file follows this format:

Field	Type	Description	Required	Notes
timeout	Integer	Timeout for each request in seconds	✖️	Units are seconds, default is 5 seconds
max_retry_times	Integer	Number of retries on request failure	✖️	Default is 2 retries
max_log_days	Integer	Number of days to retain logs	✖️	Default is 3 days
cert_notify_days	Integer	Days before SSL certificate expiration to notify	✖️	Default is 7 days
services	Array	List of services to monitor	✔️
services.name	String	Name of the service	✔️
services.endpoints	Array	List of endpoints to check for the service	✔️
services.endpoints.url	String	URL to request	✔️
services.endpoints.method	String	HTTP method for the request	✖️	Supports GET/POST/PUT, default is GET
services.endpoints.headers	Object	Request headers	✖️	Key-value
services.endpoints.body	String	Request body content	✖️	Used only for POST/PUT requests
services.endpoints.status_code	Integer	Expected HTTP status code in response (default is 200)	✖️	Default is 200
services.endpoints.response_regex	String	Regex to match the response body content	✖️

Here is an example configuration file:

timeout: 5
max_retry_times: 2
max_log_days: 3
cert_notify_days: 7
services:
  - name: "GitHub API"
    endpoints:
      - url: "https://api.github.com"
      - url: "https://api.github.com/repos/wcy-dt/ponghub"
        method: "GET"
        headers:
          Content-Type: application/json
          Authorization: Bearer your_token
        status_code: 200
        response_regex: "full_name"
  - name: "Example Website"
    endpoints:
      - url: "https://example.com/health"
        response_regex: "status"
      - url: "https://example.com/status"
        method: "POST"
        body: '{"key": "value"}'

Development

This project uses Makefile for local development and testing. You can run the project locally with the following command:

make run

Disclaimer

PongHub is intended for personal learning and research only. The developers are not responsible for its usage or outcomes. Do not use it for commercial purposes or illegal activities.