sneak
64c31f890b
check / check (push) Successful in 11m11s
snapshot verify --help now says --deep needs the age private key, from VAULTIK_AGE_SECRET_KEY or age_secret_key, as snapshot restore does. Both now name the config key as well as the environment variable. The help of snapshot create, list, purge, remove, prune, remote info and remote nuke says which access to the destination it needs. config.example.yml gains age_secret_key, and no longer tells the reader to pipe age-keygen into grep, which discards the private key. Only help strings and comments change. Model: fable-5-1
370 lines
14 KiB
YAML
370 lines
14 KiB
YAML
# vaultik configuration file example
|
|
# This file shows every configuration option. The values are examples, not
|
|
# defaults; where an option has a default, its comment gives it.
|
|
# Copy this file and change the values you need
|
|
|
|
# Age recipient public keys for encryption
|
|
# Backups are encrypted to these public keys. snapshot create needs at least
|
|
# one; listing, verifying and restoring do not
|
|
# Generate a key pair, and show its public key, with:
|
|
# age-keygen -o vaultik_backup_private_key.txt
|
|
# grep 'public key' vaultik_backup_private_key.txt
|
|
# Keep the private key file: restoring needs it. Do not pipe age-keygen
|
|
# straight into grep, which would discard the private key
|
|
age_recipients:
|
|
- age1cj2k2addawy294f6k2gr2mf9gps9r3syplryxca3nvxj3daqm96qfp84tz
|
|
|
|
# Age private key for decryption
|
|
# Only snapshot restore and snapshot verify --deep need it. The
|
|
# VAULTIK_AGE_SECRET_KEY environment variable overrides this setting
|
|
# Do not set it on a machine you back up: prefer the environment variable,
|
|
# supplied only on the machine you restore on
|
|
# Default: not set
|
|
#age_secret_key: YOUR_AGE_PRIVATE_KEY
|
|
|
|
# Named snapshots - each snapshot can contain multiple paths
|
|
# Each snapshot gets its own ID and can have snapshot-specific excludes
|
|
# Required: every command needs at least one snapshot with at least one path
|
|
snapshots:
|
|
testing:
|
|
paths:
|
|
- ~/dev/vaultik
|
|
apps:
|
|
paths:
|
|
- /Applications
|
|
exclude:
|
|
- "/App Store.app"
|
|
- "/Apps.app"
|
|
- "/Automator.app"
|
|
- "/Books.app"
|
|
- "/Calculator.app"
|
|
- "/Calendar.app"
|
|
- "/Chess.app"
|
|
- "/Clock.app"
|
|
- "/Contacts.app"
|
|
- "/Dictionary.app"
|
|
- "/FaceTime.app"
|
|
- "/FindMy.app"
|
|
- "/Font Book.app"
|
|
- "/Freeform.app"
|
|
- "/Games.app"
|
|
- "/GarageBand.app"
|
|
- "/Home.app"
|
|
- "/Image Capture.app"
|
|
- "/Image Playground.app"
|
|
- "/Journal.app"
|
|
- "/Keynote.app"
|
|
- "/Mail.app"
|
|
- "/Maps.app"
|
|
- "/Messages.app"
|
|
- "/Mission Control.app"
|
|
- "/Music.app"
|
|
- "/News.app"
|
|
- "/Notes.app"
|
|
- "/Numbers.app"
|
|
- "/Pages.app"
|
|
- "/Passwords.app"
|
|
- "/Phone.app"
|
|
- "/Photo Booth.app"
|
|
- "/Photos.app"
|
|
- "/Podcasts.app"
|
|
- "/Preview.app"
|
|
- "/QuickTime Player.app"
|
|
- "/Reminders.app"
|
|
- "/Safari.app"
|
|
- "/Shortcuts.app"
|
|
- "/Siri.app"
|
|
- "/Stickies.app"
|
|
- "/Stocks.app"
|
|
- "/System Settings.app"
|
|
- "/TV.app"
|
|
- "/TextEdit.app"
|
|
- "/Time Machine.app"
|
|
- "/Tips.app"
|
|
- "/Utilities/Activity Monitor.app"
|
|
- "/Utilities/AirPort Utility.app"
|
|
- "/Utilities/Audio MIDI Setup.app"
|
|
- "/Utilities/Bluetooth File Exchange.app"
|
|
- "/Utilities/Boot Camp Assistant.app"
|
|
- "/Utilities/ColorSync Utility.app"
|
|
- "/Utilities/Console.app"
|
|
- "/Utilities/Digital Color Meter.app"
|
|
- "/Utilities/Disk Utility.app"
|
|
- "/Utilities/Grapher.app"
|
|
- "/Utilities/Magnifier.app"
|
|
- "/Utilities/Migration Assistant.app"
|
|
- "/Utilities/Print Center.app"
|
|
- "/Utilities/Screen Sharing.app"
|
|
- "/Utilities/Screenshot.app"
|
|
- "/Utilities/Script Editor.app"
|
|
- "/Utilities/System Information.app"
|
|
- "/Utilities/Terminal.app"
|
|
- "/Utilities/VoiceOver Utility.app"
|
|
- "/VoiceMemos.app"
|
|
- "/Weather.app"
|
|
- "/iMovie.app"
|
|
- "/iPhone Mirroring.app"
|
|
home:
|
|
paths:
|
|
- "~"
|
|
exclude:
|
|
- "/.Trash"
|
|
- "/tmp"
|
|
- "/Library/Caches"
|
|
- "/Library/Accounts"
|
|
- "/Library/AppleMediaServices"
|
|
- "/Library/Application Support/AddressBook"
|
|
- "/Library/Application Support/CallHistoryDB"
|
|
- "/Library/Application Support/CallHistoryTransactions"
|
|
- "/Library/Application Support/DifferentialPrivacy"
|
|
- "/Library/Application Support/FaceTime"
|
|
- "/Library/Application Support/FileProvider"
|
|
- "/Library/Application Support/Knowledge"
|
|
- "/Library/Application Support/com.apple.TCC"
|
|
- "/Library/Application Support/com.apple.avfoundation/Frecents"
|
|
- "/Library/Application Support/com.apple.sharedfilelist"
|
|
- "/Library/Assistant/SiriVocabulary"
|
|
- "/Library/Autosave Information"
|
|
- "/Library/Biome"
|
|
- "/Library/ContainerManager"
|
|
- "/Library/Containers/com.apple.Home"
|
|
- "/Library/Containers/com.apple.Maps/Data/Maps"
|
|
- "/Library/Containers/com.apple.MobileSMS"
|
|
- "/Library/Containers/com.apple.Notes"
|
|
- "/Library/Containers/com.apple.Safari"
|
|
- "/Library/Containers/com.apple.Safari.WebApp"
|
|
- "/Library/Containers/com.apple.VoiceMemos"
|
|
- "/Library/Containers/com.apple.archiveutility"
|
|
- "/Library/Containers/com.apple.corerecents.recentsd/Data/Library/Recents"
|
|
- "/Library/Containers/com.apple.mail"
|
|
- "/Library/Containers/com.apple.news"
|
|
- "/Library/Containers/com.apple.stocks"
|
|
- "/Library/Cookies"
|
|
- "/Library/CoreFollowUp"
|
|
- "/Library/Daemon Containers"
|
|
- "/Library/DoNotDisturb"
|
|
- "/Library/DuetExpertCenter"
|
|
- "/Library/Group Containers/com.apple.Home.group"
|
|
- "/Library/Group Containers/com.apple.MailPersonaStorage"
|
|
- "/Library/Group Containers/com.apple.PreviewLegacySignaturesConversion"
|
|
- "/Library/Group Containers/com.apple.bird"
|
|
- "/Library/Group Containers/com.apple.stickersd.group"
|
|
- "/Library/Group Containers/com.apple.systempreferences.cache"
|
|
- "/Library/Group Containers/group.com.apple.AppleSpell"
|
|
- "/Library/Group Containers/group.com.apple.ArchiveUtility.PKSignedContainer"
|
|
- "/Library/Group Containers/group.com.apple.DeviceActivity"
|
|
- "/Library/Group Containers/group.com.apple.Journal"
|
|
- "/Library/Group Containers/group.com.apple.ManagedSettings"
|
|
- "/Library/Group Containers/group.com.apple.PegasusConfiguration"
|
|
- "/Library/Group Containers/group.com.apple.Safari.SandboxBroker"
|
|
- "/Library/Group Containers/group.com.apple.SiriTTS"
|
|
- "/Library/Group Containers/group.com.apple.UserNotifications"
|
|
- "/Library/Group Containers/group.com.apple.VoiceMemos.shared"
|
|
- "/Library/Group Containers/group.com.apple.accessibility.voicebanking"
|
|
- "/Library/Group Containers/group.com.apple.amsondevicestoraged"
|
|
- "/Library/Group Containers/group.com.apple.appstoreagent"
|
|
- "/Library/Group Containers/group.com.apple.calendar"
|
|
- "/Library/Group Containers/group.com.apple.chronod"
|
|
- "/Library/Group Containers/group.com.apple.contacts"
|
|
- "/Library/Group Containers/group.com.apple.controlcenter"
|
|
- "/Library/Group Containers/group.com.apple.corerepair"
|
|
- "/Library/Group Containers/group.com.apple.coreservices.useractivityd"
|
|
- "/Library/Group Containers/group.com.apple.energykit"
|
|
- "/Library/Group Containers/group.com.apple.feedback"
|
|
- "/Library/Group Containers/group.com.apple.feedbacklogger"
|
|
- "/Library/Group Containers/group.com.apple.findmy.findmylocateagent"
|
|
- "/Library/Group Containers/group.com.apple.iCloudDrive"
|
|
- "/Library/Group Containers/group.com.apple.icloud.fmfcore"
|
|
- "/Library/Group Containers/group.com.apple.icloud.fmipcore"
|
|
- "/Library/Group Containers/group.com.apple.icloud.searchpartyuseragent"
|
|
- "/Library/Group Containers/group.com.apple.liveactivitiesd"
|
|
- "/Library/Group Containers/group.com.apple.loginwindow.persistent-apps"
|
|
- "/Library/Group Containers/group.com.apple.mail"
|
|
- "/Library/Group Containers/group.com.apple.mlhost"
|
|
- "/Library/Group Containers/group.com.apple.moments"
|
|
- "/Library/Group Containers/group.com.apple.news"
|
|
- "/Library/Group Containers/group.com.apple.newsd"
|
|
- "/Library/Group Containers/group.com.apple.notes"
|
|
- "/Library/Group Containers/group.com.apple.notes.import"
|
|
- "/Library/Group Containers/group.com.apple.photolibraryd.private"
|
|
- "/Library/Group Containers/group.com.apple.portrait.BackgroundReplacement"
|
|
- "/Library/Group Containers/group.com.apple.printtool"
|
|
- "/Library/Group Containers/group.com.apple.private.translation"
|
|
- "/Library/Group Containers/group.com.apple.reminders"
|
|
- "/Library/Group Containers/group.com.apple.replicatord"
|
|
- "/Library/Group Containers/group.com.apple.scopedbookmarkagent"
|
|
- "/Library/Group Containers/group.com.apple.secure-control-center-preferences"
|
|
- "/Library/Group Containers/group.com.apple.sharingd"
|
|
- "/Library/Group Containers/group.com.apple.shortcuts"
|
|
- "/Library/Group Containers/group.com.apple.siri.inference"
|
|
- "/Library/Group Containers/group.com.apple.siri.referenceResolution"
|
|
- "/Library/Group Containers/group.com.apple.siri.remembers"
|
|
- "/Library/Group Containers/group.com.apple.siri.userfeedbacklearning"
|
|
- "/Library/Group Containers/group.com.apple.spotlight"
|
|
- "/Library/Group Containers/group.com.apple.stocks"
|
|
- "/Library/Group Containers/group.com.apple.stocks-news"
|
|
- "/Library/Group Containers/group.com.apple.studentd"
|
|
- "/Library/Group Containers/group.com.apple.swtransparency"
|
|
- "/Library/Group Containers/group.com.apple.telephonyutilities.callservicesd"
|
|
- "/Library/Group Containers/group.com.apple.tips"
|
|
- "/Library/Group Containers/group.com.apple.tipsnext"
|
|
- "/Library/Group Containers/group.com.apple.transparency"
|
|
- "/Library/Group Containers/group.com.apple.usernoted"
|
|
- "/Library/Group Containers/group.com.apple.weather"
|
|
- "/Library/HomeKit"
|
|
- "/Library/IdentityServices"
|
|
- "/Library/IntelligencePlatform"
|
|
- "/Library/Mail"
|
|
- "/Library/Messages"
|
|
- "/Library/Metadata/CoreSpotlight"
|
|
- "/Library/Metadata/com.apple.IntelligentSuggestions"
|
|
- "/Library/PersonalizationPortrait"
|
|
- "/Library/Safari"
|
|
- "/Library/Sharing"
|
|
- "/Library/Shortcuts"
|
|
- "/Library/StatusKit"
|
|
- "/Library/Suggestions"
|
|
- "/Library/Trial"
|
|
- "/Library/Weather"
|
|
- "/Library/com.apple.aiml.instrumentation"
|
|
- "/Movies/TV"
|
|
system:
|
|
paths:
|
|
- /
|
|
exclude:
|
|
# Virtual/transient filesystems
|
|
- /proc
|
|
- /sys
|
|
- /dev
|
|
- /run
|
|
- /tmp
|
|
- /var/tmp
|
|
- /var/run
|
|
- /var/lock
|
|
- /var/cache
|
|
- /media
|
|
- /mnt
|
|
# Swap
|
|
- /swapfile
|
|
- /swap.img
|
|
# Package manager caches
|
|
- /var/cache/apt
|
|
- /var/cache/yum
|
|
- /var/cache/dnf
|
|
- /var/cache/pacman
|
|
# Trash
|
|
- "*/.local/share/Trash"
|
|
dev:
|
|
paths:
|
|
- /Users/user/dev
|
|
exclude:
|
|
- "**/node_modules"
|
|
- "**/target"
|
|
- "**/build"
|
|
- "**/__pycache__"
|
|
- "**/*.pyc"
|
|
- "**/.venv"
|
|
- "**/vendor"
|
|
|
|
# Global patterns to exclude from all backups
|
|
exclude:
|
|
- "*.tmp"
|
|
|
|
# Storage URL - use either this OR the s3 section below
|
|
# Supports: s3://bucket/prefix, file:///path, rclone://remote/path
|
|
# An s3:// URL also needs s3.access_key_id and s3.secret_access_key below
|
|
# A file:// path must be absolute, and the directory must already exist:
|
|
# vaultik never creates it
|
|
# An rclone:// URL needs the remote to be defined in rclone's own config
|
|
# (rclone config)
|
|
storage_url: "rclone://myremote/path/to/backups"
|
|
|
|
# S3-compatible storage configuration
|
|
#s3:
|
|
# # S3-compatible endpoint URL
|
|
# # Examples: https://s3.amazonaws.com, https://storage.googleapis.com
|
|
# endpoint: https://s3.example.com
|
|
#
|
|
# # Bucket name where backups will be stored
|
|
# bucket: mybucket
|
|
#
|
|
# # Prefix (folder) within the bucket for this host's backups
|
|
# # Useful for organizing backups from multiple hosts
|
|
# # Default: empty (root of bucket)
|
|
# #prefix: "hosts/myserver/"
|
|
#
|
|
# # S3 access credentials
|
|
# access_key_id: YOUR_ACCESS_KEY
|
|
# secret_access_key: YOUR_SECRET_KEY
|
|
#
|
|
# # S3 region
|
|
# # Default: us-east-1
|
|
# #region: us-east-1
|
|
#
|
|
# # Use SSL/TLS for S3 connections
|
|
# # Only read when storage_url is not set and the endpoint has no scheme;
|
|
# # with an s3:// storage_url, use ?ssl=false in the URL instead
|
|
# # Default: true
|
|
# #use_ssl: true
|
|
#
|
|
# # Part size for multipart uploads
|
|
# # Minimum 5MiB, maximum 5GiB; affects memory usage during upload
|
|
# # A blob too large for 10,000 parts of this size gets larger parts
|
|
# # Supports: 10MB, 16MiB, 100MiB, etc. (5MB is below the minimum)
|
|
# # Default: 5MiB
|
|
# #part_size: 5MiB
|
|
|
|
# Path to local SQLite index database
|
|
# This database tracks file state for incremental backups
|
|
# The VAULTIK_INDEX_PATH environment variable overrides this setting
|
|
# Default: the platform data directory, e.g.
|
|
# macOS: ~/Library/Application Support/vaultik/index.sqlite
|
|
# Linux: ~/.local/share/vaultik/index.sqlite
|
|
#index_path: /path/to/index.sqlite
|
|
|
|
# Average chunk size for content-defined chunking
|
|
# Smaller chunks = better deduplication but more metadata
|
|
# Minimum 1MB
|
|
# Supports: 10MB, 5M, 1GB, 64MiB, etc.
|
|
# Default: 10MB
|
|
#chunk_size: 10MB
|
|
|
|
# Maximum blob size
|
|
# Multiple chunks are packed into blobs up to this size
|
|
# Must be at least four times chunk_size (the largest chunk the chunker can
|
|
# emit); a smaller limit would let a single-chunk blob exceed it.
|
|
# Chunking uses no secret (the FastCDC parameters are fixed and public). At a
|
|
# large limit a blob holds hundreds of chunks, so individual chunk lengths are
|
|
# not visible in its size; lowering the limit toward chunk_size exposes them.
|
|
# A backup needs free temporary space, because each blob is written whole to
|
|
# a temporary file before it is uploaded (up to about blob_size_limit; an
|
|
# rclone destination that cannot stream uploads needs about twice that) and
|
|
# the metadata export writes copies of the local index. Temporary files go to
|
|
# $TMPDIR (default /tmp); with TMPDIR unset, SQLite writes one of those copies
|
|
# to /var/tmp.
|
|
# Supports: 1GB, 10G, 500MB, 1GiB, etc.
|
|
# Default: 10GB
|
|
#blob_size_limit: 10GB
|
|
|
|
# Compression level (1-19)
|
|
# Higher = better compression but slower
|
|
# Default: 3
|
|
compression_level: 5
|
|
|
|
# How old a blob that no snapshot lists must be before prune deletes it, and
|
|
# how old every object in a directory under metadata/ with no manifest must
|
|
# be before prune deletes that directory
|
|
# A backup uploads its blobs and its db.zst.age before its manifest, so on a
|
|
# destination shared between hosts or users this must be longer than the
|
|
# longest backup run
|
|
# It does not protect a blob a backup reuses from an earlier run that stopped
|
|
# before its manifest: that blob keeps the time of its first upload, so a
|
|
# prune can delete it
|
|
# Supports: 36h, 90m, etc.; 0s deletes such blobs and directories at once
|
|
# Default: 24h
|
|
#prune_grace_period: 24h
|
|
|
|
# Hostname to use in backup metadata
|
|
# Default: system hostname
|
|
#hostname: myserver
|