CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.0] - 2024-04-03

Added

• Initial release of System Monitor Python Engine
• Real-time system dashboard with IP geolocation
• Memory and disk usage monitoring
• System uptime display
• Configurable refresh intervals via environment variables
• Offline mode to disable geolocation lookups
• Debug logging support
• Professional installation script with dependency checks
• Comprehensive privacy policy and security documentation
• Type hints and docstrings throughout codebase
• Proper error handling and logging
• CONTRIBUTING.md with contribution guidelines
• PRIVACY.md with data collection details

Changed

• Migrated from inline Python (bash heredoc) to separate module architecture
• Improved code safety with shlex.split() instead of shell=True
• Enhanced error handling with specific exception types
• Better validation of external API responses
• Rewrote install.sh with better UX and error messages

Fixed

• Security vulnerability in subprocess execution
• Generic exception handling that silenced real errors
• Conflicting documentation (mixed Portuguese/English)
• Missing dependency checks during installation

Security

• Fixed subprocess shell injection vulnerability
• Added JSON schema validation for API responses
• Implemented proper timeout handling
• Safe path construction using environment variables

Removed

• OneDrive Bunker specific functionality
• MAC address spoofing features
• Cloudflare WARP detection
• System-specific Portuguese documentation
• Fedora Silverblue-only requirements

---

Unreleased

Planned Features

• macOS support
• Windows (WSL) support
• Unit tests and integration tests
• GitHub Actions CI/CD workflow
• Top processes monitoring
• Network speed test integration
• Custom dashboard themes
• Configuration file support (~/.monitor/config)
• Database mode (store historical data)
• Web dashboard alternative UI

---

Guidelines for Contributors

When adding changes, please:

1. Update this CHANGELOG.md in the "Unreleased" section
2. Use the format: - [category] description
3. Categories: Added, Changed, Deprecated, Removed, Fixed, Security

Examples:

### Added
- New feature for monitoring network traffic

### Fixed
- Bug where monitor crashes on small terminals

### Security
- Fixed subprocess injection vulnerability