victoriametrics/vmrestore repository overview

⁠vmrestore

⁠What is vmrestore?

vmrestore is a command-line tool for managing the lifecycle of your VictoriaMetrics data. It downloads a backup from storage and restores it to a VictoriaMetrics data directory.

⁠How to Use This Image

⁠Restoring from a Backup

To restore data from a backup, ensure VictoriaMetrics is stopped first, then run the following command:

sh
docker run --rm -v /path/to/backups:/backups -v /path/to/vmdata:/restore\
  victoriametrics/vmrestore:latest\
  -src=fs:///backups/<backup-name>\
  -dst=/restore

⁠Configuration

vmrestore can be configured using command-line flags.

• -src: The source of the backup to restore from. Supported schemes are fs, gcs, s3, azblob.

• -dst: The target VictoriaMetrics data directory to restore to.

For a full list of flags, run the image with the --help flag.

⁠Where to Get Help

If you have any questions or need assistance, please reach out to our community.

• Slack: Join our community Slack⁠ for announcements and discussions.

• Community Forum: Ask questions on our community forum⁠.

• Bug Reports: File a bug report on GitHub⁠ if you find an issue.

⁠Source Code

vmrestore is an open-source project. The source code is available on GitHub:

• vmrestore: https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/app/vmrestore⁠ Utility for restoring VictoriaMetrics data from backups. See these docs⁠ for details. See also vmbackup⁠.

Docker Pull Command

docker pull victoriametrics/vmrestore:{TAG}

Releases and pre-built binaries⁠.