summaryrefslogtreecommitdiff
path: root/doc/git-annex-p2p.mdwn
blob: cefa116d6a5649c34e29f44f26a2255882ac3632 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# NAME

git-annex p2p - configure peer-2-peer links between repositories

# SYNOPSIS

git annex p2p [options]

# DESCRIPTION

This command can be used to link git-annex repositories over peer-2-peer
networks.

Currently, the only P2P network supported by git-annex is Tor hidden
services.

# OPTIONS

* `--gen-address`

  Generates addresses that can be used to access this git-annex repository
  over the available P2P networks. The address or addresses is output to
  stdout.

* `--link`

  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.

  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`

  Specify a name to use when setting up a git remote.

# SEE ALSO

[[git-annex]](1)

[[git-annex-enable-tor]](1)

[[git-annex-remotedaemon]](1)

# AUTHOR

Joey Hess <id@joeyh.name>

Warning: Automatically converted into a man page by mdwn2man. Edit with care.