Giter Site home page Giter Site logo

shoop's Introduction

๐ŸŽ๐ŸŽ๐ŸŽ shoop ๐ŸŽ๐ŸŽ๐ŸŽ Build Status

SCP for the modern era. If I were better at marketing I might call this "insanely" fast.

security and stability

This is so incredibly alpha. not alpha like how fraternities use it. alpha like unverified.

DO NOT USE THIS FOR SECURITY SENSITIVE MATERIAL.

THIS IS A PREVIEW. As time passes, software gets more secure assuming I keep my unlaziness. Also right now, the protocol isn't stabilized, so you will need to keep the binaries on the server and client at (more or less) the same revision until we leave pre-alpha state.

what's it do

Shoop is a high-speed encrypted file transfer tool reminiscent of scp. It uses SSH to bootstrap authentication and encryption, then uses UDT (a reliable protocol from the 2000s) instead of TCP (a reliable protocol from the 1970s).

It is particularly useful in connections that are "bursty".

From Vietnam, for example, it typically speeds up my downloads by about 2x, if not more for larger files.

install

The server-side and client-side use the same binary (at least for now). Follow these instructions for both sides (at the moment, I'm not distributing binaries until this is more stable). If you're familiar with mosh, it's a very similar setup.

macOS

  1. get Command Line Tools for Xcode: xcode-select --install, https://developer.apple.com/downloads or Xcode
  2. get rust (easily via rustup curl https://sh.rustup.rs -sSf | sh)
  3. cargo install shoop

debian (if you're on another linux, you know the difference)

  1. get build-essentials sudo apt install build-essentials
  2. get rust (easily via rustup curl https://sh.rustup.rs -sSf | sh)
  3. cargo install shoop

windows

  1. yes sorry

server

If you have a firewall, the default port range shoop uses is 55000-55050 (if you want 50 simultaneous connections). In Ubuntu this might look like:

sudo ufw allow 55000:55050/udp

your typical performance example

โ˜  shoop [master] โšก time scp host-in-germany:~/125mb.file .
1.65s user 2.20s system 2% cpu 2:15.39 total
โ˜  shoop [master] โšก time shoop host-in-germany:~/125mb.file
2.39s user 4.53s system 8% cpu 1:18.53 total

why should i use it

  • It deals with unreliable/shoddy connections much more gracefully
  • It survives network interruptions

but isn't there tool X, Y, and Z already for this?

no, actually, not really.

shoop's People

Contributors

eminence avatar mcginty avatar strangeman avatar zmanian avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Forkers

kimusan

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.