git-lfs/docs
brian m. carlson 9c46a38281
ssh: support concurrent transfers using the pure SSH protocol
When using the pure SSH-based protocol, we can get much higher speeds by
multiplexing multiple connections on the same SSH connection.  If we're
using OpenSSH, let's enable the ControlMaster option unless
lfs.ssh.automultiplex is set to false, and multiplex these shell
operations over one connection.

We prefer XDG_RUNTIME_DIR because it's guaranteed to be private and we
can share many connections over one socket, but if that's not set, let's
default to creating a new temporary directory for the socket.  On
Windows, where the native SSH client doesn't support ControlMaster,
we should fall back to using multiple connections since we use
ControlMaster=auto.

Note that the option exists because users may already be using SSH
multiplexing and we would want to provide a way for them to disable
this, in addition to the case where users have an old or broken OpenSSH
which cannot support this option.

We pass the connection object into each worker and adjust our transfer
code to pass it into each function we invoke.  We also make sure to
properly terminate each connection at the end by reducing our connection
count to 0, which closes the extra (i.e., all) connections.

Co-authored-by: Chris Darroch <chrisd8088@github.com>
2021-07-20 19:15:59 +00:00
..
api docs: suggest using main as the default branch 2021-02-02 14:40:50 +00:00
howto docs: prepare for rename of default branch name 2021-02-02 14:40:51 +00:00
man ssh: support concurrent transfers using the pure SSH protocol 2021-07-20 19:15:59 +00:00
proposals docs: update "unlock" response output for SSH protocol 2021-07-20 18:37:31 +00:00
custom-transfers.md Fix typo 'initiation' 2019-08-22 00:24:14 +02:00
extensions.md Fix typo 2015-10-06 01:11:55 +09:00
linux-build.md Remove trailing whitespace 2018-10-03 20:34:13 +00:00
README.md Allow using custom transfer agents directly 2017-07-31 16:28:07 +02:00
spec.md docs/spec: document that pointer files are unique 2019-12-09 22:08:19 +00:00

Git LFS Documentation

Reference Manual

Each Git LFS subcommand is documented in the official man pages. Any of these can also be viewed from the command line:

$ git lfs help <command>
$ git lfs <command> -h

Videos

Developer Docs

Details of how the Git LFS client works are in the official specification.

Details of how the GIT LFS server works are in the API specification.