diff options
| -rw-r--r-- | README.md | 26 |
1 files changed, 18 insertions, 8 deletions
@@ -1,11 +1,10 @@ -# µcp/ucp: µTP copy (very remote file transfer) +# ucp: UDT copy (very remote file transfer) -This is basically a clone of SSH's scp command that uses the µTP (the Micro -Transport Protocol) over UDP instead of passing data through the TCP SSH -connection. SSH (and TCP) is used for authentication and setup, just like -`mosh` does; the server-side ucp process is not a daemon and is not running -continuously. +This is basically a clone of SSH's scp command that uses the UDT (UDP Data +Transport) over UDP instead of passing data through the TCP SSH connection. SSH +(and TCP) is used for authentication and setup, just like `mosh` does; the +server-side ucp process is not a daemon and is not running continuously. The motivation for this tool is to get better bandwidth utilization over high-latency links with mild packet loss, while remaining well-behaved netizen. @@ -17,10 +16,21 @@ that. There is a bunch of overhead sending small files, so if you have a lot of those and a high-latency link you should probably `tar` things up first. There also isn't any compression, so you might want to `gzip` that tarball. +### Status + +Circa June 2016, this is very much a work in progress; see TODO. Only +getting/sending single files will ever work. + +Running with crypto enabled (the default) slows things to a drag. Without +crypto, the tool is generally at least as fast as any other transfer tool (eg, +faster than scp, bbcp, or UTP). + ### Dependencies -You need the Sodium (wrapper for NaCl) library and headers installed. On Linux, -this is, eg, libsodium-dev. +You need the Sodium (wrapper for NaCl) and UDT libraries and headers installed. +On Linux, this is, eg, libsodium-dev and libudt-dev. Unfortunately, the version +of libsodium from Debian Jessie won't work, you need the Stretch or newer +version. Uses sodiumoxide instead of rust-crypto because there aren't online docs for rust-crypto, and AFAIK Sodium and NaCl have been reviewed and rust-crypto has |