- Linux or macOS
- Python 3.5 or newer
python3 -m pip install -r requirements.txt
See scsync --help for all options.
scsync [-h <hostname|ip-addr>] [-p <port>] [-f <directory-path>] -u <username> -pass <password>
scsync [-s] [-p <port>] [-f <directory-path>] [-cc]
For each user a password hash and salt have to be generated using the tools/gen_user_vkey.py script.
The credentials are then stored as CSV using the format <username>,<salt>,<verification_key> in the users.csv.
ATTENTION: By default a "testuser" with password "testpassword" is configured, which should be replaced by proper user credentials!
-s Server mode: accept incoming connections from any host
-p Specify the port number (default: 5000)
-f Directory that should be used to upload (client mode) or store the files (server mode)
-h Remote hosts
-cc Packets per second (default: 2000)
-cs Chunk size (adapt to your MTU, default: 8192)
--verbose Enable logging of most events
--debug Enable debug logging, all events are logged
scsynctest [-f <directory-path>]
Tests following areas for files of the following sizes: 5 MB, 50 MB, 100 MB, 200 MB, 500 MB, 1 GB and prints out the results in a formatted way to assess the performance of the protocol.
- Per file download time
- Per file overhead (how many bytes to send for metadata besides payload)
- Setup time until first byte received (Time-to-first byte)