Skip to content

Instantly share code, notes, and snippets.

@razhangwei

razhangwei/omv_usb.md

Last active December 15, 2024 23:47
Show Gist options
  • Save razhangwei/c3024f155a66652c84ace2c73d5439eb to your computer and use it in GitHub Desktop.
Save razhangwei/c3024f155a66652c84ace2c73d5439eb to your computer and use it in GitHub Desktop.
Download ZIP
#OMV USB Backup
Raw
omv_usb.md

  • the external hardware needs to be EXT4.

  • relative path: usually the same as the shared forder so that it's identifiable.

  • extra options:

    • --update
    • --exclude dir1 --exclude dir2

  • View Logs: Check Diagnostics -> System Logs -> Logs -> Rsync - Jobs to see backup details.

  • Manual Backup: Select a job in the grid panel and click "Run" to start a backup manually.

  • Email Notifications: Configure email settings to receive backup status updates.

  • Mounting After Backup: To check files after backup, manually mount the drive without triggering another backup.

  • Backup Direction:

    • External to Shared Folder: Backs up from USB to OMV
    • Shared Folder to External: Backs up from OMV to USB

References:

  1. https://www.openmediavault.org/?p=936
  2. https://www.reddit.com/r/OpenMediaVault/comments/1el6zkc/best_way_to_mount_and_unmount_usb_drives_for/

The USB Backup plugin for OpenMediaVault (OMV) is a useful tool for automatically backing up data to external USB storage devices. Here's a detailed instruction and cheat sheet for using this plugin:

Installation

  1. Ensure OMV-Extras is pre-installed on your system.
  2. Go to System > Plugins in the OMV web interface.
  3. Search for "USB Backup" and install the plugin.

Configuration

  1. Connect your USB storage device to the OMV server.
  2. In the OMV web interface, navigate to the USB Backup section.
  3. Click "Add" to create a new backup job.
  4. Select the USB device from the "Volume" dropdown.
  5. Choose the shared folder you want to back up.
  6. Configure additional options as needed.
  7. Save the job configuration.

Usage

  • The plugin automatically detects when the configured USB device is connected.
  • Backups start automatically when the device is plugged in.
  • A beep sounds when the backup starts and finishes.
  • The system automatically unmounts the drive after the backup completes.

Tips

  • The plugin is designed for on-demand backups, not scheduled ones.
  • It's not compatible with encrypted USB drives (LUKS).
  • For scheduled backups, use the rsync plugin instead.
  • The plugin automatically mounts and unmounts drives, so manual mounting may interfere with its operation.

Troubleshooting

  • If the device shows as "not mounted" after manual mounting, the plugin may have automatically unmounted it.
  • Ensure the USB drive is formatted in a compatible filesystem (e.g., ext4).
  • Check system logs for any error messages if backups fail to start.

Remember, this plugin is designed for simplicity and automatic operation when connecting USB drives, making it ideal for quick, on-demand backups without manual intervention[1][3][7].

Citations: [1] https://www.youtube.com/watch?v=TBsgvp6w_HY [2] https://wiki.omv-extras.org/doku.php?id=docs_in_draft%3Abackup-next [3] https://www.openmediavault.org/?p=936 [4] https://www.reddit.com/r/OpenMediaVault/comments/kmt40k/encrypted_usb_backup/ [5] https://www.reddit.com/r/OpenMediaVault/comments/1g90lpf/can_i_program_the_usb_backup_plugin/ [6] https://www.youtube.com/watch?v=IJCXSGXMLfc [7] https://forum.openmediavault.org/index.php [8] https://www.reddit.com/r/OpenMediaVault/comments/b28sk8/transfer_files_to_omv_via_usb/ [9] https://www.reddit.com/r/OpenMediaVault/comments/171tamu/transferring_files_to_usb_stick_from_omv_nas/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment