# ๐ Domain Monitor
> A powerful, self-hosted domain expiration monitoring system with multi-channel notifications
[](https://www.php.net/)
[](LICENSE)
[](CONTRIBUTING.md)
A modern PHP MVC application for monitoring domain expiration dates and sending notifications through multiple channels (Email, Telegram, Discord, Slack). Never lose a domain again with automated monitoring and timely alerts.
## โจ Features
### Core Features
- ๐ **Domain Management** - Add, edit, and monitor unlimited domains
- ๐ **Smart WHOIS/RDAP Lookup** - Automatically fetches expiration dates and registrar information
- ๐๏ธ **TLD Registry System** - Built-in support for 1,400+ TLDs with IANA integration
- ๐ **Multi-Channel Notifications** - Email, Telegram, Discord, and Slack support
- ๐ฅ **Notification Groups** - Organize channels and assign domains flexibly
- โก **Real-time Dashboard** - Overview of all domains and their status
- ๐ **Notification Logs** - Complete history of all sent notifications
- ๐ค **Automated Monitoring** - Cron-based checks with configurable intervals
- ๐จ **Modern UI** - Clean, responsive design with intuitive interface
### Advanced Features
- ๐ **Secure by Default** - Random passwords, session management, prepared statements
- ๐ **Bulk Operations** - Import, refresh, and manage multiple domains at once
- ๐ฏ **Flexible Alerts** - Customizable notification thresholds (60, 30, 21, 14, 7, 5, 3, 2, 1 days)
- ๐ **Auto WHOIS Refresh** - Keep domain data up-to-date automatically
- ๐ฑ **Monitoring Controls** - Enable/disable notifications per domain with alerts
- ๐ **RDAP Support** - Modern protocol for faster, structured domain data
## ๐ Requirements
- PHP 8.1 or higher
- MySQL 5.7+ or MariaDB 10.3+
- Composer
- Apache/Nginx with mod_rewrite enabled
- Cron support for automated checks
- SMTP server for email notifications (optional)
## ๐ Security
The application includes built-in authentication with secure practices:
- ๐ **Random Password Generation** - Unique secure password created on installation
- ๐ก๏ธ **Session Management** - Secure session handling with httpOnly cookies
- ๐ **SQL Injection Protection** - All queries use prepared statements
- ๐ **One-time Credentials** - Admin password shown only once during setup
โ ๏ธ **Important:** Save your admin password during installation - it won't be shown again!
## ๐ Quick Start
### 1. Clone the Repository
```bash
git clone https://github.com/Hosteroid/domain-monitor.git
cd domain-monitor
```
### 2. Install Dependencies
```bash
composer install
```
### 3. Configure Environment
Copy the example environment file:
```bash
# Linux/Mac
cp env.example.txt .env
# Windows
copy env.example.txt .env
```
Edit `.env` and configure your settings:
```ini
# Database
DB_HOST=localhost
DB_PORT=3306
DB_DATABASE=domain_monitor
DB_USERNAME=root
DB_PASSWORD=your_password
```
**Note:**
- The encryption key (APP_ENCRYPTION_KEY) will be automatically generated during migration
- Application name, URL, timezone, email settings, and monitoring schedules are configured through the web interface in **Settings** (not .env)
### 4. Create Database
Create a MySQL database:
```sql
CREATE DATABASE domain_monitor CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
```
### 5. Run Migrations
```bash
php database/migrate.php
```
**โ ๏ธ IMPORTANT:** The migration will:
1. **Generate an encryption key** (if not already set) and save it to `.env`
2. **Generate a random admin password** and display it **only once**
Example output:
```
๐ Generating encryption key...
โ Encryption key generated and saved to .env
Key: base64_encoded_key_here
โ ๏ธ Keep this key secret and backup securely!
...
๐ Admin credentials (SAVE THESE!):
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Username: admin
Password: 3f8a2b9c4d5e6f7a
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ ๏ธ This password will not be shown again!
๐พ Save it to a secure password manager.
```
**Save these immediately:**
- The encryption key is needed to decrypt sensitive data (backup securely!)
- The admin password is needed to access the dashboard
### 6. Import TLD Registry Data (Optional but Recommended)
For enhanced WHOIS lookups with automatic server discovery:
```bash
php cron/import_tld_registry.php
```
This imports RDAP and WHOIS server data for 1,400+ TLDs from IANA.
### 7. Configure Web Server
#### Apache
Make sure `.htaccess` is enabled. Your virtual host should point to the `public` directory.
Example configuration:
```apache
ServerName domainmonitor.local
DocumentRoot "/path/to/domain-monitor/public"
AllowOverride All
Require all granted
```
#### PHP Built-in Server (Development)
```bash
php -S localhost:8000 -t public
```
Then visit: `http://localhost:8000`
## ๐ง Configuration
### Application & Email Settings
All application and email settings are now managed through the **Settings** page in the web interface:
1. Navigate to **Settings** โ **Application** tab
- Set application name, URL, and timezone
2. Navigate to **Settings** โ **Email** tab
- Configure SMTP server (host, port, encryption)
- Set authentication credentials
- Configure from address and name
**Example Email Settings:**
- SMTP Host: `smtp.gmail.com`
- SMTP Port: `587`
- Encryption: `TLS`
- Username: `your-email@gmail.com`
- Password: `your-app-password`
### Notification Channels
#### โ๏ธ Telegram
1. Create a bot using [@BotFather](https://t.me/BotFather)
2. Get your Chat ID using [@userinfobot](https://t.me/userinfobot)
3. Add the channel in the notification group settings
#### ๐ฌ Discord
1. Go to Server Settings โ Integrations โ Webhooks
2. Create a new webhook
3. Copy the webhook URL
4. Add it in the notification group settings
#### ๐ผ Slack
1. Go to Slack App Settings
2. Enable Incoming Webhooks
3. Create a new webhook
4. Copy the webhook URL
5. Add it in the notification group settings
## ๐
Setting Up Cron Jobs
The application requires a cron job to check domains periodically.
### Linux/Mac
```bash
crontab -e
```
Add this line to run daily at 9 AM:
```cron
0 9 * * * /usr/bin/php /path/to/project/cron/check_domains.php
```
### Windows
Use Task Scheduler:
1. Open Task Scheduler
2. Create Basic Task
3. Set trigger (e.g., Daily at 9:00 AM)
4. Action: Start a program
5. Program: `C:\php\php.exe`
6. Arguments: `C:\path\to\domain-monitor\cron\check_domains.php`
## ๐งช Testing Notifications
Before setting up the cron job, test your notification channels:
```bash
php cron/test_notification.php
```
Follow the prompts to test Email, Telegram, Discord, or Slack.
## ๐ Usage Guide
### Adding Domains
1. Navigate to **Domains** โ **Add Domain**
2. Enter the domain name (e.g., `example.com`)
3. Optionally assign to a notification group
4. Click **Add Domain**
The system will automatically fetch WHOIS information.
### Creating Notification Groups
1. Navigate to **Notification Groups** โ **Create Group**
2. Enter a name and description
3. Click **Create Group**
4. Add notification channels (Email, Telegram, Discord, Slack)
5. Assign domains to the group
### Monitoring
The **Dashboard** shows:
- Total domains and their status
- Domains expiring soon
- Recent notifications sent
### Notification Schedule
By default, notifications are sent at these intervals before expiration:
- 60 days (2 months)
- 30 days (1 month)
- 21 days (3 weeks)
- 14 days (2 weeks)
- 7 days (1 week)
- 5 days
- 3 days
- 2 days
- 1 day (tomorrow!)
- When expired (immediate alert)
### Configure Settings
All system settings are managed through the **Settings** page (`/settings`) in your browser:
#### Application Settings
- **Application Name**: Customize the display name
- **Application URL**: Base URL for links in emails
- **Timezone**: Set your preferred timezone
#### Email Settings
- **SMTP Configuration**: Host, port, encryption
- **Authentication**: Username and password
- **From Address**: Email sender details
#### Monitoring Settings
- **Notification Schedule**: Choose from presets or create custom
- **Minimal**: 30, 7, 1 days
- **Standard**: 60, 30, 21, 14, 7, 5, 3, 2, 1 days
- **Frequent**: 90, 60, 45, 30, 21, 14, 10, 7, 5, 3, 2, 1 days
- **Business Focused**: 60, 30, 14, 7, 3, 1 days
- **Custom**: Enter your own comma-separated days
- **Check Interval**: How often to check domains
- Every 6 hours
- Every 12 hours
- Daily (24 hours)
- Every 2 days
- Weekly
All settings are stored in the database and can be updated at any time through the web interface.
## ๐ Project Structure
```
Domain Monitor/
โโโ app/
โ โโโ Controllers/ # Application controllers
โ โโโ Models/ # Database models
โ โโโ Services/ # Business logic & services
โ โ โโโ Channels/ # Notification channel implementations
โ โโโ Views/ # HTML views
โโโ core/ # Core MVC framework
โโโ cron/ # Cron job scripts
โโโ database/
โ โโโ migrations/ # Database migrations
โโโ public/ # Web root (index.php, assets)
โโโ routes/ # Route definitions
โโโ vendor/ # Composer dependencies
โโโ .env # Environment configuration
```
## ๐ Security Considerations
1. **Never commit `.env`** - Contains sensitive credentials
2. **Secure your web server** - Point only the `public` directory to the web
3. **Use strong database passwords**
4. **Enable HTTPS** in production
5. **Protect cron endpoints** - Ensure cron scripts aren't web-accessible
6. **Regular updates** - Keep dependencies updated
## ๐ Troubleshooting
### WHOIS Lookup Fails
- Some domain TLDs may not be supported
- Check if the domain is valid and registered
- Verify your server can make outbound connections
### Notifications Not Sending
1. Check logs: `logs/cron.log`
2. Verify notification channel configuration
3. Test using: `php cron/test_notification.php`
4. Check SMTP/API credentials
### Database Connection Error
- Verify database credentials in `.env`
- Ensure MySQL service is running
- Check if database exists
### Cron Job Not Running
- Verify cron syntax and paths
- Check server logs
- Test manually: `php cron/check_domains.php`
## ๐ Bug Reports & Feature Requests
We welcome bug reports and feature requests! Please use GitHub Issues:
### ๐ Report a Bug
Found a bug? [Open an issue](https://github.com/Hosteroid/domain-monitor/issues/new?template=bug_report.md) with:
- Clear description of the issue
- Steps to reproduce
- Expected vs actual behavior
- Environment details (PHP version, OS, etc.)
### ๐ก Request a Feature
Have an idea? [Submit a feature request](https://github.com/Hosteroid/domain-monitor/issues/new?template=feature_request.md) with:
- Clear description of the feature
- Use case and benefits
- Any implementation ideas
## ๐ค Contributing
Contributions are welcome and appreciated! Here's how you can help:
### How to Contribute
1. **Fork the repository**
2. **Create a feature branch** (`git checkout -b feature/AmazingFeature`)
3. **Make your changes**
4. **Test thoroughly**
5. **Commit your changes** (`git commit -m 'Add some AmazingFeature'`)
6. **Push to the branch** (`git push origin feature/AmazingFeature`)
7. **Open a Pull Request**
### Development Guidelines
- Follow PSR-12 coding standards
- Write clear commit messages
- Add comments for complex logic
- Test your changes before submitting
- Update documentation as needed
### Areas for Contribution
- ๐ Bug fixes
- โจ New features
- ๐ Documentation improvements
- ๐ Translations
- ๐จ UI/UX enhancements
- โก Performance optimizations
## ๐ License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
**TL;DR:** Free to use for personal and commercial projects. Attribution appreciated but not required.
## ๐ง Support & Community
- ๐ฌ **Discussions:** [GitHub Discussions](https://github.com/Hosteroid/domain-monitor/discussions)
- ๐ **Issues:** [Bug Tracker](https://github.com/Hosteroid/domain-monitor/issues)
- ๐ **Documentation:** [Wiki](https://github.com/Hosteroid/domain-monitor/wiki)
- โญ **Star the project** if you find it useful!
## ๐ผ Created & Sponsored By
### [Hosteroid - Premium Hosting Solutions](https://www.hosteroid.uk)
This project is proudly created and maintained by **Hosteroid**, a leading provider of premium hosting solutions.
[](https://www.hosteroid.uk)
**Services:** Web Hosting โข VPS โข Dedicated Servers โข Domain Registration
๐ **Website:** [hosteroid.uk](https://www.hosteroid.uk)
๐ง **Contact:** [support@hosteroid.uk](mailto:support@hosteroid.uk)
---
## ๐ Acknowledgments
- Created by [Hosteroid](https://www.hosteroid.uk)
- WHOIS/RDAP data from [IANA](https://www.iana.org/)
- Built with modern PHP and love โค๏ธ
## ๐ Project Stats
---
**Made with โค๏ธ by [Hosteroid](https://www.hosteroid.uk)**
[Report Bug](https://github.com/Hosteroid/domain-monitor/issues) โข [Request Feature](https://github.com/Hosteroid/domain-monitor/issues) โข [Visit Hosteroid](https://www.hosteroid.uk)