HHFWebsiteMonitor/README.md
hhftechnologies 77c0fdd0a4 update
2024-11-19 23:12:31 +05:30

68 lines
No EOL
1.5 KiB
Markdown

# Website Monitor
A simple web service for monitoring website availability.
![Image Home Page](image.png)
## Features
- Monitor multiple websites simultaneously
- Customizable status updates and incident messages
- Easy configuration via JSON
- Automated monitoring with cron jobs
- Markdown support for messages
## Prerequisites
- PHP with write permissions
- Cron (optional, for automated monitoring)
- [Parsedown](https://parsedown.org) library (included)
## Setup
### 1. Installation
1. Upload all files to your cloudpanel.
2. Ensure PHP has write permissions for the `monitors` directory
![alt text](image-2.png)
### 2. Configure Monitored Websites
Edit `monitors.json` to add websites you want to monitor:
```json
{
"forum.hhf.technology": "https://forum.hhf.technology",
"git.hhf.technology": "https://git.hhf.technology"
}
```
### 3. Optional Customizations
#### Status Updates
- Create Markdown files in the `updates` directory
- Filename should match the website name (e.g., `example.com.md`)
#### Incident Messages
Place Markdown files in the `incidents` directory:
- Default: Informational message (gray)
- `alert_*` prefix: Alert message (red)
- `notice_*` prefix: Notice message (yellow)
### 4. Automate Monitoring
Add this to your crontab to run monitoring every minute:
![alt text](image-1.png)
```bash
* * * * * /usr/bin/php -f /path/to/monitor.php >/dev/null 2>&1
```
## Dependencies
- [Parsedown](https://parsedown.org): Markdown rendering library
## Notes
- Ensure proper file permissions for monitoring functionality