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

OPTIONS

60       --json
61
62              Enable JSON output. This is intended to be  parsed  by  programs
63              that use git-annex.
64
65       --json-error-messages
66              Messages that would normally be output to standard error are in‐
67              cluded in the JSON instead.
68
69       Also, the git-annex-common-options(1) can be used.
70

SEE ALSO

72       git-annex(1)
73
74       git-annex-initremote(1)
75
76       git-annex-configremote(1)
77
78       git-annex-renameremote(1)
79

AUTHOR

81       Joey Hess <id@joeyh.name>
82
83                                                     git-annex-enableremote(1)