This software requires a D-Bus policy file installed, to claim a name on the bus. Please refer to your distribution's documentation on how to properly install D-Bus policies.
Assuming igotchuu is a flake reference to this repository.
This also allows to manage igotchuu's config using NixOS and run backups from systemd timers.
{ config, pkgs, lib, ... }: {
imports = [ igotchuu.nixosModules.default ];
services.igotchuu = {
enable = true;
settings = {
places = [ "/home" "/var/lib" ];
restic_backup_args = [
"-x" "--exclude-caches"
];
repo = "sftp://example.com/backups";
password_file = "/root/restic-password";
};
# Default is to run daily backups at midnight.
# Use `timerConfig` to change that.
timerConfig = {
OnCalendar = "weekly";
};
};
}This software makes several assumptions about your system installation, particularly the filesystem organization:
/is a Btrfs filesystem/subvolume/homeis a Btrfs subvolume on the same filesystem as/
The algorithm of this script is as follows:
unsharethe mount namespace- Create a btrfs snapshot of
/home - Bind-mount
/home-<snapshot date>to/home - Run
resticon/home
The config file is a TOML file. Example:
# Executes a command before creating snapshots.
# This is useful if your / is on a tmpfs, and stateful data is on btrfs,
# and you need to mount your subvolume somewhere to create snapshots.
exec_before_snapshot = ["mount", "/dev/mapper/root", "/mnt", "-o", "subvol=5"]
# Prepends a prefix to all snapshot paths. This is useful if you want your
# snapshots to be contained elsewhere. This must not have a trailing slash.
snapshot_prefix = "/mnt/snapshots"
# Places you want to back up.
places = ["/home", "/var/lib"]
# Arguments that will be passed to `restic backup`.
#
# `--one-file-system` is heavily recommended due to how igotchuu works with
# subvolumes. In theory, if you need to back up a tree composed of several
# filesystems, you should be able to list them all in `places` so they will
# also be snapshotted.
restic_backup_args = [
"--one-file-system", "--exclude-caches",
"--exclude-file=/etc/igotchuu/exclude.txt"
]
# Arguments for backup target.
repo = "sftp://your.host/folder"
# or:
repository_file = "/root/restic-target"
password_file = "/root/restic-password"
# or:
password_command = "pass show restic"
# Snapshots that will be created and bind-mounted over your root hierarchy.
# If not set, defaults to the value of `places`.
#
# Snapshotting all backup locations is heavily recommended to ensure
# consistency of backups. It is surprising that restic only includes this
# functionality on Windows.
#
# Note that the paths in `source` must be absolute.
#
# Creates a snapshot with the same name and a timestamp appended.
[[snapshot]]
source = "/home"
# Creates a snapshot with a different name (and a timestamp).
# This is useful sometimes.
[[snapshot]]
source = "/var/lib"
# Override the location for the snapshot. `snapshot_prefix` will not be used.
# However, a timestamp will still be appended to the snapshot name.
snapshot_location = "/var-lib"
This software can be controlled via D-Bus, to receive progress updates and stop an ongoing backup.
<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node name="/com/nyantec/igotchuu">
<interface name="com.nyantec.igotchuu1">
<method name="Stop"></method>
<signal name="BackupStarted"></signal>
<!-- Signal payload mirrors structs found in Restic's source code
https://github.com/restic/restic/blob/master/internal/ui/backup/json.go
-->
<signal name="Progress">
<arg name="seconds_elapsed" type="t" /> <!-- uint64 -->
<arg name="seconds_remaining" type="t" />
<arg name="percent_done" type="d" /> <!-- float64 -->
<arg name="total_files" type="t" />
<arg name="files_done" type="t" />
<arg name="total_bytes" type="t" />
<arg name="bytes_done" type="t" />
<arg name="error_count" type="t" /> <!-- uint -->
<arg name="current_files" type="as" /> <!-- []string -->
</signal>
<signal name="BackupComplete">
<arg name="files_new" type="t" />
<arg name="files_changed" type="t" />
<arg name="files_unmodified" type="t" />
<arg name="dirs_new" type="t" />
<arg name="dirs_changed" type="t" />
<arg name="dirs_unmodified" type="t" />
<arg name="data_blobs" type="x" /> <!-- int -->
<arg name="tree_blobs" type="x" />
<arg name="data_added" type="t" />
<arg name="total_files_processed" type="t" />
<arg name="total_bytes_processed" type="t" />
<arg name="total_duration" type="d" />
<arg name="snapshot_id" type="s" /> <!-- string -->
<arg name="dry_run" type="b" /> <!-- bool -->
</signal>
<signal name="Error">
<arg name="error" type="s" /> <!-- error -->
<arg name="during" type="s" />
<arg name="item" type="s" />
</signal>
</interface>
</node>- Make restic invocation arguments configurable
- Consider using
btrfsutilPython package instead of shelling out - Consider abstracting filesystem snapshotting and preparation
- Handle cases where
/is atmpfsand/homeis a btrfs subvolume- snapshot locations can be overridden using
snapshot_locationconfig option, to save snapshots under a different directory exec_before_snapshotruns in the target mount namespace, this can be used to mount a btrfs subvolume for snapshot storage
- snapshot locations can be overridden using
- Consider allowing running a subprocess to prepare the filesystem
- Handle ZFS subvolumes
- Handle cases where
- Make signals carry typed data instead of JSON strings
- Consider running as a daemon, to allow for triggering on-demand backups
- Is this really needed with systemd services?
- Consider providing an example systemd service configuration
- Consider creating a GUI to monitor backup progress instead of relying on logs and manually reading the firehose it outputs to D-Bus