https://github.com/fabriziosalmi/websites-monitor
Websites monitoring via GitHub Actions (expiration, security, performances, privacy, SEO)
https://github.com/fabriziosalmi/websites-monitor
certificate-monitoring content-security-policy domain-expiration github-actions headers-checker headers-security monitoring pagespeed pagespeed-insights pagespeed-insights-api performance performance-analysis performance-metrics performance-monitoring performance-testing ssl-expiry website website-monitor website-monitoring websites
Last synced: 7 months ago
JSON representation
Websites monitoring via GitHub Actions (expiration, security, performances, privacy, SEO)
- Host: GitHub
- URL: https://github.com/fabriziosalmi/websites-monitor
- Owner: fabriziosalmi
- Created: 2023-09-03T20:50:17.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T04:03:38.000Z (over 1 year ago)
- Last Synced: 2024-04-14T01:06:29.751Z (over 1 year ago)
- Topics: certificate-monitoring, content-security-policy, domain-expiration, github-actions, headers-checker, headers-security, monitoring, pagespeed, pagespeed-insights, pagespeed-insights-api, performance, performance-analysis, performance-metrics, performance-monitoring, performance-testing, ssl-expiry, website, website-monitor, website-monitoring, websites
- Language: Python
- Homepage:
- Size: 303 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Website Monitor
[](https://github.com/fabriziosalmi/websites-monitor/actions/workflows/create-report.yml)
This repository provides a framework to monitor the health and security of your websites, automatically generating a detailed report in markdown format on a daily basis. It performs various checks, including domain status, SSL certificate validity, security headers, and performance metrics, helping you keep your online presence secure and optimized.
## Features
- **Automated Daily Checks:** Runs daily using GitHub Actions.
- **Comprehensive Analysis:** Performs a range of checks, including:
- Domain breach detection
- Domain expiration check
- SSL certificate validation
- DNS blacklist check
- HSTS header check
- XSS protection check
- Redirect chain check
- PageSpeed performance score
- Website load time
- Rate limiting check
- CDN detection
- Brotli compression check
- Deprecated libraries check
- Client-side rendering check
- Mixed content check
- Content-Type check
- Internationalization check
- FLoC check
- AMP check
- Robots.txt check
- Sitemap check
- Favicon check
- Alt tag check
- Open Graph check
- Semantic Markup check
- Ad Tracking check
- WHOIS privacy check
- Privacy exposure check
- **Clear Report:** Generates a markdown-formatted report with results in a table, easily viewable on GitHub.
- **Customizable:** Easily extendable to incorporate new checks or modify existing ones.
## How to Use
### Initial Setup
1. **Fork This Repository:** Start by forking this repository to your GitHub account.
2. **Configure Websites:**
* Edit the `config.yaml` file.
* Add the websites you want to monitor, one per line, under the `websites:` section.
```yaml
websites:
- audiolibri.org
- example.com
```
3. **Enable GitHub Actions (If Not Already Enabled):**
* Navigate to the "Actions" tab in your repository.
* If GitHub Actions are not enabled, enable them for your forked repository, and make sure you give write permissions.
4. **Set the PageSpeed API Key Secret:**
* Obtain a Google PageSpeed Insights API key if you want to use the PageSpeed test.
* Navigate to "Settings" -> "Secrets and variables" -> "Actions" in your GitHub repository.
* Add a new repository secret named `PAGESPEED_API_KEY` and paste your API key as the value.
5. **Create the `report_template.md` File:**
* Create a new file called `report_template.md` in the root of your repository if it doesn't exist.
* Add a default template to generate the report, for example:
```markdown
# Websites Monitor
```
6. **Commit All Changes:**
* Commit and push the changes to your forked repository to trigger the initial report generation.
### How the Monitoring Works
- **Daily Execution:** The `create-report.yml` GitHub Action workflow is scheduled to run daily.
- **Website Checks:** The workflow executes the `main.py` script, which performs all the checks on the websites specified in `config.yaml`.
- **Report Generation:** The `main.py` script automatically generates the report in the `README.md` file using the `report_template.md` as a base.
- **Automatic Updates:** The `README.md` file will be automatically updated with the latest check results after each successful run of the workflow.
## Configuration Options
The `config.yaml` file allows for various configurations:
- `websites`: List of URLs to monitor.
- `output_file`: The output filename of the generated report, defaults to `README.md`.
- `max_workers`: Number of concurrent tasks when performing the checks.
- `timeout`: Default timeout in seconds for the checks.
- `report_template`: The filename of the report template, defaults to `report_template.md`
- `github_workflow_badge`: The GitHub workflow badge url
- `pagespeed_api_key`: The Google PageSpeed Insights API key (set as a GitHub Secret).
## Customizing Checks
You can modify existing checks or add new ones by editing the files in the `checks` directory and then adding the check to the `WebsiteMonitor` class in `main.py`. Ensure your new check functions follow the same format, returning an emoji indicating status (🟢, 🔴, or ⚪).
## Understanding the Output
The generated report in `README.md` includes a table with a row for each website, and the results for each check in each column.
- 🟢: The check is successful.
- 🔴: The check failed.
- 🟡: The check returned a warning or requires attention.
- ⚪: An error occurred during the check, or the check was not completed.
## Support
For any issues or suggestions regarding this project, feel free to open an issue on GitHub.
---
This report was automatically generated on 2025-03-18 04:07:54 UTC.
| Website | Domain breach | Domain Expiration | SSL Certificate | DNS Blacklists | DomainsBlacklists | HSTS | XSS Protection | Redirect chains | Pagespeed | Load Time | Rate Limiting | CDN | Brotli | Deprecated Libraries | Client Rendering | Mixed Content | Content-Type | i18n | FLoC | AMP | Robots.txt | Sitemap | Favicon | Alt Tags | Open Graph | Semantic Markup | Ad Tracking | WHOIS Privacy | Privacy Exposure |
|---------|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
audiolibri.org | ⚪ | 🟢 (45 days left) | 🟢 (49 days left) | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 99 | 🟢 | 🔴 | 🟢 | 🟢 | 🟡 | 🔴 | 🔴 | 🟢 | 🟢 | 🔴 | 🔴 | ⚪ | 🔴 | 🟢 | 🔴 | 🔴 | 🔴 | 🟢 | 🟢 | 🔴 |
example.com | ⚪ | 🟢 (147 days left) | 🟢 (303 days left) | 🟢 | 🟢 | 🔴 | 🔴 | 🟢 | ⚪ | 🟢 | 🔴 | ⚪ | 🔴 | 🟢 | 🟢 | 🟢 | 🔴 | ⚪ | 🔴 | 🔴 | ⚪ | 🔴 | 🔴 | 🟢 | 🔴 | 🔴 | 🟢 | 🔴 | 🟢 |