Restic Documentation

• Introduction
  • Quickstart Guide
• Installation
  • Packages
  • Official Binaries
  • Docker Container
  • From Source
  • Autocompletion
• Preparing a new repository
  • Local
  • SFTP
  • REST Server
  • Amazon S3
  • Minio Server
  • S3-compatible Storage
  • Wasabi
  • Alibaba Cloud (Aliyun) Object Storage System (OSS)
  • OpenStack Swift
  • Backblaze B2
  • Microsoft Azure Blob Storage
  • Google Cloud Storage
  • Other Services via rclone
  • Password prompt on Windows
  • Group accessible repositories
  • Repositories with empty password
• Backing up
  • File change detection
  • Skip creating snapshots if unchanged
  • Dry Runs
  • Excluding Files
  • Including Files
  • Comparing Snapshots
  • Backing up special items and metadata
  • Reading data from a command
  • Reading data from stdin
  • Tags for backup
  • Scheduling backups
  • Space requirements
  • Exit status codes
  • Environment Variables
• Working with repositories
  • Listing all snapshots
  • Listing files in a snapshot
  • Copying snapshots between repositories
  • Removing files from snapshots
  • Modifying metadata of snapshots
  • Checking integrity and consistency
  • Upgrading the repository format version
• Tuning Backup Parameters
  • Disabling Backup Progress Estimation
  • Backend Connections
  • CPU Usage
  • Compression
  • Data Verification
  • File Read Concurrency
  • Pack Size
  • Feature Flags
• Restoring from backup
  • Restoring from a snapshot
  • Restore using mount
  • Printing files to stdout
• Removing backup snapshots
  • Remove a single snapshot
  • Removing snapshots according to a policy
  • Customize pruning
  • Recovering from “no free space” errors
• Encryption
  • Manage repository keys
• Scripting
  • Check if a repository is already initialized
  • Exit codes
  • JSON output
• Troubleshooting
  • 1. Find out what is damaged
  • 2. Backup the repository
  • 3. Repair the index
  • 4. Run all backups (optional)
  • 5. Remove missing data from snapshots
  • 6. Check the repository again
• Examples
  • Setting up restic with Amazon S3
  • Backing up your system without running restic as root
• Participating
  • Debug Logs
  • Debugging
  • Contributing
  • Security
  • Compatibility
  • Building documentation
• References
  • Design
  • Local Cache
  • REST Backend
• Talks
• FAQ
  • Will restic resume an interrupted backup?
  • restic check reports packs that aren’t referenced in any index, is my repository broken?
  • I ran a restic command but it is not working as intended, what do I do now?
  • How can I specify encryption passwords automatically?
  • How to prioritize restic’s IO and CPU time
  • Creating new repository on a Synology NAS via sftp fails
  • Why does restic perform so poorly on Windows?
  • How do I choose a strong password?
  • Restic backup command fails to find a valid file in Windows
  • What can I do in case of “request timeout” errors?
• Manual
  • Usage help
  • Manage tags
  • Under the hood
  • Scripting
  • Temporary files
  • Caching
• Developer Information
  • Reproducible Builds
  • Building the Official Binaries
  • Verifying the Official Binaries
  • Prepare a New Release