Restic

From Gentoo Wiki
Jump to:navigation Jump to:search
This article is a stub. Please help out by expanding it - how to get started.

Restic is a Go-based backup tool built simplicity, scalability, and verifiability in mind. Backups must be sent to a storage repository which can be a local file system or a remote system accessible via SFTP.

Features

  • Snapshot-based.
  • Data deduplication.
  • Emphasis on speed of recovery and verifiability of the data integrity.
  • Scriptability.

Installation

USE flags

USE flags for app-backup/restic A backup program that is fast, efficient and secure

Emerge

root #emerge --ask app-backup/restic

Additional software

Restic is not a daemon-based backup solution. The actual scheduling of backups is left to a task scheduler such as cron or systemd timers.

Configuration

Environment variables

Restic Configuration

  • RESTIC_REPOSITORY_FILE — Name of file containing the repository location (replaces --repository-file)
  • RESTIC_REPOSITORY — Location of repository (replaces -r)
  • RESTIC_PASSWORD_FILE — Location of password file (replaces --password-file)
  • RESTIC_PASSWORD — The actual password for the repository
  • RESTIC_PASSWORD_COMMAND — Command printing the password for the repository to stdout
  • RESTIC_KEY_HINT — ID of key to try decrypting first, before other keys
  • RESTIC_CACHE_DIR — Location of the cache directory
  • RESTIC_COMPRESSION — Compression mode (only available for repository format version 2)
  • RESTIC_PROGRESS_FPS — Frames per second by which the progress bar is updated
  • RESTIC_PACK_SIZE — Target size for pack files
  • RESTIC_READ_CONCURRENCY — Concurrency for file reads
  • TMPDIR — Location for temporary files

Amazon Web Services Integration

  • AWS_ACCESS_KEY_ID — Amazon S3 access key ID
  • AWS_SECRET_ACCESS_KEY — Amazon S3 secret access key
  • AWS_SESSION_TOKEN — Amazon S3 temporary session token
  • AWS_DEFAULT_REGION — Amazon S3 default region
  • AWS_PROFILE — Amazon credentials profile (alternative to specifying key and region)
  • AWS_SHARED_CREDENTIALS_FILE — Location of the AWS CLI shared credentials file (default: ~/.aws/credentials)

OpenStack Integration

  • ST_AUTH — Auth URL for keystone v1 authentication
  • ST_USER — Username for keystone v1 authentication
  • ST_KEY — Password for keystone v1 authentication
  • OS_AUTH_URL — Auth URL for keystone authentication
  • OS_REGION_NAME — Region name for keystone authentication
  • OS_USERNAME — Username for keystone authentication
  • OS_USER_ID — User ID for keystone v3 authentication
  • OS_PASSWORD — Password for keystone authentication
  • OS_TENANT_ID — Tenant ID for keystone v2 authentication
  • OS_TENANT_NAME — Tenant name for keystone v2 authentication
  • OS_USER_DOMAIN_NAME — User domain name for keystone authentication
  • OS_USER_DOMAIN_ID — User domain ID for keystone v3 authentication
  • OS_PROJECT_NAME — Project name for keystone authentication
  • OS_PROJECT_DOMAIN_NAME — Project domain name for keystone authentication
  • OS_PROJECT_DOMAIN_ID — Project domain ID for keystone v3 authentication
  • OS_TRUST_ID — Trust ID for keystone v3 authentication
  • OS_APPLICATION_CREDENTIAL_ID — Application Credential ID (keystone v3)
  • OS_APPLICATION_CREDENTIAL_NAME — Application Credential Name (keystone v3)
  • OS_APPLICATION_CREDENTIAL_SECRET — Application Credential Secret (keystone v3)
  • OS_STORAGE_URL — Storage URL for token authentication
  • OS_AUTH_TOKEN — Auth token for token authentication

Backblaze Integration

  • B2_ACCOUNT_ID — Account ID or applicationKeyId for Backblaze B2
  • B2_ACCOUNT_KEY — Account Key or applicationKey for Backblaze B2

Microsoft Azure Integration

  • AZURE_ACCOUNT_NAME — Account name for Azure
  • AZURE_ACCOUNT_KEY — Account key for Azure
  • AZURE_ACCOUNT_SAS — Shared access signatures (SAS) for Azure

Google Cloud Storage Integration

  • GOOGLE_PROJECT_ID — Project ID for Google Cloud Storage
  • GOOGLE_APPLICATION_CREDENTIALS —Application Credentials for Google Cloud Storage (e.g. $HOME/.config/gs-secret-restic-key.json)

Vendor Agnostic Cloud Storage Integration

  • RCLONE_BWLIMIT — rclone bandwidth limit

Usage

Invocation

user $restic --help
restic is a backup program which allows saving multiple revisions of files and
directories in an encrypted repository stored on different backends.

Usage:
  restic [command]

Available Commands:
  backup        Create a new backup of files and/or directories
  cache         Operate on local cache directories
  cat           Print internal objects to stdout
  check         Check the repository for errors
  copy          Copy snapshots from one repository to another
  diff          Show differences between two snapshots
  dump          Print a backed-up file to stdout
  find          Find a file, a directory or restic IDs
  forget        Remove snapshots from the repository
  generate      Generate manual pages and auto-completion files (bash, fish, zsh)
  help          Help about any command
  init          Initialize a new repository
  key           Manage keys (passwords)
  list          List objects in the repository
  ls            List files in a snapshot
  migrate       Apply migrations
  mount         Mount the repository
  prune         Remove unneeded data from the repository
  rebuild-index Build a new index
  recover       Recover data from the repository not referenced by snapshots
  restore       Extract the data from a snapshot
  self-update   Update the restic binary
  snapshots     List all snapshots
  stats         Scan the repository and show basic statistics
  tag           Modify tags on snapshots
  unlock        Remove locks other processes created
  version       Print version information

Flags:
      --cacert file                file to load root certificates from (default: use system certificates)
      --cache-dir directory        set the cache directory. (default: use system default cache directory)
      --cleanup-cache              auto remove old cache directories
      --compression mode           compression mode (only available for repository format version 2), one of (auto|off|max) (default auto)
  -h, --help                       help for restic
      --insecure-tls               skip TLS certificate verification when connecting to the repository (insecure)
      --json                       set output mode to JSON for commands that support it
      --key-hint key               key ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
      --limit-download int         limits downloads to a maximum rate in KiB/s. (default: unlimited)
      --limit-upload int           limits uploads to a maximum rate in KiB/s. (default: unlimited)
      --pack-size uint             set target pack size in MiB. (default: $RESTIC_PACK_SIZE)
      --no-cache                   do not use a local cache
      --no-lock                    do not lock the repository, this allows some operations on read-only repositories
  -o, --option key=value           set extended option (key=value, can be specified multiple times)
      --password-command command   shell command to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
  -p, --password-file file         file to read the repository password from (default: $RESTIC_PASSWORD_FILE)
  -q, --quiet                      do not output comprehensive progress report
  -r, --repo repository            repository to backup to or restore from (default: $RESTIC_REPOSITORY)
      --repository-file file       file to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
      --tls-client-cert file       path to a file containing PEM encoded TLS client certificate and private key
  -v, --verbose n                  be verbose (specify multiple times or a level using --verbose=n, max level/times is 3)

Use "restic [command] --help" for more information about a command.

Unmerge

root #emerge --ask --depclean --verbose app-backups/restic

See also

  • dd — a utility used to copy raw data from a source into sink, where source and sink can be a block device, file, or piped input/output.
  • rsnapshot — an automated backup tool based on the rsync protocol and written in Perl.