summaryrefslogtreecommitdiff
path: root/doc/git-annex-p2p.mdwn
blob: 127ed9a5dad9f881b65a12646d795de39e26be75 (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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# 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

* `--pair`

  Run this in two repositories to pair them together over the P2P network.

  This will print out a code phrase, like "3-mango-elephant", and
  will prompt for you to enter the code phrase from the other repository.

  Once code phrases have been exchanged, the two repositories will
  be paired. A git remote will be created for the other repository,
  with a name like "peer1".

  This uses [Magic Wormhole](https://github.com/warner/magic-wormhole)
  to verify the code phrases and securely communicate the P2P addresses of
  the repositories, so you will need it installed on both computers that are
  being paired.

* `--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. 
  
  Note that anyone who knows these addresses can access your
  repository over the P2P networks.

* `--link`

  Sets up a git remote that is accessed over a 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.

* `--name`

  Specify a name to use when setting up a git remote with `--link`
  or `--pair`.

# SEE ALSO

[[git-annex]](1)

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

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

wormhole(1)

# AUTHOR

Joey Hess <id@joeyh.name>

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