chore: merge tmpfs-support into main

Author: JD Bungart

.gitignore

@@ -29,8 +29,12 @@ __pycache__/
 # IDE specific files
 .vscode/
 .idea/
-*.swp
-*.swo
 
 # Environment files
 .env
+
+# Windsurf IDE files
+.windsurfrules
+.windsurf/
+*.swp
+*.swo

CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [0.5.0] - 2025-01-30
+
+### Added
+- Implemented tmpfs support for RouterOS backups:
+  * Added automatic tmpfs mounting and cleanup
+  * Improved backup performance by using memory-based temporary storage
+  * Added fallback to direct flash storage when tmpfs is unavailable
+- Added tasks directory for future task-based operations
+
+### Changed
+- Improved repository structure and organization:
+  * Cleaned up repository layout
+  * Updated gitignore rules
+  * Better separation of concerns in codebase
+
+### Documentation
+- Updated README.md with compose-style output demo
+- Fixed typography in documentation
+- Added ZeroTier identity export documentation
+
 ## [0.4.1] - 2025-01-08
 
 ### Added

README.md

@@ -20,6 +20,7 @@ A powerful and flexible backup solution for MikroTik RouterOS devices. This tool
   - Compose-style visualization
   - Detailed logging
   - Tmpfs-based backup storage to reduce flash wear
+  - 60-second command timeout to prevent hanging operations
 
 - **Security Features**
   - SSH key-based authentication

ROADMAP.md

@@ -4,7 +4,9 @@ This document outlines the planned features and improvements for future releases
 
 ## Planned Features
 
-### 1. Additional Notification Channels
+### 1. Notification System
+- [x] E-Mail (SMTP) support (initial release)
+- [ ] Channel Specific Alerting templates
 - [ ] Generic webhook support
 - [ ] Telegram integration
 - [ ] NTFY.sh for push notifications)
@@ -17,30 +19,33 @@ This document outlines the planned features and improvements for future releases
 - [ ] ... insert more notification channels ...
 
 ### 2. Backup Enhancements
-- [ ] Use a temporary ramdisk to store binary backup
-      - Instead of saving to primary storage of target
+- [x] Use a temporary file system (tmpfs) to store binary backup (0.5.0)
+      - Instead of saving to primary storage of target (flash for most appliances)
+- [ ] Integrate GIT support for plaintext backups
 - [ ] Support for certificate store backup
 - [ ] Automatic certificate renewal tracking
 
 ### 4. Monitoring and Reporting
+- [ ] Prometheus endpoint
 - [ ] Detailed backup statistics
 - [ ] Performance metrics collection
 - [ ] Status dashboard
-- [ ] Custom report generation
+- [ ] Custom report generation (PDF/E-Mail)
 - [ ] Backup success rate tracking
 
 ### 5. Integration Features
-- [ ] Make this a PyPI package
+- [ ] PyPI package
 - [ ] Docker Image
 - [ ] REST API for remote management
 - [ ] Integration with monitoring systems
-- [ ] Backup scheduling service
+- [ ] Backup scheduling service (async)
 
 ### 6. User Experience
 - [ ] Web-based management interface
 
-### 7. Recovery Features
+### 7. Misc Features
 - [ ] Remote restore capabilities
+- [ ] Basic Remote command execution functionality
 - [ ] Recovery testing tools
 
 Missing a feature? Open an issue or send a PR :)

VERSION.md

@@ -1,7 +1,7 @@
 # Version Information
 
 ## Current Version
-0.4.1
+0.5.0
 
 ## Versioning Format
 rosbackup-ng follows [Semantic Versioning 2.0.0](https://semver.org/):
@@ -17,12 +17,12 @@ MAJOR.MINOR.PATCH
    - Currently 0 as we're in initial development
    - Will become 1.0.0 when we have a stable public API
 
-2. **MINOR** version (4)
+2. **MINOR** version (5)
    - Incremented for added functionality in a backward compatible manner
    - New features that don't break existing functionality
    - Changes to optional parameters or configuration format
 
-3. **PATCH** version (1)
+3. **PATCH** version (0)
    - Incremented for backward compatible bug fixes
    - Performance improvements
    - Documentation updates

config/global.yaml.sample

@@ -37,6 +37,16 @@ ssh:
 #parallel_execution: true     # Enable parallel backups (optional, default: true)
 #max_parallel_backups: 5      # Maximum concurrent backups (optional, default: 5)
 
+# Temporary Storage Settings
+tmpfs:
+  enabled: true              # Use tmpfs for temporary storage (default: true)
+  fallback_enabled: true     # Fall back to root storage if tmpfs fails (default: true)
+  size_auto: true           # Calculate size based on available memory (default: true)
+  size_mb: 50               # Fixed size in MB when size_auto is false (default: 50)
+  min_size_mb: 1            # Minimum size in MB for auto calculation (default: 1)
+  max_size_mb: 50           # Maximum size in MB for auto calculation (default: 50)
+  mount_point: "rosbackup"  # Mount point name for tmpfs (default: "rosbackup")
+
 # Logging Settings
 #log_file_enabled: false      # Enable logging to file (optional, default: false)
 #log_file: ./rosbackup.log    # Log file path (optional if log_file_enabled is false)

config/targets.yaml.sample

@@ -24,3 +24,9 @@ targets:
     #enable_plaintext_backup: true      # Enable plaintext backup (optional, default: true)
     #keep_binary_backup: false          # Keep binary backup (optional, default: false)
     #keep_plaintext_backup: false       # Keep plaintext backup (optional, default: false)
+
+    # Temporary Storage Settings
+    tmpfs:
+      enabled: true          # Override global tmpfs enable/disable (optional)
+      fallback_enabled: true # Override global fallback behavior (optional)
+      size_mb: 25           # Override global fixed size in MB (optional)