autorestic/docs/md/quick.md

1.3 KiB

🚀 Quickstart

Installation

curl -s https://raw.githubusercontent.com/CupCakeArmy/autorestic/master/install.sh | bash

Write a simple config file

vim .autorestic.yml

For a quick overview:

  • locations can be seen as the inputs and backends the output where the data is stored and backed up.
  • One location can have one or multiple backends for redudancy.
  • One backend can also be the target for multiple locations
locations:
  home:
    from: /home/me
    to: remote

  important:
    from: /path/to/important/stuff
    to:
      - remote
      - hdd

backends:
  remote:
    type: s3
    path: 's3.amazonaws.com/bucket_name'
    AWS_ACCESS_KEY_ID: account_id
    AWS_SECRET_ACCESS_KEY: account_key

  hdd:
    type: local
    path: /mnt/my_external_storage

Check [Optional]

autorestic check -a

This checks if the config file has any issues. If this is the first time this can take longer as autorestic will setup the backends.

Backup

autorestic backup -a

This will do a backup of all locations.

Restore

autorestic restore -l home --from hdd --to /path/where/to/restore

This will restore the location home from the backend hdd to the given path.

:ToCPrevNext