Description #

The local remote places the output of the backup process in a directory on the current machine.

Configuration #

{
  "remotes": [
    {
      "name": "myRemote",
      "type": "LOCAL",
      "location": "/var/backups"
    }
  ],
  "sources": [
    {
      "name": "source-with-inline-local-remote",
      // ...
      "remotes": [
        {
          "type": "LOCAL",
          "location": "/var/backups"
        }
      ]
    },
    {
      "name": "source-with-global-local-remote",
      // ...
      "remotes": [
        "myRemote"
      ]
    }
  ]
}

Available configuration options #

name #

  • required

The name of the source. This has to be a valid identifier.

type #

  • required
  • constant

A constant that tells the engine what kind of remote this object is. This must be set to "LOCAL".

location #

  • required
  • template enabled

The target directory of the generated backups. This must be an absolute path.

disabled #

  • default value

Whether to ignore this source during the backup process. Defaults to false.