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

NAME

6       git-annex-enableremote - enables git-annex to use a remote
7

SYNOPSIS

9       git annex enableremote name|uuid|desc [param=value ...]
10

DESCRIPTION

12       Enables use of an existing remote in the current repository.
13
14       This  is  often  used to enable use of a special (non-git) remote, by a
15       different repository than the one in which it  was  originally  created
16       with the initremote command.
17
18       It  can  also  be  used to explicitly enable a git remote, so that git-
19       annex can store the contents of files there. First run git remote  add,
20       and then git annex enableremote with the name of the remote.
21
22       When  enabling a special remote, specify the same name used when origi‐
23       nally creating that remote with git annex  initremote.  Run  git  annex
24       enableremote without any name to get a list of special remote names. Or
25       you can specify the uuid or description of the special remote.
26
27       Some special remotes may need parameters to  be  specified  every  time
28       they  are enabled. For example, the directory special remote requires a
29       directory= parameter every time.
30
31       This command can also be used to modify the configuration of an  exist‐
32       ing  special  remote,  by specifying new values for parameters that are
33       usually set when using initremote. (However, some settings such as  the
34       as  the  encryption  scheme cannot be changed once a special remote has
35       been created.)
36
37       The GPG keys that an encrypted special remote is encrypted with can  be
38       changed  using  the  keyid+= and keyid-= parameters. These respectively
39       add and remove keys from the list. However, note that  removing  a  key
40       does NOT necessarily prevent the key's owner from accessing data in the
41       encrypted special remote (which  is  by  design  impossible,  short  of
42       deleting the remote).
43
44       One use-case of keyid-= is to replace a revoked key with a new key:
45
46        git annex enableremote mys3 keyid-=revokedkey keyid+=newkey
47
48       Also,  note  that  for encrypted special remotes using plain public-key
49       encryption (encryption=pubkey), adding or removing a key has NO  effect
50       on  files  that  have  already  been  copied to the remote. Hence using
51       keyid+= and keyid-= with such remotes should be  used  with  care,  and
52       make little sense except in cases like the revoked key example above.
53
54       If  you  get  tired  of  manually enabling a special remote in each new
55       clone, you can pass "autoenable=true". Then when  git-annex-init(1)  is
56       run  in a new clone, it will will attempt to enable the special remote.
57       Of course, this works best when the special remote does not  need  any‐
58       thing special to be done to get it enabled.
59
60       (This  command  also  can be used to enable a remote that git-annex has
61       been prevented from using by the remote.<name>.annex-ignore setting.)
62

SEE ALSO

64       git-annex(1)
65
66       git-annex-initremote(1)
67

AUTHOR

69       Joey Hess <id@joeyh.name>
70
71                                                     git-annex-enableremote(1)