mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update docs for git-annex p2p command

Browse source 
It is not yet implemented.
This commit is contained in:
Joey Hess 2016-11-29 17:31:10 -04:00
parent 38425fdc39
commit a173f85578
No known key found for this signature in database
GPG key ID: C910D9222512E3C7
4 changed files with 21 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
doc/git-annex-p2p.mdwn
View file

@ -1,6 +1,6 @@
# NAME
git-annex p2p - manage peer-to-peer connections
git-annex p2p - configure peer-2-peer links between repositories
# SYNOPSIS
@ -8,36 +8,21 @@ git annex p2p [options]
# DESCRIPTION
When using git-annex with peer-to-peer communication, this manages
connections between the peers.
Currently, git-annex supports peer-to-peer communication over Tor.
This command can be used to link git-annex repositories over peer-2-peer
networks.
# OPTIONS
* `--gen-address [name]`
* `--gen-address`
Generates one or more addresses, which allow whoever knows them to access
your repository. The addresses are output on standard output, one per
supported P2P network.
Generates addresses that can be used to access this git-annex repository
over a P2P network. The address or addresses is output to stdout.
You can re-run this command repeatedly to generate as many addresses
as you like.
* `--link-remote remotename address`
The name is an optional parameter, the name of the person or device you
intend to give this address to. Providig it makes it easier to use
`--remove-address`
* `--link-remote name address`
Link the local repository to a remote repository. This sets up a git remote
with the specified name. The address is one generated by `--gen-address`
run on the remote repository.
* `--remove-address [address|name]`
If you've given out an address to someone, and don't want to accept
connections from them anymore, this can be used to remove it.
Sets up a git remote with the specified remotename that is accessed over
a P2P network. The address is one generated in the remote repository using
`git annex p2p --gen-address`
# SEE ALSO

3
doc/git-annex-remotedaemon.mdwn
View file

@ -27,6 +27,7 @@ that supports it is 5.20140405.
For tor-annex remotes, the remotedaemon runs as a tor hidden service,
accepting connections from other nodes and serving up the contents of the
repository. This is only done if you first run `git annex enable-tor`.
Use `git annex p2p` to configure access to tor-annex remotes.
# OPTIONS
@ -48,6 +49,8 @@ comes back up.
[[git-annex-enable-tor]](1)
[[git-annex-p2p]](1)
# AUTHOR
Joey Hess <id@joeyh.name>

5
doc/git-annex.mdwn
View file

@ -391,6 +391,11 @@ subdirectories).
See [[git-annex-remotedaemon]](1) for details.
* `p2p`
Configure peer-2-Peer links between repositories.
See [[git-annex-p2p]](1) for details.
# QUERY COMMANDS

6
doc/tips/peer_to_peer_network_with_tor.mdwn
View file

@ -16,7 +16,7 @@ To make git-annex use Tor, run these commands in your git-annex repository:
git annex remotedaemon
git annex p2p --gen-address
The p2p-auth command will output a long address, such as:
The p2p command will output a long address, such as:
tor-annex::eeaytkuhaupbarfi.onion:4412:7f53c5b65b8957ef626fd461ceaae8056e3dbc459ae715e4
@ -55,8 +55,8 @@ You can run any commands you normally would to sync with that remote:
git annex sync --content peer1
You can also generate an address for this new peer, by running
`git annex p2p --gen`, and add that address to other peers using `git annex
You can also generate an address for this new peer, by running `git annex
p2p --gen-address`, and add that address to other peers using `git annex
p2p --link-remote`. It's often useful to link peers up in both directions,
so peer1 is a remote of peer2 and peer2 is a remote of peer1.