1git-annex-initremote(1)     General Commands Manual    git-annex-initremote(1)
2
3
4

NAME

6       git-annex-initremote - creates a special (non-git) remote
7

SYNOPSIS

9       git annex initremote name type=value [param=value ...]
10

DESCRIPTION

12       Creates a new special remote, and adds it to .git/config.
13
14       Example Amazon S3 remote:
15
16        git  annex  initremote  mys3  type=S3 encryption=hybrid keyid=me@exam‐
17       ple.com datacenter=EU
18
19       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
23       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. The command will prompt for parameters as needed. A few
26       parameters  that are supported by all special remotes are documented in
27       the next section below.
28
29       Once a special remote has been  initialized  once  with  this  command,
30       other  clones  of  the repository can also be set up to access it using
31       git annex enableremote.
32
33       The name you provide for the remote can't be one that's been  used  for
34       any  other  special  remote before, because git-annex enableremote uses
35       the name to identify which special remote to enable. If some  old  spe‐
36       cial remote that's no longer used has taken the name you want to reuse,
37       you might want to use git annex renameremote.
38

OPTIONS

40       --fast
41
42              When initializing a remote that uses encryption, a cryptographic
43              key  is created. This requires sufficient entropy. If initremote
44              seems to hang or take a long time while generating the key,  you
45              may want to Ctrl-c it and re-run with --fast, which causes it to
46              use a lower-quality  source  of  randomness.  (Ie,  /dev/urandom
47              instead of /dev/random)
48

COMMON CONFIGURATION PARAMETERS

50       encryption
51
52              All special remotes support encryption. You will need to specify
53              what encryption, if any, to use.
54
55              If you do not want any encryption, use encryption=none
56
57              To encrypt to a GPG key, use encryption=hybrid keyid=$keyid  ...
58              and  fill in the GPG key id (or an email address associated with
59              a GPG key).
60
61              For details  about  this  and  other  encrpytion  settings,  see
62              <https://git-annex.branchable.com/encryption/>
63
64       autoenable
65              To  avoid git annex enableremote needing to be run, you can pass
66              "autoenable=true". Then when git-annex-init(1) is run in  a  new
67              clone,  it will attempt to enable the special remote. Of course,
68              this works best when the special remote does not  need  anything
69              special to be done to get it enabled.
70
71       uuid   Normally,  git-annex initremote generates a new UUID for the new
72              special remote. If you want to, you can specify a UUID for it to
73              use, by passing a uuid=whatever parameter. This can be useful in
74              some unusual situations.  But if in doubt, don't do this.
75

SEE ALSO

77       git-annex(1)
78
79       git-annex-enableremote(1)
80
81       git-annex-renameremote(1)
82

AUTHOR

84       Joey Hess <id@joeyh.name>
85
86                                                       git-annex-initremote(1)