2018-12-20: Version 0.5 released.
As with any copy/sync tool, make sure to test thoroughly with data that can be lost.
Test with the
--dry-rsync options to verify that the operations match what you want to do.
rmirr provides a safe and easy to use way to set up and execute file storage mirroring instructions. And because it uses
rsync to actually perform the synchronization, you get all the performance and availability benefits of
- specify only the source file object (file, directory) to mirror
- mirror settings selected by best match path
- support one or more mirror destinations
- ensure mirroring from specific sources only
- ensure single instance of mirroring operation per mirror path
- log history of mirroring invocations
- save to file report of mirrored objects
- email report file
Why not just use
Simple cases of mirroring files/directories can easily be done by using
rsync directly. But, it does not provide any safeguards. For example, the following are not the same:
Assuming a directory is being synced, call #2 is correct, as it uses a trailing
/ on the source path.
rmirr ensures that will be done properly.
Configuration file is located at
List of email recipients when
|Set SMTP server. Default is to use "localhost".|
|List of paths to be mirrored.|
|Description of what is being mirrored.|
|List of destinations to which the source is to be mirrored each of the format |
|List of email recipients when |
|List of file/dir names to exclude from the mirroring.|
|Mirror configuration name.|
|Source of the mirror: |
Given the configuration at
List suite and mirror settings:
- mirrors to both
- by default, mirroring does not delete at the destination
- by default, mirroring requires user interaction ("y" to proceed)
rmirr would do without executing it (dry-run):
/data/main, the settings for
/data/finance and allow deletion at the destination:
Do a dry run (at
rsync level) to mirror
/data/finance with deletion and no user interaction:
/data/main to specific destination (
Request report be emailed:
Request report be output to console:
Mirror the "all" suite:
Mirroring Selected File Objects
Sometimes only a subset of file objects (files, directories) need to be mirrored rather than a full tree.
rmirr supports this with the
names setting in the configuration file.
Configuration for mirroring bash files:
suitessection defines a suite to reference those bash-specific file objects by a single name
- of course, any changes/tweaks done at the destinations will be overwritten when
To mirror all the file objects of the "bashfiles" suite:
To mirror specific file objects:
- No labels