Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Welcome to the step-by-step tutorial on how to use the rsync command line with your Mediaflux project at the University of Melbourne (UoM). This guide will help you understand the basic usage and various options of rsync command you can use to access your UoM Mediaflux projects for efficient file synchronization and transfer.

Why use rsync?

rsync is a command line file transfer and syncing tool used to transfer and sync files and directories. It is especially good for syncing file sets where only a small portion of files have changed and where there are some changes to existing files. It does this by only transferring the files with changes and the changes made in a file instead of resending entire files over, hence being more efficient.

It also has an advantage over the unimelb-mf-clients in terms of this efficiency and that most linux and macOS systems have rsync pre-installed while you need to install the unimelb-mf-clients . In windows you can get rsync through WSL(windows subsystem for linux) or cygwin.

The main limitations are that rsync is single threaded and is slow to upload entire large files.

Please note, this is a special access method offered by the UoM Mediaflux service and not a standard Mediaflux function.

...

  • A UoM Mediaflux project

  • Access to UoM VPN

  • Access to a terminal or command prompt

  • Installed rsync on your system (ensure the rsync protocol version is 30 or later)

  • OPTIONAL: Below steps are only necessary when using rsync on UoM Mediaflux Test server:

    • Add your public key to the UoM Test Mediaflux server

    • Connect to RCS VPN

    • Set up port 2001 for forwarding with this command on your computer and keep that terminal window open throughout your rsync session:

      • $ ssh -L 2001:localhost:6600  mflux@mediaflux-test.researchsoftware.unimelb.edu.au  -p 22022

    • Ensure the port 2001 on your computer is not being used by any other application, if so you can replace with another free port number greater than 2001, e.g., using port 3001:

      $ ssh -L 3001:localhost:6600  mflux@mediaflux-test.researchsoftware.unimelb.edu.au  -p 22022

Options supported

List of supported args/options:

-a

-t

-p

-g

-n/--dry-run

--delete

--exclude

--include

-v

-l

-r

-i/--itemize-changes

-c

--filter

-I/--ignore-times

-o

-d/--dirs

--progress

--stderr=e|a|c seems to work


Example 1: Upload Files From Your Local Computer Into Your Mediaflux Project

...