From 5a5b6491ac83d96f3cc962f37376bb35297722e2 Mon Sep 17 00:00:00 2001 From: Dan Helfman Date: Mon, 4 Mar 2019 15:15:49 -0800 Subject: [PATCH] Add note about uncommenting section names. --- docs/how-to/set-up-backups.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/how-to/set-up-backups.md b/docs/how-to/set-up-backups.md index 5aa6765..c9cf937 100644 --- a/docs/how-to/set-up-backups.md +++ b/docs/how-to/set-up-backups.md @@ -45,9 +45,14 @@ not in your system `PATH`. Try looking in `/usr/local/bin/`. This generates a sample configuration file at /etc/borgmatic/config.yaml (by default). You should edit the file to suit your needs, as the values are -representative. All fields are optional except where indicated, so feel free +representative. All options are optional except where indicated, so feel free to ignore anything you don't need. +Note that the configuration file is organized into distinct sections, each +with a section name like `location:` or `storage:`. So take care that if you +uncomment a particular option, also uncomment its containing section name, or +else borgmatic won't recognize the option. + You can also get the same sample configuration file from the [configuration reference](../../docs/reference/configuration.md), the authoritative set of all configuration options. This is handy if borgmatic has added new options @@ -71,6 +76,9 @@ FAQ](http://borgbackup.readthedocs.io/en/stable/faq.html#how-can-i-specify-the-e for more info. +### + + ## Initialization Before you can create backups with borgmatic, you first need to initialize a