Btrbk - Revision history

Klinger: Link to btrfs article

2025-04-30T19:10:50Z

Link to btrfs article

← Older revision		Revision as of 19:10, 30 April 2025
Line 1:		Line 1:
	[https://digint.ch/btrbk/ Btrbk], a tool for creating snapshots and remote backups of btrfs subvolumes.		[https://digint.ch/btrbk/ Btrbk], a tool for creating snapshots and remote backups of [[btrfs]] subvolumes.

	== Setup ==		== Setup ==

Arch is the best: Configure SSH access for remote host

2025-04-27T15:25:33Z

Configure SSH access for remote host

@@ Line 45: / Line 45: @@
      };
    };
 };
 </nowiki>}}

Arch is the best: Remove redundant sudo rules since the NixOS module for btrbk already has those rules (https://github.com/NixOS/nixpkgs/blob/5630cf13cceac06cefe9fc607e8dfa8fb342dde3/nixos/modules/services/backup/btrbk.nix#L66)

2025-04-27T00:34:20Z

Remove redundant sudo rules since the NixOS module for btrbk already has those rules (https://github.com/NixOS/nixpkgs/blob/5630cf13cceac06cefe9fc607e8dfa8fb342dde3/nixos/modules/services/backup/btrbk.nix#L66)

@@ Line 46: / Line 46: @@
    };
 };
 </nowiki>}}

Onny at 15:52, 20 October 2024

2024-10-20T15:52:21Z

← Older revision		Revision as of 15:52, 20 October 2024
Line 80:		Line 80:
	</nowiki>}}		</nowiki>}}

	==== Local <code>/home</code> Snapshots ====		=== Local <code>/home</code> Snapshots ===

	{{Warning\|This is not a backup solution alone. If the entire disk fails, local snapshots will be lost along with it.}}		{{Warning\|This is not a backup solution alone. If the entire disk fails, local snapshots will be lost along with it.}}

Jarrodsfarrell: Correct which man page to use.

2024-10-19T01:44:04Z

Correct which man page to use.

← Older revision		Revision as of 01:44, 19 October 2024
Line 35:		Line 35:
	# "nixos" could instead be an attribute set with other volumes to		# "nixos" could instead be an attribute set with other volumes to
	# back up and to give subvolume specific configuration.		# back up and to give subvolume specific configuration.
	# See man btrbk for possible options.		# See man btrbk.conf for possible options.
	/*		/*
	subvolume = {		subvolume = {

Jarrodsfarrell: Added a section for local /home snapshots—inspired from my systems—and in the previous section points out that subvolume can instead be a attribute set. Carry-over from the unofficial wiki.

2024-10-19T01:42:41Z

Added a section for local /home snapshots—inspired from my systems—and in the previous section points out that subvolume can instead be a attribute set. Carry-over from the unofficial wiki.

@@ Line 33: / Line 33: @@
          target = "ssh://myhost/mnt/mybackups";
          subvolume = "nixos";
        };
      };
@@ Line 69: / Line 78: @@
 environment.systemPackages = [ pkgs.lz4 ];
 </nowiki>}}

Onny: Retention policy

2024-08-14T18:41:43Z

Retention policy

@@ Line 17: / Line 17: @@
 == Configuration ==
 Following example configuration will create a weekly incremental backup of a local Btrfs subvolume called <code>nixos</code> and sends it compressed to the remote host <code>myhost</code>. The mount point <code>/btr_pool</code>, as referenced above, contains the subvolume.
@@ Line 69: / Line 70: @@
 environment.systemPackages = [ pkgs.lz4 ];
 </nowiki>}}
 == Manual usage ==

Onny: Remove unstable notice

2024-05-31T08:09:18Z

Remove unstable notice

← Older revision		Revision as of 08:09, 31 May 2024
Line 37:		Line 37:
	};		};
	</nowiki>}}		</nowiki>}}

	~~{{Note\|Before the release of NixOS 24.05 you'll have to add the corresponding compression tool manually with <code><nowiki>services.btrbk.extraPackages = [ pkgs.lz4 ];</nowiki></code>}}~~

	The user has to be created on the remote host and needs root permissions on the commands <code>btrfs</code>, <code>readlink</code> and <code>test</code>, for example via [[sudo]]. For transport stream compression using <code>lz4</code> to work, the package must also be installed on the target host. The target host configuration for Btrbk could look like this:		The user has to be created on the remote host and needs root permissions on the commands <code>btrfs</code>, <code>readlink</code> and <code>test</code>, for example via [[sudo]]. For transport stream compression using <code>lz4</code> to work, the package must also be installed on the target host. The target host configuration for Btrbk could look like this:

imported>Onny at 10:28, 11 December 2023

2023-12-11T10:28:36Z

← Older revision		Revision as of 10:28, 11 December 2023
Line 38:		Line 38:
	</nowiki>}}		</nowiki>}}

	{{Note\|Before the release of NixOS 24.05 you'll have to add the corresponding compression tool manually with `services.btrbk.extraPackages = [ pkgs.lz4 ];`}}		{{Note\|Before the release of NixOS 24.05 you'll have to add the corresponding compression tool manually with <code><nowiki>services.btrbk.extraPackages = [ pkgs.lz4 ];</nowiki></code>}}

	The user has to be created on the remote host and needs root permissions on the commands <code>btrfs</code>, <code>readlink</code> and <code>test</code>, for example via [[sudo]]. For transport stream compression using <code>lz4</code> to work, the package must also be installed on the target host. The target host configuration for Btrbk could look like this:		The user has to be created on the remote host and needs root permissions on the commands <code>btrfs</code>, <code>readlink</code> and <code>test</code>, for example via [[sudo]]. For transport stream compression using <code>lz4</code> to work, the package must also be installed on the target host. The target host configuration for Btrbk could look like this:

imported>Onny: Update example setup reflecting latest module changes

2023-12-11T10:24:03Z

Update example setup reflecting latest module changes

← Older revision		Revision as of 10:24, 11 December 2023
Line 23:		Line 23:
	{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>		{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>
	services.btrbk = {		services.btrbk = {
	~~extraPackages = [ pkgs.lz4 ];~~
	instances."remote_myhost" = {		instances."remote_myhost" = {
	onCalendar = "weekly";		onCalendar = "weekly";
Line 38:		Line 37:
	};		};
	</nowiki>}}		</nowiki>}}

			{{Note\|Before the release of NixOS 24.05 you'll have to add the corresponding compression tool manually with `services.btrbk.extraPackages = [ pkgs.lz4 ];`}}

	The user has to be created on the remote host and needs root permissions on the commands <code>btrfs</code>, <code>readlink</code> and <code>test</code>, for example via [[sudo]]. For transport stream compression using <code>lz4</code> to work, the package must also be installed on the target host. The target host configuration for Btrbk could look like this:		The user has to be created on the remote host and needs root permissions on the commands <code>btrfs</code>, <code>readlink</code> and <code>test</code>, for example via [[sudo]]. For transport stream compression using <code>lz4</code> to work, the package must also be installed on the target host. The target host configuration for Btrbk could look like this: