link🚀 Quickstart

linkInstallation

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

See installation for alternative options.

linkWrite a simple config file

1link$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 redundancy.
• One backend can also be the target for multiple locations.

⚠️ WARNING ⚠️

Note that the data is automatically encrypted on the server. The key will be generated and added to your config file. Every backend will have a separate key. You should keep a copy of the keys or config file somewhere in case your server dies. Otherwise DATA IS LOST!

.autorestic.yml
1linklocations:

2link  home:

3link    from: /home/me

4link    to: remote

5link

6link  important:

7link    from: /path/to/important/stuff

8link    to:

9link      - remote

10link      - hdd

11link

12linkbackends:

13link  remote:

14link    type: s3

15link    path: 's3.amazonaws.com/bucket_name'

16link    key: some-random-password-198rc79r8y1029c8yfewj8f1u0ef87yh198uoieufy

17link    env:

18link      AWS_ACCESS_KEY_ID: account_id

19link      AWS_SECRET_ACCESS_KEY: account_key

20link

21link  hdd:

22link    type: local

23link    path: /mnt/my_external_storage

24link    key: 'if not key is set it will be generated for you'

linkCheck

1link$autorestic check

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.

Now is good time to backup the config. After you run autorestic at least once we will add the generated encryption keys to the config.

linkBackup

1link$autorestic backup -a

This will do a backup of all locations.

linkRestore

1link$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.