1git-annex-initremote(1) General Commands Manual git-annex-initremote(1)
2
6 git-annex-initremote - creates a special (non-git) remote
7
9 git annex initremote name type=value [param=value ...]
10
12 Creates a new special remote, and adds it to .git/config.
13 Example Amazon S3 remote:
15 git annex initremote mys3 type=S3 encryption=hybrid keyid=me@exam‐
17 ple.com datacenter=EU
18 Many different types of special remotes are supported by git-annex.
20 For a list and details, see <https://git-annex.branchable.com/spe‐
21 cial_remotes/>
22 The remote's configuration is specified by the parameters passed to
24 this command. Different types of special remotes need different config‐
25 uration values, so consult the documentation of a special remote for
26 details. The command will prompt for any required parameters you leave
27 out; you can also pass --whatelse to see additional parameters.
28 A few parameters that are supported by all special remotes are docu‐
30 mented in the next section below.
31 Once a special remote has been initialized once with this command,
33 other clones of the repository can also be set up to access it using
34 git annex enableremote.
35 The name you provide for the remote can't be one that's been used for
37 any other special remote before, because git-annex enableremote uses
38 the name to identify which special remote to enable. If some old spe‐
39 cial remote that's no longer used has taken the name you want to reuse,
40 you might want to use git annex renameremote.
41
43 --whatelse / -w
44 Describe additional configuration parameters that you could
46 specify.
47 For example, if you know you want a S3 remote, but forget how to
49 configure it:
50 git annex initremote mys3 type=S3 --whatelse
52 --fast When initializing a remote that uses encryption, a cryptographic
54 key is created. This requires sufficient entropy. If initremote
55 seems to hang or take a long time while generating the key, you
56 may want to Ctrl-c it and re-run with --fast, which causes it to
57 use a lower-quality source of randomness. (Ie, /dev/urandom
58 instead of /dev/random)
59 --sameas=remote
61 Use this when the new special remote uses the same underlying
62 storage as some other remote. This will result in the new spe‐
63 cial remote having the same uuid as the specified remote, and
64 either can be used to access the same content.
65 The remote can be the name of a git remote, or the description
67 or uuid of any git-annex repository.
68 When using this option, the new remote inherits the encryption
70 settings of the existing remote, so you should not specify any
71 encryption parameters. No other configuration is inherited from
72 the existing remote.
73 This will only work if both remotes use the underlying storage
75 in compatible ways. See this page for information about known
76 compatabilities. <http://git-annex.branchable.com/tips/multi‐
77 ple_remotes_accessing_the_same_data_store/>
78
80 encryption
81 Almost all special remotes support encryption. You will need to
83 specify what encryption, if any, to use.
84 If you do not want any encryption, use encryption=none
86 To encrypt to a GPG key, use encryption=hybrid keyid=$keyid ...
88 and fill in the GPG key id (or an email address associated with
89 a GPG key).
90 For details about this and other encrpytion settings, see
92 <https://git-annex.branchable.com/encryption/> or --whatelse
93 autoenable
95 To avoid git annex enableremote needing to be run, you can pass
96 "autoenable=true". Then when git-annex-init(1) is run in a new
97 clone, it will attempt to enable the special remote. Of course,
98 this works best when the special remote does not need anything
99 special to be done to get it enabled.
100 uuid Normally, git-annex initremote generates a new UUID for the new
102 special remote. If you want to, you can specify a UUID for it to
103 use, by passing a uuid=whatever parameter. This can be useful in
104 some unusual situations. But if in doubt, don't do this.
105
107 git-annex(1)
108 git-annex-enableremote(1)
110 git-annex-renameremote(1)
112
114 Joey Hess <id@joeyh.name>
115 git-annex-initremote(1)