Borg backup - Revision history

Phobos: Minor grammar corrections

2025-10-01T22:38:54Z

Minor grammar corrections

← Older revision		Revision as of 22:38, 1 October 2025
Line 3:		Line 3:
	This wiki article extends the documentation in the [https://nixos.org/manual/nixos/stable/#module-borgbase NixOS manual].		This wiki article extends the documentation in the [https://nixos.org/manual/nixos/stable/#module-borgbase NixOS manual].

	~~Its~~ easier to take the first steps with Borg ~~with~~ using a GUI - information about Vorta is also in the [https://nixos.org/manual/nixos/stable/#opt-services-backup-borgbackup-vorta NixOS manual].		It's easier to take the first steps with Borg by using a GUI - information about Vorta may also be found in the [https://nixos.org/manual/nixos/stable/#opt-services-backup-borgbackup-vorta NixOS manual].

	<syntaxHighlight lang=bash>		<syntaxHighlight lang=bash>
Line 9:		Line 9:
	</syntaxHighlight>		</syntaxHighlight>

	To be able to do remote backups it should be installed both locally and remotely, but usually no remote configuration required, only local one.		To be able to do remote backups it should be installed both locally and remotely, but usually no remote configuration required, only a local one.

	== Creating backups ==		== Creating backups ==

Klinger: A sentence about the Vorta client for Borg.

2025-03-25T21:35:57Z

A sentence about the Vorta client for Borg.

← Older revision		Revision as of 21:35, 25 March 2025
Line 1:		Line 1:
	[https://www.borgbackup.org/ BorgBackup] (short: Borg) is a deduplicating incremental backup program for local and remote data. Optionally, it supports compression and authenticated encryption.		[https://www.borgbackup.org/ BorgBackup] (short: Borg) is a deduplicating incremental backup program for local and remote data. Optionally, it supports compression and authenticated encryption.

	This wiki article extends the documentation in the [https://nixos.org/manual/nixos/stable/#module-borgbase NixOS manual].		This wiki article extends the documentation in the [https://nixos.org/manual/nixos/stable/#module-borgbase NixOS manual].

			Its easier to take the first steps with Borg with using a GUI - information about Vorta is also in the [https://nixos.org/manual/nixos/stable/#opt-services-backup-borgbackup-vorta NixOS manual].

	<syntaxHighlight lang=bash>		<syntaxHighlight lang=bash>

Klinger: Undo revision 20640 The category is not redundant. This application is both an application and a backup app.

2025-03-11T17:55:48Z

Undo revision 20640 The category is not redundant. This application is both an application and a backup app.

← Older revision		Revision as of 17:55, 11 March 2025
Line 209:		Line 209:
	If anybody reading this have found a way to mount as a user properly, please update the code above.		If anybody reading this have found a way to mount as a user properly, please update the code above.

			[[Category:Applications]]
	[[Category:Backup]]		[[Category:Backup]]
	[[Category:NixOS Manual]]		[[Category:NixOS Manual]]
	[[Category:Cookbook]]		[[Category:Cookbook]]

FliegendeWurst: remove redundant category

2025-03-09T16:17:13Z

remove redundant category

← Older revision		Revision as of 16:17, 9 March 2025
Line 209:		Line 209:
	If anybody reading this have found a way to mount as a user properly, please update the code above.		If anybody reading this have found a way to mount as a user properly, please update the code above.

	~~[[Category:Applications]]~~
	[[Category:Backup]]		[[Category:Backup]]
	[[Category:NixOS Manual]]		[[Category:NixOS Manual]]
	[[Category:Cookbook]]		[[Category:Cookbook]]

Klinger: added category:cookbook

2024-05-15T18:34:40Z

added category:cookbook

← Older revision		Revision as of 18:34, 15 May 2024
Line 212:		Line 212:
	[[Category:Backup]]		[[Category:Backup]]
	[[Category:NixOS Manual]]		[[Category:NixOS Manual]]
			[[Category:Cookbook]]

Klinger: added link to nixos manual

2024-05-15T18:33:45Z

added link to nixos manual

← Older revision		Revision as of 18:33, 15 May 2024
Line 1:		Line 1:
	Borg is a backup ~~tool to perform incremental backups,~~ local or remote.		[https://www.borgbackup.org/ BorgBackup] (short: Borg) is a deduplicating incremental backup program for local and remote data. Optionally, it supports compression and authenticated encryption.

			This wiki article extends the documentation in the [https://nixos.org/manual/nixos/stable/#module-borgbase NixOS manual].

	<syntaxHighlight lang=bash>		<syntaxHighlight lang=bash>
Line 209:		Line 211:
	[[Category:Applications]]		[[Category:Applications]]
	[[Category:Backup]]		[[Category:Backup]]
			[[Category:NixOS Manual]]

imported>Onny at 09:58, 7 February 2023

2023-02-07T09:58:46Z

← Older revision		Revision as of 09:58, 7 February 2023
Line 208:		Line 208:

	[[Category:Applications]]		[[Category:Applications]]
			[[Category:Backup]]

imported>Uwu: https://borgbackup.readthedocs.io/en/stable/usage/general.html#environment-variables BORG_UNKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK=no (or =yes)

2021-10-01T02:23:56Z

https://borgbackup.readthedocs.io/en/stable/usage/general.html#environment-variables BORG_UNKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK=no (or =yes)

← Older revision		Revision as of 02:23, 1 October 2021
Line 54:		Line 54:
	encryption.mode = "none";		encryption.mode = "none";
	environment.BORG_RSH = "ssh -o 'StrictHostKeyChecking=no' -i /home/danbst/.ssh/id_ed25519";		environment.BORG_RSH = "ssh -o 'StrictHostKeyChecking=no' -i /home/danbst/.ssh/id_ed25519";
	environment.BORG_UNKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK = "1";		environment.BORG_UNKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK = "yes";
	extraCreateArgs = "--verbose --stats --checkpoint-interval 600";		extraCreateArgs = "--verbose --stats --checkpoint-interval 600";
	repo = "ssh://user@example.com//media/backup/${name}";		repo = "ssh://user@example.com//media/backup/${name}";

imported>Nix: add Software/Applications subcategory

2021-09-20T05:39:51Z

add Software/Applications subcategory

← Older revision		Revision as of 05:39, 20 September 2021
Line 206:		Line 206:

	If anybody reading this have found a way to mount as a user properly, please update the code above.		If anybody reading this have found a way to mount as a user properly, please update the code above.

			[[Category:Applications]]

imported>Danbst at 12:11, 16 June 2020

2020-06-16T12:11:03Z

← Older revision		Revision as of 12:11, 16 June 2020
Line 80:		Line 80:

	After doing at least one successful backup don't forget to test mount it (see next)		After doing at least one successful backup don't forget to test mount it (see next)

			== Notifications when backup fails ==

			Quite often backups do fail. To perform notifications about this situations, you can setup autonotifier for all NixOS borg jobs. This requires creating a separate module, but can be also done inplace in <code>/etc/nixos/configuration.nix</code>

			Note, that example below was for Gnome-shell desktop! For other desktops it may require changes for how to get DBUS session properly!

			<syntaxHighlight lang=nix>
			{ pkgs, config, lib, ... }:

			let
			borgbackupMonitor = { config, pkgs, lib, ... }: with lib; {
			key = "borgbackupMonitor";
			_file = "borgbackupMonitor";
			config.systemd.services = {
			"notify-problems@" = {
			enable = true;
			serviceConfig.User = "danbst";
			environment.SERVICE = "%i";
			script = ''
			export $(cat /proc/$(${pkgs.procps}/bin/pgrep "gnome-session" -u "$USER")/environ \|grep -z '^DBUS_SESSION_BUS_ADDRESS=')
			${pkgs.libnotify}/bin/notify-send -u critical "$SERVICE FAILED!" "Run journalctl -u $SERVICE for details"
			'';
			};
			} // flip mapAttrs' config.services.borgbackup.jobs (name: value:
			nameValuePair "borgbackup-job-${name}" {
			unitConfig.OnFailure = "notify-problems@%i.service";
			}
			);

			# optional, but this actually forces backup after boot in case laptop was powered off during scheduled event
			# for example, if you scheduled backups daily, your laptop should be powered on at 00:00
			config.systemd.timers = flip mapAttrs' config.services.borgbackup.jobs (name: value:
			nameValuePair "borgbackup-job-${name}" {
			timerConfig.Persistent = true;
			}
			);
			};

			in {
			imports =
			[
			....
			borgbackupMonitor
			];
			...
			}
			</syntaxHighlight>

			== Don't try backup when network is unreachable ==

			With persistent timers above you can get into a problem that after reboot backup is tried too fast, even when network is not yet available, and thus fails. This can be solved with systemd failed restart, or using internet-ready check in <code>preStart</code> script.

			Patching previous example:

			<syntaxHighlight lang=nix>
			} // flip mapAttrs' config.services.borgbackup.jobs (name: value:
			nameValuePair "borgbackup-job-${name}" {
			unitConfig.OnFailure = "notify-problems@%i.service";
			preStart = lib.mkBefore ''
			# waiting for internet after resume-from-suspend
			until /run/wrappers/bin/ping google.com -c1 -q >/dev/null; do :; done
			'';
			}
			);
			...
			</syntaxHighlight>

	== Mounting point-in-time archives ==		== Mounting point-in-time archives ==