NAME

git-annex verifyremote - verify if a special remote is safe to use

SYNOPSIS

git annex verifyremote name [--safe ID|--unsafe]

DESCRIPTION

When a special remote was created by someone else, it's important to verify that the repository it's configured to use is in the location you expect. Otherwise, you risk information leaking out from the special remote to other remotes.

To prevent such data leakage, git-annex enableremote will display the configuration of the special remote, and prompt you to run this command. Until the special remote is verified, it cannot be used.

When a special remote is autoenabled by git-annex init, it can be used before it is verified. But, git-annex will prevent sending annexed files or git pushes to any remote, until this command is used to verify the autoenabled special remote.

This command can also be used when the configuration of a special remote has changed. The old configuration will continue to be used until this command is used to verify the new configuration.

When run with no options, this command displays the configuration of the special remote, and prompts you to verify it.

OPTIONS

  • --safe ID

    Use when you have verified that the configuration of the special remote makes it use the location you expect.

    The ID will be provided to you by git-annex when displaying the configuration of the special remote.

  • --unsafe

    If the configuration of the special remote makes it use a location that you did not expect, use this option.

  • Also, the git-annex-common-options(1) can be used.

SEE ALSO

git-annex(1)

git-annex-initremote(1)

git-annex-enableremote(1)

git-annex-pre-push(1)

AUTHOR

Joey Hess id@joeyh.name

Warning: Automatically converted into a man page by mdwn2man. Edit with care.