🚀 Professional MikroTik Router Backup Management System
A powerful, web-based backup management application designed for ISP and office environments. Built with modern web technologies to provide comprehensive router backup automation, scheduling, and monitoring capabilities.
- ✨ Features
- 🚀 Quick Start
- 📖 Usage Guide
- 🎯 Supported Router Types
- 💻 Technology Stack
- 📁 Project Structure
- 🔧 Configuration
- 🚢 Deployment
- 🤝 Contributing
- 📋 Changelog
- 🐛 Troubleshooting
- 📞 Support
- 📜 License
- 📁 Multiple Router Management: Add, configure, and manage multiple MikroTik routers
- ⚡ One-Click Backup: Trigger backups instantly and download files automatically
- 🔄 Connection Testing: Test router connectivity before adding to system
- 📊 Real-time Monitoring: Live status indicators for all managed routers
- 📱 Responsive Interface: Optimized for desktop, tablet, and mobile devices
- 💾 Automated Backups: Schedule automatic backups with flexible timing
- 📋 Backup Types: Support for full system and configuration-only backups
- 🗂️ File Organization: Automatic file naming and organized storage
- 📥 Download Management: Easy access to all backup files
- 🧹 Cleanup Automation: Automatic removal of old backup files
- 💫 Modern UI/UX: Clean, professional design with intuitive navigation
- 🌓 Dark/Light Theme: Adaptive theming for comfortable viewing
- 📊 Interactive Dashboard: Real-time statistics and system overview
- 🎯 Drag & Drop: Seamless router configuration experience
- ⏳ Progress Indicators: Real-time feedback during backup operations
- 🔒 Secure Connections: SSL/TLS support for router communications
- 🛠️ Error Handling: Comprehensive error reporting and recovery
- ⚡ Performance Optimized: Efficient processing for multiple routers
- 🔐 Credential Management: Secure storage of router credentials
- 🌐 Cross-Platform: Compatible with Windows, macOS, and Linux
- Python 3.8+ 🐍
- Modern web browser 🌐
- MikroTik RouterOS 6.0+ 📡
- 100MB+ free disk space 💾
# Clone the repository
git clone https://github.com/rezaworks/mikrotik-backup-tool.git
cd mikrotik-backup-tool
# Create virtual environment
python -m venv mikrotik_backup_venv
source mikrotik_backup_venv/bin/activate # Windows: mikrotik_backup_venv\Scripts\activate
# Install dependencies
pip install -r requirements.txt
# Launch application
python backend/app.py
# Open browser and navigate to:
# http://localhost:5000# Build Docker image
docker build -t mikrotik-backup-tool .
# Run container
docker run -p 5000:5000 mikrotik-backup-tool
# Access at: http://localhost:5000# Using Gunicorn (Recommended for production)
pip install gunicorn
gunicorn -w 4 -b 0.0.0.0:5000 backend.app:app
# Access at: http://your-server:5000- 🔧 Access Router Management: Click "Add Router" from the main dashboard
- 📝 Enter Router Details: Provide name, IP address, credentials
- 🔌 Test Connection: Verify router connectivity and API access
- 💾 Save Configuration: Store router for future backup operations
- 🎯 Select Target Router: Choose from configured routers list
- ⚙️ Choose Backup Type: Select full system or configuration backup
▶️ Initiate Backup: Click "Backup Now" to start the process- 📥 Download File: Automatically download the backup file
- 📈 View Dashboard: Monitor all routers status in real-time
- 🔍 Check Logs: Review backup history and system events
- ⚙️ Manage Schedules: Configure automated backup schedules
- 🧹 Cleanup: Remove old backup files automatically
- 📂 Automatic Organization: Backups organized by router and date
- 📥 Easy Downloads: Direct download links for all backup files
- 🗂️ Format Support: Both full (.backup) and config (.rsc) formats
- 📋 Metadata Tracking: File size, creation date, and router information
| Router Type | Description | Features |
|---|---|---|
| 📡 MikroTik RouterOS | All RouterBOARD devices | Full API integration |
| 🌐 CCR Series | Cloud Core Routers | High-performance backups |
| 🏠 hAP Series | Home Access Point | Wireless configuration backup |
| 🏢 RB Series | General purpose routers | Complete system backup |
| 🔒 RB1100AHx4 | Enterprise routers | Advanced configuration management |
- 🌐 API Connection: Direct RouterOS API communication
- 🔒 SSL/TLS Support: Secure encrypted connections
- 🔐 Authentication: Username/password and key-based auth
- 📊 Status Monitoring: Real-time connection health checks
- 🔗 Flask: Web framework for Python backend
- 🗄️ Flask-SQLAlchemy: Database ORM for router management
- 🔌 librouteros: MikroTik RouterOS API communication
- 🔒 paramiko: SSH/SFTP for secure file transfers
- ⏰ schedule: Background job scheduling
- 🌐 flask-cors: Cross-origin resource sharing
mikrotik-backup-tool/
├── 📄 backend/ # 🔧 Backend Python application
│ ├── app.py # 🚀 Main Flask application
│ ├── models.py # 💾 Database models and schemas
│ ├── utils/ # 🔧 Utility modules
│ │ ├── mikrotik.py # 📡 MikroTik communication utilities
│ │ └── scheduler.py # ⏰ Backup scheduling logic
│ └── config.db # 💾 SQLite database (auto-created)
├── 📄 public/ # 🌐 Frontend assets
│ ├── index.html # 🏠 Main web interface
│ ├── style.css # 🎨 Application styling
│ ├── script.js # ⚡ Frontend functionality
│ └── assets/ # 🖼️ Static assets
│ ├── logo.svg # 🏷️ Application logo
│ └── icons/ # 🔲 UI icons
├── 📄 backups/ # 💾 Backup storage directory
├── 📄 requirements.txt # 📦 Python dependencies
├── 📄 README.md # 📚 Project documentation
├── 📄 LICENSE # 📜 MIT license file
├── 📄 .gitignore # 🚫 Git ignore patterns
├── 📄 setup.py # 📦 Package configuration
└── 📄 venv/ # 🐍 Python virtual environment
# Default Configuration (backend/app.py)
PORT = 5000
BACKUP_DIR = 'backups/'
DATABASE_URL = 'sqlite:///backend/config.db'
SECRET_KEY = 'your-secret-key-here' # Change in productionEach router requires the following information:
- Name: Friendly identifier (e.g., "Office-Firewall")
- Host: IP address or hostname (e.g., "192.168.1.1")
- Username: RouterOS login username (default: "admin")
- Password: RouterOS login password
- Port: API port (default: 8728)
- SSL: Enable/disable SSL encryption
export FLASK_ENV=production
export SECRET_KEY=your-production-secret
export BACKUP_DIR=/path/to/backups
export DATABASE_URL=sqlite:///path/to/database.db# Using Flask development server
python backend/app.py
# Access at: http://localhost:5000# Install Gunicorn
pip install gunicorn
# Run with multiple workers
gunicorn -w 4 -b 0.0.0.0:5000 backend.app:app
# Access at: http://your-server:5000FROM python:3.9-slim
WORKDIR /app
COPY requirements.txt .
RUN pip install -r requirements.txt
COPY . .
EXPOSE 5000
CMD ["python", "backend/app.py"]# Build and run
docker build -t mikrotik-backup-tool .
docker run -p 5000:5000 mikrotik-backup-toolserver {
listen 80;
server_name your-domain.com;
location / {
proxy_pass http://127.0.0.1:5000;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
}
}We welcome contributions from the community! 🌟
- 🍴 Fork the repository
- 🌿 Create a feature branch:
git checkout -b feature/amazing-feature - 💻 Make your changes
- ✅ Test thoroughly
- 📤 Submit a pull request
- 📝 Follow PEP 8 style guidelines for Python code
- 🧪 Write comprehensive tests for new features
- 📚 Update documentation for API changes
- 📱 Ensure responsive design for UI modifications
- 🔄 Maintain backward compatibility when possible
- 🔧 New Router Support: Additional RouterOS versions or device types
- 📊 Enhanced Analytics: New monitoring and reporting features
- ⚡ Performance Improvements: Backup speed and efficiency
- 💫 UI/UX Enhancements: Accessibility, mobile optimization
- 🧪 Testing: Unit tests, integration tests, performance benchmarks
- ✨ Initial release with core backup functionality
- 🌐 Complete MikroTik RouterOS API integration
- 📱 Modern responsive web interface
- 📦 Support for full system and configuration backups
- 🔄 Real-time status monitoring and alerts
- ⏰ Advanced scheduling with cron expressions
- 📧 Email notifications for backup completion/failure
- 📊 Advanced reporting and analytics dashboard
- 🔌 REST API for third-party integrations
- ☁️ Cloud storage integration (AWS S3, Google Cloud)
| Problem | Solution |
|---|---|
| Router connection failed | Verify IP address, credentials, and API access |
| Backup process hangs | Check router resources and network connectivity |
| File download fails | Verify disk space and file permissions |
| Web interface not loading | Confirm Flask is running on correct port |
- 📖 Check this README thoroughly
- 🔍 Search existing GitHub issues
- 💬 Create a new issue with detailed information
- 📧 Contact: work.rezaul@outlook.com
- 📧 Email: work.rezaul@outlook.com
- 🐛 Issues: Create a GitHub issue
- 💭 Discussions: GitHub Discussions
- ⭐ Star this project if you find it helpful
- 🐛 Report bugs to help improve the tool
- 💡 Suggest features for future releases
- 📖 Share with others who might benefit
This project is licensed under the MIT License - see the LICENSE file for details.
MIT License
Copyright (c) 2023 REZ LAB
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Rezaul Karim
🏢 REZ LAB
Built with ❤️ for MikroTik administrators and ISP professionals
⭐ If you find this project helpful, please give it a star!
