link🚀 Quickstart

linkInstallation

1link$wget -qO - 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
1linkversion: 2

2link

3linklocations:

4link  home:

5link    from: /home

6link    # Or multiple

7link    # from:

8link    #  - /foo

9link    #  - /bar

10link    to: remote

11link

12link  important:

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

14link    to:

15link      - remote

16link      - hdd

17link

18linkbackends:

19link  remote:

20link    type: s3

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

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

23link    env:

24link      AWS_ACCESS_KEY_ID: account_id

25link      AWS_SECRET_ACCESS_KEY: account_key

26link

27link  hdd:

28link    type: local

29link    path: /mnt/my_external_storage

30link    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.