Transfer Files

Learn to transfer files to and from SubModel.

Prerequisites

• If you intend to use scp, make sure your Pod is configured to use real SSH. For more information, see use SSH.

• If you intend to use rsync, make sure it's installed on both your local machine and your Pod with apt install rsync.

• Note the public IP address and external port from the SSH over exposed TCP command (you'll need these for the SCP/rsync commands).

Transferring with SCP

The general syntax for sending files to a Pod with SCP is as follows (execute this on your local machine, and replace the x's with your Pod's external TCP port and IP; for this example, they are 43201 and 194.26.196.6, respectively):

scp -P 43201 -i ~/.ssh/id_ed25519 /local/file/path root@194.26.196.6:/destination/file/path

note If your private key file is in a location other than ~/.ssh/id_ed25519 or you're using the Windows Command Prompt, make sure you update this path accordingly in your command.

Example of sending a file to a Pod:

scp -P 43201 -i ~/.ssh/id_ed25519 ~/documents/example.txt root@194.26.196.6:/root/example.txt

If you want to receive a file from your Pod, switch the source and destination arguments:

scp -P 43201 -i ~/.ssh/id_ed25519 root@194.26.196.6:/root/example.txt ~/documents/example.txt

If you need to transfer a directory, use the -r flag to recursively copy files and subdirectories (this will follow any symbolic links encountered as well):

scp -r -P 43201 -i ~/.ssh/id_ed25519 ~/documents/example_dir root@194.26.196.6:/root/example_dir

Transferring with rsync

note Your local machine must be running Linux or a WSL instance in order to use rsync.

The general syntax for sending files to a Pod with rsync is as follows (execute this on your local machine, and replace the x's with your Pod's external TCP port and IP):

rsync -e "ssh -p 43201" /source/file/path root@194.26.196.6:/destination/file/path

Some helpful flags include:

• -a/--archive - archive mode (ensures that permissions, timestamps, and other attributes are preserved during the transfer; use this when transferring directories or their contents)

• -d/--delete - deletes files in the destination directory that are not present in the source

• -p/--progress - displays file transfer progress

• -v/--verbose - verbose output

• -z/--compress - compresses data as it's being sent and uncompresses as it's received (heavier on your CPU, but easier on your network connection)

Example of sending a file to a Pod using rsync:

rsync -avz -e "ssh -p 43201" ~/documents/example.txt root@194.26.196.6:/root/example.txt

If you want to receive a file from your Pod, switch the source and destination arguments:

rsync -avz -e "ssh -p 43201" root@194.26.196.6:/root/example.txt ~/documents/example.txt

To transfer the contents of a directory (without transferring the directory itself), use a trailing slash in the file path:

rsync -avz -e "ssh -p 43201" ~/documents/example_dir/ root@194.26.196.6:/root/example_dir/

Without a trailing slash, the directory itself is transferred:

rsync -avz -e "ssh -p 43201" ~/documents/example_dir root@194.26.196.6:/root/

An advantage of rsync is that files that already exist at the destination aren't transferred again if you attempt to copy them twice (note the minimal data transfer after the second execution):

rsync -avz -e "ssh -p 43201" ~/documents/example.txt root@194.26.196.6:/root/example.txt
sending incremental file list
example.txt
             119 100%    0.00kB/s    0:00:00 (xfr#1, to-chk=0/1)

sent 243 bytes  received 35 bytes  185.33 bytes/sec
total size is 119  speedup is 0.43

$ rsync -avz -e "ssh -p 43201" ~/documents/example.txt root@194.26.196.6:/root/example.txt
sending incremental file list

sent 120 bytes  received 12 bytes  88.00 bytes/sec
total size is 119  speedup is 0.90