Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
git-annex-enableremote(1)   General Commands Manual  git-annex-enableremote(1)

NAME
       git-annex-enableremote -	enables	git-annex to use a remote

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

DESCRIPTION
       Enables	use  of	an existing remote in the current repository, that was
       set up earlier by git annex initremote run  in  another	clone  of  the
       repository.

       When enabling a remote, specify the same	name used when originally set-
       ting up that remote with	git annex initremote. Run git annex  enablere-
       mote without any	name to	get a list of remote names. Or you can specify
       the uuid	or description of the remote.

       Some types of special remotes need parameters  to  be  specified	 every
       time  they  are	enabled. For example, the directory special remote re-
       quires a	directory= parameter every time. The command will  prompt  for
       any required parameters you leave out.

       This  command can also be used to modify	the configuration of an	exist-
       ing special remote, by specifying new values for	 parameters  that  are
       usually	set when using initremote. (However, some settings such	as the
       as the encryption scheme	cannot be changed once a  special  remote  has
       been created.)

       The  GPG	keys that an encrypted special remote is encrypted with	can be
       changed using the keyid+= and keyid-=  parameters.  These  respectively
       add  and	 remove	 keys from the list. However, note that	removing a key
       does NOT	necessarily prevent the	key's owner from accessing data	in the
       encrypted  special  remote  (which  is  by  design impossible, short of
       deleting	the remote).

       One use-case of keyid-= is to replace a revoked key with	a new key:

	git annex enableremote mys3 keyid-=revokedkey keyid+=newkey

       Also, note that for encrypted special remotes  using  plain  public-key
       encryption  (encryption=pubkey),	adding or removing a key has NO	effect
       on files	that have already been	copied	to  the	 remote.  Hence	 using
       keyid+=	and  keyid-=  with  such remotes should	be used	with care, and
       make little sense except	in cases like the revoked key example above.

       If you get tired	of manually enabling a	special	 remote	 in  each  new
       clone,  you  can	pass "autoenable=true".	Then when git-annex-init(1) is
       run in a	new clone, it will will	attempt	to enable the special  remote.
       Of  course,  this works best when the special remote does not need any-
       thing special to	be done	to get it enabled.

       (This command also can be used to enable	a git  remote  that  git-annex
       has  found  didn't  work	 before	 and  gave  up	on  using, setting re-
       mote.<name>.annex-ignore.)

SEE ALSO
       git-annex(1)

       git-annex-initremote(1)

AUTHOR
       Joey Hess <id@joeyh.name>

						     git-annex-enableremote(1)

NAME | SYNOPSIS | DESCRIPTION | SEE ALSO | AUTHOR

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=git-annex-enableremote&sektion=1&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help