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 For a machine-readable list of the parameters, use this with
54 --json.
55 --fast When initializing a remote that uses encryption, a cryptographic
57 key is created. This requires sufficient entropy. If initremote
58 seems to hang or take a long time while generating the key, you
59 may want to Ctrl-c it and re-run with --fast, which causes it to
60 use a lower-quality source of randomness. (Ie, /dev/urandom in‐
61 stead of /dev/random)
62 --sameas=remote
64 Use this when the new special remote uses the same underlying
65 storage as some other remote. This will result in the new spe‐
66 cial remote having the same uuid as the specified remote, and
67 either can be used to access the same content.
68 The remote can be the name of a git remote, or the description
70 or uuid of any git-annex repository.
71 When using this option, the new remote inherits the encryption
73 settings of the existing remote, so you should not specify any
74 encryption parameters. No other configuration is inherited from
75 the existing remote.
76 This will only work if both remotes use the underlying storage
78 in compatible ways. See this page for information about known
79 compatabilities. <http://git-annex.branchable.com/tips/multi‐
80 ple_remotes_accessing_the_same_data_store/>
81 --private
83 Avoid recording information about the special remote in the git-
84 annex branch. The special remote will only be usable from the
85 repository where it was created.
86 --json Enable JSON output. This is intended to be parsed by programs
88 that use git-annex.
89 --json-error-messages
91 Messages that would normally be output to standard error are in‐
92 cluded in the JSON instead.
93 Also the git-annex-common-options(1) can be used.
95
97 encryption
98 Almost all special remotes support encryption. You will need to
100 specify what encryption, if any, to use.
101 If you do not want any encryption, use encryption=none
103 To encrypt to a GPG key, use encryption=hybrid keyid=$keyid ...
105 and fill in the GPG key id (or an email address associated with
106 a GPG key).
107 For details about this and other encrpytion settings, see
109 <https://git-annex.branchable.com/encryption/> or --whatelse
110 autoenable
112 To avoid git annex enableremote needing to be run, you can pass
113 "autoenable=true". Then when git-annex is run in a new clone, it
114 will attempt to enable the special remote. Of course, this works
115 best when the special remote does not need anything special to
116 be done to get it enabled.
117 cost Specify this to override the default cost of the special remote.
119 This configuration can be overridden by the local git config, eg
120 remote.name.annex-cost.
121 uuid Normally, git-annex initremote generates a new UUID for the new
123 special remote. If you want to, you can specify a UUID for it to
124 use, by passing a uuid=whatever parameter. This can be useful in
125 some unusual situations. But if in doubt, don't do this.
126
128 git-annex(1)
129 git-annex-enableremote(1)
131 git-annex-configremote(1)
133 git-annex-renameremote(1)
135
137 Joey Hess <id@joeyh.name>
138 git-annex-initremote(1)