borg-key-import(1)

Name
borg-key-import - Imports the repository key from backup.

SYNOPSIS

borg [common options] key import [options] [PATH]

DESCRIPTION

This command restores a key previously backed up with the export command.

If the --paper option is given, the import will be an interactive process in which each line is checked for plausibility before proceeding to the next line. For this format PATH must not be given.

For repositories using keyfile encryption, the key file which borg key import writes to depends on several factors. If the BORG_KEY_FILE environment variable is set and non-empty, borg key import creates or overwrites that file named by $BORG_KEY_FILE. Otherwise, borg key import searches in the $BORG_KEYS_DIR directory for a key file associated with the repository. If a key file is found in $BORG_KEYS_DIR, borg key import overwrites it; otherwise, borg key import creates a new key file in $BORG_KEYS_DIR.

OPTIONS

See borg-common(1) for common options of Borg commands.

  arguments

PATH
    path to the backup ('-' to read from stdin)

  options

--paper
    interactively import from a backup done with --paper

--key-location LOCATION
    where to store the imported key: 'repokey' (in the repository, default) or 'keyfile' (in the local keys directory)

SEE ALSO

borg-common(1), borg-key-export(1)

Author
The Borg Collective