link🎛 Config File

linkPath

By default autorestic searches for a .autorestic.yml file in the current directory and your home folder.

• ./.autorestic.yml
• ~/.autorestic.yml

You can also specify a custom file with the -c path/to/some/config.yml

⚠️ 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!

linkExample configuration

.autorestic.yml
1linkversion: 2

2link

3linklocations:

4link  home:

5link    from: /home/me

6link    to: remote

7link

8link  important:

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

10link    to:

11link      - remote

12link      - hdd

13link

14linkbackends:

15link  remote:

16link    type: b2

17link    path: 'myBucket:backup/home'

18link    env:

19link      B2_ACCOUNT_ID: account_id

20link      B2_ACCOUNT_KEY: account_key

21link

22link  hdd:

23link    type: local

24link    path: /mnt/my_external_storage

linkAliases

A handy tool for more advanced configurations is to use yaml aliases. These must be specified under the global extras key in the .autorestic.yml config file. Aliases allow to reuse snippets of config throughout the same file.

The following example shows how the locations a and b share the same hooks and forget policies.

.autorestic.yml
1linkversion: 2

2link

3linkextras:

4link  hooks: &foo

5link    backup:

6link      before:

7link        - echo "Hello"

8link      after:

9link        - echo "kthxbye"

10link  policies: &bar

11link    keep-daily: 14

12link    keep-weekly: 52

13link

14linkbackends:

15link  # ...

16linklocations:

17link  a:

18link    from: /data/a

19link    to: some

20link    hooks:

21link      <<: *foo

22link    options:

23link      forget:

24link        <<: *bar

25link  b:

26link    from: data/b

27link    to: some

28link    hooks:

29link      <<: *foo

30link    options:

31link      forget:

32link        <<: *bar