aboutsummaryrefslogtreecommitdiff
path: root/doc/git-annex-p2p.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2016-12-16 16:32:29 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2016-12-16 16:38:06 -0400
commit6aa7e136b5d246228723f4c9996bda11f66c4445 (patch)
tree145310079adb607fae058a0a1dd42c7f155d26e1 /doc/git-annex-p2p.mdwn
parent353b59a000dd0e4941b3c36a7fd02d23f3cf44a1 (diff)
p2p --link now defaults to setting up a bi-directional link
Both the local and remote git repositories get remotes added pointing at one-another. Makes pairing twice as easy! Security: The new LINK command in the protocol can be sent repeatedly, but only by a peer who has authenticated with us. So, it's entirely safe to add a link back to that peer, or to some other peer it knows about. Anything we receive over such a link, the peer could send us over the current connection. There is some risk of being flooded with LINKs, and adding too many remotes. To guard against that, there's a hard cap on the number of remotes that can be set up this way. This will only be a problem if setting up large p2p networks that have exceptional interconnectedness. A new, dedicated authtoken is created when sending LINK. This also allows, in theory, using a p2p network like tor, to learn about links on other networks, like telehash. This commit was sponsored by Bruno BEAUFILS on Patreon.
Diffstat (limited to 'doc/git-annex-p2p.mdwn')
-rw-r--r--doc/git-annex-p2p.mdwn9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/git-annex-p2p.mdwn b/doc/git-annex-p2p.mdwn
index 6c50c9dd2..cefa116d6 100644
--- a/doc/git-annex-p2p.mdwn
+++ b/doc/git-annex-p2p.mdwn
@@ -24,13 +24,16 @@ services.
* `--link`
- Sets up a git remote that is accessed over a P2P network.
+ Sets up a link with a peer over the P2P network.
This will prompt for an address to be entered; you should paste in the
address that was generated by --gen-address in the remote repository.
- Defaults to making the git remote be named "peer1", "peer2",
- etc. This can be overridden with the `--name` option.
+ A git remote will be created, with a name like "peer1", "peer2"
+ by default (the `--name` option can be used to specify the name).
+
+ The link is bi-directional, so the peer will also have a git
+ remote added to it, linking back to the repository where this is run.
* `--name`