Skip to content

Commit b9123bb

Browse files
author
JD Bungart
committed
docs: update tmpfs configuration examples in README.md
1 parent 8fdc364 commit b9123bb

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ A powerful and flexible backup solution for MikroTik RouterOS devices. This tool
5454
- Python 3.13.1 or higher
5555
- RouterOS devices with SSH access enabled
5656
- SSH key pair for authentication
57+
- RouterOS v7.7 or later for tmpfs support (will fallback to direct storage for older versions)
5758

5859
## Installation
5960

@@ -113,9 +114,14 @@ ssh:
113114
#keepalive_countmax: 3 # Max failed keepalives (optional, default: 3)
114115

115116
# Temporary Storage Settings
116-
use_tmpfs: true # Use tmpfs for temporary storage (default: true)
117-
tmpfs_fallback: true # Fall back to EEPROM if tmpfs fails (default: true)
118-
tmpfs_size: 50M # Size of tmpfs in MB (optional, auto-calculated if not set)
117+
tmpfs:
118+
enabled: true # Use tmpfs for temporary storage (default: true)
119+
fallback_enabled: true # Fall back to root storage if tmpfs fails (default: true)
120+
size_auto: true # Calculate size based on available memory (default: true)
121+
size_mb: 50 # Fixed size in MB when size_auto is false (default: 50)
122+
min_size_mb: 1 # Minimum size in MB for auto calculation (default: 1)
123+
max_size_mb: 50 # Maximum size in MB for auto calculation (default: 50)
124+
mount_point: "rosbackup" # Mount point name for tmpfs (default: "rosbackup")
119125
```
120126
121127
### Target Configuration (targets.yaml)
@@ -153,9 +159,10 @@ targets:
153159
enable_plaintext_backup: true
154160
keep_binary_backup: true # Keep binary backup on router
155161
keep_plaintext_backup: true # Keep plaintext backup on router
156-
use_tmpfs: true
157-
tmpfs_fallback: true
158-
tmpfs_size: 25M # Override global tmpfs size
162+
tmpfs:
163+
enabled: true # Override global tmpfs enable/disable (optional)
164+
fallback_enabled: true # Override global fallback behavior (optional)
165+
size_mb: 25 # Override global fixed size in MB (optional)
159166
```
160167
161168
#### Multiple Targets with Different Requirements

0 commit comments

Comments
 (0)