# @xen-orchestra/backups Latest version **0.74.2** (published 2026-09-01) · AGPL-3.0-or-later license · 0 weekly downloads ## Install ```sh npm install @xen-orchestra/backups pnpm add @xen-orchestra/backups yarn add @xen-orchestra/backups bun add @xen-orchestra/backups ``` ## Health **Score 60/100 (C)** — status: active. Positive: esm support; no vulnerabilities; recently updated; high maintenance score. Warnings: low downloads; no types; pre 1.0. ## Facts | | | |---|---| | Version | 0.74.2 | | Published | 2026-09-01 | | First published | 2020-01-08 | | Weekly downloads | 0 | | License | AGPL-3.0-or-later | | TypeScript types | none | | Module format | ESM + CommonJS | | Node | >=14.18 | | Dependencies | 40 | | Unpacked size | 256.4 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 988 | | Author | Vates SAS | | Maintainers | mlssfrncjrg, mathieura, florent.beauchamp, julien-f, marsaud, pdonias, benjireis, tgoettelmann, b-nollet, joris-k, elise-f, olivier.f, pierre.brunet289 | ## Links - npm: https://www.npmjs.com/package/@xen-orchestra/backups - Repository: https://github.com/vatesfr/xen-orchestra - Homepage: https://github.com/vatesfr/xen-orchestra/tree/master/@xen-orchestra/backups - Issues: https://github.com/vatesfr/xen-orchestra/issues - npm.io page: https://npm.io/package/@xen-orchestra/backups ## Dependencies (40) - [ms](https://npm.io/package/ms.md) ^2.1.3 - [tar](https://npm.io/package/tar.md) ^7.5.19 - [uuid](https://npm.io/package/uuid.md) ^9.0.0 - [yazl](https://npm.io/package/yazl.md) ^2.5.1 - [lodash](https://npm.io/package/lodash.md) ^4.18.0 - [vhd-lib](https://npm.io/package/vhd-lib.md) ^4.16.1 - [xen-api](https://npm.io/package/xen-api.md) ^4.9.0 - [app-conf](https://npm.io/package/app-conf.md) ^3.0.0 - [node-zone](https://npm.io/package/node-zone.md) ^0.4.0 - [@iarna/toml](https://npm.io/package/@iarna/toml.md) ^2.2.5 - [@vates/task](https://npm.io/package/@vates/task.md) ^0.7.0 - [parse-pairs](https://npm.io/package/parse-pairs.md) ^2.0.0 - [@vates/types](https://npm.io/package/@vates/types.md) ^2.0.1 - [golike-defer](https://npm.io/package/golike-defer.md) ^0.5.1 - [human-format](https://npm.io/package/human-format.md) ^1.2.0 - [value-matcher](https://npm.io/package/value-matcher.md) ^0.2.0 - [@vates/compose](https://npm.io/package/@vates/compose.md) ^2.1.0 - [d3-time-format](https://npm.io/package/d3-time-format.md) ^4.1.0 - [@vates/fuse-vhd](https://npm.io/package/@vates/fuse-vhd.md) ^2.1.3 - [moment-timezone](https://npm.io/package/moment-timezone.md) ^0.5.46 - [promise-toolbox](https://npm.io/package/promise-toolbox.md) ^0.21.0 - [proper-lockfile](https://npm.io/package/proper-lockfile.md) ^4.1.2 - [compare-versions](https://npm.io/package/compare-versions.md) ^6.0.0 - [@vates/async-each](https://npm.io/package/@vates/async-each.md) ^1.0.3 - [@vates/disposable](https://npm.io/package/@vates/disposable.md) ^0.1.6 - [@vates/nbd-client](https://npm.io/package/@vates/nbd-client.md) ^3.5.1 - [@xen-orchestra/fs](https://npm.io/package/@xen-orchestra/fs.md) ^4.9.3 - [@xen-orchestra/log](https://npm.io/package/@xen-orchestra/log.md) ^0.7.2 - [@vates/decorate-with](https://npm.io/package/@vates/decorate-with.md) ^2.1.0 - [@xen-orchestra/qcow2](https://npm.io/package/@xen-orchestra/qcow2.md) ^1.3.1 - [@vates/parse-duration](https://npm.io/package/@vates/parse-duration.md) ^0.1.1 - [@kldzj/stream-throttle](https://npm.io/package/@kldzj/stream-throttle.md) ^1.1.1 - [decorator-synchronized](https://npm.io/package/decorator-synchronized.md) ^0.6.0 - [@xen-orchestra/template](https://npm.io/package/@xen-orchestra/template.md) ^0.1.1 - [@vates/cached-dns.lookup](https://npm.io/package/@vates/cached-dns.lookup.md) ^1.0.0 - [@vates/generator-toolbox](https://npm.io/package/@vates/generator-toolbox.md) ^1.1.3 - [@xen-orchestra/async-map](https://npm.io/package/@xen-orchestra/async-map.md) ^0.1.4 - [limit-concurrency-decorator](https://npm.io/package/limit-concurrency-decorator.md) ^0.6.0 - [@xen-orchestra/backup-archive](https://npm.io/package/@xen-orchestra/backup-archive.md) ^1.1.2 - [@xen-orchestra/disk-transform](https://npm.io/package/@xen-orchestra/disk-transform.md) ^1.3.3 ## Recent versions - 0.74.2 (latest) — 2026-09-01 - 0.74.1 — 2026-08-28 - 0.74.0 — 2026-08-25 - 0.73.10 — 2026-08-04 - 0.73.9 — 2026-07-29 - 0.73.8 — 2026-07-27 - 0.73.7 — 2026-07-09 - 0.73.6 — 2026-07-07 - 0.73.5 — 2026-06-30 - 0.73.4 — 2026-06-29 - 0.73.3 — 2026-06-24 - 0.73.2 — 2026-06-01 - 0.73.1 — 2026-05-22 - 0.73.0 — 2026-05-22 - 0.72.1 — 2026-04-29 - … 149 more at https://npm.io/package/@xen-orchestra/backups/versions ## README # @xen-orchestra/backups [![Package Version](https://badgen.net/npm/v/@xen-orchestra/backups)](https://npmjs.org/package/@xen-orchestra/backups) ![License](https://badgen.net/npm/license/@xen-orchestra/backups) [![PackagePhobia](https://badgen.net/bundlephobia/minzip/@xen-orchestra/backups)](https://bundlephobia.com/result?p=@xen-orchestra/backups) [![Node compatibility](https://badgen.net/npm/node/@xen-orchestra/backups)](https://npmjs.org/package/@xen-orchestra/backups) ## Install Installation of the [npm package](https://npmjs.org/package/@xen-orchestra/backups): ```sh npm install --save @xen-orchestra/backups ``` ## Usage ## Changing the default backup configuration This library receives a backup configuration from `xo-server` or `xo-proxy`. This configuration is split between multiple properties: - `config` contains values related to the general backup configuration - `config.defaultSettings`, `config.vm.defaultSettings` and `config.metadata.defaultSettings` contain values related to backup jobs default settings: - `config.vm.defaultSettings` is related to VM backup jobs (see [DEFAULT_XAPI_VM_SETTINGS](https://github.com/vatesfr/xen-orchestra/blob/568e14f7eec7c3ddf685d324ad4733a3ef577995/%40xen-orchestra/backups/_runners/VmsRemote.mjs#L15)) - `config.metadata.defaultSettings` is related to metadata backup jobs (see [DEFAULT_METADATA_SETTINGS](https://github.com/vatesfr/xen-orchestra/blob/568e14f7eec7c3ddf685d324ad4733a3ef577995/%40xen-orchestra/backups/_runners/Metadata.mjs#L12)) - `config.defaultSettings` is related to all backup jobs (see [DEFAULT_SETTINGS](https://github.com/vatesfr/xen-orchestra/blob/568e14f7eec7c3ddf685d324ad4733a3ef577995/%40xen-orchestra/backups/_runners/_Abstract.mjs#L7)) - in case of duplicate value, `config.vm.defaultSettings` and `config.metadata.defaultSettings` will prevail over `config.defaultSettings`, and a defined job setting will prevail over any `defaultSettings` ## Contributions Contributions are _very_ welcomed, either on the documentation or on the code. You may: - report any [issue](https://github.com/vatesfr/xen-orchestra/issues) you've encountered; - fork and create a pull request. ## License [AGPL-3.0-or-later](https://spdx.org/licenses/AGPL-3.0-or-later) © [Vates SAS](https://vates.fr) --- _Source: https://npm.io/package/@xen-orchestra/backups · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._