extern/zrepl
1
0
Fork 0
mirror of https://github.com/zrepl/zrepl.git synced 2024-11-21 16:03:32 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: document changes to ssh+stdinserver transport implementation: ccd062e

Browse Source
This commit is contained in:
Christian Schwarz 2018-02-17 15:15:31 +01:00
parent 759dae4552
commit 94967b596c
3 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -53,7 +53,6 @@ Make sure to develop an understanding how zrepl is typically used by studying th
│   ├── public_git # checkout of zrepl.github.io managed by above shell script
├── logger # logger package used by zrepl
├── rpc # rpc protocol implementation
├── sshbytestream # io.ReadWriteCloser over SSH
├── util
└── zfs # ZFS wrappers, filesystemm diffing
```

2
cmd/config_job_source.go
View File

@ -220,7 +220,7 @@ func (j *SourceJob) handleConnection(rwc io.ReadWriteCloser, task *Task) {
// wait for client to close connection
// FIXME: we cannot just close it like we would to with a TCP socket because
// FIXME: sshbytestream's Close() may overtake the remaining data in the pipe
// FIXME: go-nettsh's Close() may overtake the remaining data in the pipe
const CLIENT_HANGUP_TIMEOUT = 1 * time.Second
task.Log().
WithField("timeout", CLIENT_HANGUP_TIMEOUT).

2
docs/configuration/transports.rst
View File

@ -16,7 +16,7 @@ Currently, only the ``ssh+stdinserver`` transport is supported.
-----------------------------
The way the ``ssh+stdinserver`` transport works is inspired by `git shell <https://git-scm.com/docs/git-shell>`_ and `Borg Backup <https://borgbackup.readthedocs.io/en/stable/deployment.html>`_.
It is implemented in the Go package ``github.com/zrepl/zrepl/sshbytestream``.
It is provided by the Go package ``github.com/problame/go-netssh``.
The config excerpts are taken from the :ref:`tutorial` which you should complete before reading further.
.. _transport-ssh+stdinserver-serve: