282 Commits

Author	SHA1	Message	Date
Dan Helfman	ed7fe5c6d0	Instead of executing "before" command hooks before all borgmatic actions run (and "after" hooks after), execute these hooks right before/after the corresponding action (#473).	2022-04-21 22:08:25 -07:00
Dan Helfman	413a079f51	Clarify Python version support.	2022-03-28 21:57:40 -07:00
gerdneuman	6f3accf691	Better explain where to find the dump file ... I really had problem finding the dump file with the explanation as give before. I thought that the `~/.borgmatic/` would be my current user. So looked into `/home/gerd/.borgmatic` (wrong). Then I looked into `<EXTRACTED_DESTINATION_PATH/.borgmatic` (again wrong). Then finally (1h later and after having already prepared a bug ticketI figured out that the dump file is within `<EXTRACTED_DESTINATION_PATH/root/.borgmatic`. Hard to find because of course I d not only have `root` within `<EXTRACTED_DESTINATION_PATH/` but also all other backup'ed directories (including /etc/, /home/ on so on...)	2022-03-17 04:51:47 +00:00
Dan Helfman	c838c1d11b	Fix header placement in documentation guide.	2022-03-14 13:50:22 -07:00
Dan Helfman	4d1d8d7409	Bump version for release.	2022-03-14 13:43:24 -07:00
Dan Helfman	db7499db82	Document "repositories" context to for "before_*" and "after_*" command action hooks (#469).	2022-03-14 13:34:14 -07:00
Dan Helfman	95c518e59b	Documentation tip about dealing with hangs when database hook is enabled.	2022-03-12 13:17:32 -08:00
Dan Helfman	b525e70e1c	Run "compact" action by default when no actions are specified (#394).	2022-02-09 14:33:12 -08:00
Dan Helfman	cbf7284f64	Add compact action to command-line reference documentation.	2022-02-08 15:37:24 -08:00
Dan Helfman	ee466f870d	Fixing ruamel.yaml.clib breakages harder.	2022-02-08 13:21:11 -08:00
Dan Helfman	e3f4bf0293	Build fix for ruamel.yaml.clib error.	2022-02-08 12:52:45 -08:00
Dan Helfman	48f44d2f3d	Add tests for compact action (#394).	2022-02-08 12:05:02 -08:00
Dan Helfman	2ee75546f5	Add MongoDB database hook documentation.	2022-01-04 16:26:38 -08:00
Ian Kerins	3ec3d8d045	Remove references to Lima Labs ... From their homepage: > Lima Labs is shutting down our storage business. We will try to keep data available as long as possible. No promises but we are targeting 3/1/2022 to bring down Archive and Canada.	2022-01-03 02:29:38 -05:00
Dan Helfman	9c19591768	Revise hosting provider links.	2021-11-15 20:06:09 -08:00
Dan Helfman	549aa9a25f	Update editable link.	2021-10-22 14:06:27 -07:00
Dan Helfman	c8fcf6b336	Mention changing borgmatic path in cron documentation (#455).	2021-10-11 11:02:08 -07:00
Dan Helfman	fbbb096cec	Note in documentation that borgmatic requires Python 3.6+.	2021-10-04 11:15:51 -07:00
Dan Helfman	4ba206f8f4	Update build server URL to new organization namespace.	2021-09-14 11:35:34 -07:00
Dan Helfman	ecc849dd07	Move Gitea hosting from a personal namespace to an organization.	2021-09-14 11:32:01 -07:00
Dan Helfman	2bb1fc9826	Mention Docker Compose under installation options.	2021-09-12 13:15:34 -07:00
Dan Helfman	9c972cb0e5	Add documentation note about systemd configuration with alternate install methods (#428).	2021-06-29 21:38:53 -07:00
Dan Helfman	9b1779065e	Pin ruamel.yaml.clib to work around docs build issue.	2021-06-29 21:35:46 -07:00
Dan Helfman	77a860cc62	Link borgmatic Ansible role from installation documentation.	2021-06-19 19:04:22 -07:00
Dan Helfman	cf8882f2bc	Run arbitrary Borg commands with new "borgmatic borg" action (#425).	2021-06-17 20:41:44 -07:00
Dan Helfman	b37dd1a79e	Document use case of running backups conditionally based on laptop power level (#419).	2021-06-09 10:03:35 -07:00
Dan Helfman	7076a7ff86	Add link to Hetzner storage offering from the documentation (#390).	2021-04-18 18:03:43 -07:00
Dan Helfman	9016f4be43	Clarify that spaces in path names should not be backslashed in path names (#406).	2021-04-18 17:28:11 -07:00
Luke Hsiao	5d82b42ab8	Fix link to issue tracker in documentation ... Fixes: a1d986d952	2021-03-18 17:26:37 -07:00
Dan Helfman	a1d986d952	Replace "improve this documentation" form with link to support and ticket tracker.	2020-12-24 14:57:51 -08:00
Dan Helfman	41bf520585	Document that passphrase is used for Borg keyfile encryption, not just repokey encryption (#373).	2020-11-25 18:36:23 -08:00
Dan Helfman	ea6cd53067	Update versions of test dependencies (test_requirements.txt and test containers).	2020-11-22 14:48:07 -08:00
Dan Helfman	667e1e5b15	Update document about new --override behavior (#361).	2020-11-19 11:01:53 -08:00
Dan Helfman	97af16bd86	Add Lima-Labs to examples.	2020-11-18 12:05:38 -08:00
Dan Helfman	7b1fb68c18	Add referral link to Lima-Labs.	2020-11-17 14:04:24 -08:00
Josh Thorpe	cde0ee96ff	Fix typo in large backup docs	2020-11-04 17:20:32 +11:00
Dan Helfman	d06c1f2943	Minor edit.	2020-09-21 10:00:38 -07:00
Luke Murphy	034ade48f2	Add note about empty source_directories	2020-09-21 17:35:26 +02:00
Dan Helfman	d1e9f74087	Restore referal link.	2020-08-27 15:21:53 -07:00
Matthias	631c3068a9	systemd security settings	2020-08-22 15:41:25 +02:00
Dan Helfman	79d4888e22	Add documentation navigation links on left side of all documentation pages.	2020-08-21 14:27:47 -07:00
Dan Helfman	f611fe7be3	Clarify documentation overview of monitoring options.	2020-08-12 10:40:39 -07:00
Dan Helfman	dd6ea40a36	Clarify encryption section: It's not just for cron users.	2020-08-10 14:43:03 -07:00
Dan Helfman	ea1274d1c6	Remove inactive referral link.	2020-08-07 10:55:05 -07:00
Dan Helfman	99590cb6b6	Clarify documentation on configuration overrides, specifically the portion about list syntax.	2020-07-23 21:33:42 -07:00
Dan Helfman	8306b758e8	Add documentation on how to make backups redundant with multiple repositories.	2020-07-17 16:00:50 -07:00
Dan Helfman	218cbd5289	In database documentation, include command for finding named pipes and special devices.	2020-07-13 10:56:59 -07:00
Dan Helfman	2ac58670d5	Clarify database documentation about excluding named pipes and character/block devices to prevent hangs.	2020-07-13 10:45:58 -07:00
Dan Helfman	37cc229749	Fix duplicate logging to Healthchecks and send "after_*" hooks output to Healthchecks (#328).	2020-06-23 11:01:03 -07:00
Dan Helfman	b320e74ad5	Update documentation code fragments theme to better match the rest of the page.	2020-06-17 16:02:57 -07:00
Dan Helfman	0ed8f67b9d	Documentation feedback: Clarify that a Borg manual install is required, separate from installing borgmatic.	2020-06-17 11:42:40 -07:00
Dan Helfman	398665be9e	Allow before_backup and similiar hooks to exit with a soft failure without altering the monitoring status (#292).	2020-06-02 14:33:41 -07:00
Dan Helfman	6db232d4ac	Link to Borgmacator GNOME AppIndicator from monitoring documentation.	2020-06-02 12:53:08 -07:00
Dan Helfman	097a09578a	Fix enabled database hooks to implicitly set one_file_system configuration option to true to prevent Borg hang. (#315).	2020-05-26 09:20:14 -07:00
Dan Helfman	96df52ec50	Fix hang when streaming a database dump to Borg with implicit duplicate source directories by deduplicating them first (#316).	2020-05-20 13:33:53 -07:00
Dan Helfman	244dc35bae	Global install documentation.	2020-05-19 14:19:39 -07:00
Dan Helfman	d9c9d7d2ee	Improve documentation around the installation process. Specifically, making borgmatic commands runnable via the system PATH.	2020-05-18 20:38:43 -07:00
Dan Helfman	89cb5eb76d	Fix regression in support for PostgreSQL's "directory" dump format (#314).	2020-05-18 11:31:29 -07:00
Dan Helfman	6d3802335e	Adding docs note about upgrading to get --files flag.	2020-05-18 08:43:32 -07:00
Dan Helfman	c1d6232b79	Fix documentation to mention new "--files" flag.	2020-05-15 10:45:58 -07:00
Dan Helfman	a23fdf946d	Stream database dumps and restores directly to/from Borg without using any additional filesystem space (#258).	2020-05-07 11:44:04 -07:00
Dan Helfman	a4eef383c3	Spell out repository consistency check options in more detail.	2020-04-29 11:08:41 -07:00
Dan Helfman	ac124612ad	Documentation on macOS launchd permissions issues with work-around for Full Disk Access (#293).	2020-04-26 16:10:52 -07:00
Dan Helfman	6a138aeb6e	Move root vs. non-root instructions.	2020-04-18 13:14:35 -07:00
Dan Helfman	f0ce37801b	Add root vs. non-root to set up guide.	2020-04-17 20:30:10 -07:00
Dan Helfman	35f6aba365	Clarify that borgmatic should be run with sudo after a root --user install.	2020-04-17 09:46:50 -07:00
Dan Helfman	31a5d1b9c4	Docs feedback: Clarify PagerDuty integration instructions.	2020-03-26 14:14:53 -07:00
Dan Helfman	fb4305a953	Add link for Alpine packages of borgmatic to README.	2020-03-10 21:10:02 -07:00
Dan Helfman	3332750243	More documentation examples of a la carte actions.	2020-03-09 11:20:18 -07:00
Dan Helfman	4942b7ce4d	Feedback on PagerDuty hook documentation.	2020-02-13 13:11:25 -08:00
Dan Helfman	46486138b6	Fix PagerDuty link.	2020-02-01 13:43:37 -08:00
Dan Helfman	1ddde0910c	Add security policy, such as it is.	2020-01-30 15:42:48 -08:00
Dan Helfman	79f3b84ca2	Documentation for "--archive latest" (#289).	2020-01-29 17:08:03 -08:00
Dan Helfman	bc02c123e6	Monitor backups with PagerDuty hook integration (#245).	2020-01-27 15:32:09 -08:00
Dan Helfman	8ad8a9c422	Add per-action hooks: "before_prune", "after_prune", "before_check", and "after_check" (#255).	2020-01-27 11:07:07 -08:00
Dan Helfman	b15c9b7dab	Add missing "how to" text.	2020-01-24 21:02:56 -08:00
Dan Helfman	2405e97c38	Backup to a removable drive or intermittent server via "soft failure" feature (#284).	2020-01-24 20:52:48 -08:00
Dan Helfman	f66fd1caaa	Customize Healthchecks log level via borgmatic "--monitoring-verbosity" flag (#277).	2020-01-22 15:10:47 -08:00
Dan Helfman	39550a7fe9	Add ~/.config/borgmatic.d as another configuration directory default (#274).	2020-01-22 09:26:58 -08:00
Dan Helfman	5afe0e3d63	Disable colored output when "--json" flag is used, so as to produce valid JSON ouput (#276).	2020-01-04 15:50:41 -08:00
Dan Helfman	c52f82f9ce	Documentation: Enable and start borgmatic with a single systemctl command.	2020-01-04 13:37:56 -08:00
Dan Helfman	5b1beda82b	Add logrotate documentation suggestion.	2019-12-31 15:06:53 -08:00
Dan Helfman	911668f0c8	Only trigger "on_error" hooks and monitoring failures for "prune", "create", and "check" actions, and not for other actions (#270).	2019-12-20 13:58:02 -08:00
Dan Helfman	6bfa0783b9	Clarify that the documentation suggestion form is only for documentation.	2019-12-17 20:16:13 -08:00
Dan Helfman	f787dfe809	Override particular configuration options from the command-line via "--override" flag (#268).	2019-12-17 11:46:27 -08:00
Dan Helfman	afaabd14a8	Clarify documentation on how /etc/borgmatic.d/ configuration files are interpreted.	2019-12-13 11:42:17 -08:00
Dan Helfman	e009bfeaa2	Update Healthchecks/Cronitor/Cronhub monitoring integrations to fire for "check" and "prune" actions, not just "create" (#249).	2019-12-12 22:54:45 -08:00
Dan Helfman	464ff2fe96	Run end-to-end tests on developer machines with Docker Compose for approximate parity with continuous integration tests.	2019-12-11 16:43:01 -08:00
Dan Helfman	8660af745e	Optionally change the internal database dump path via "borgmatic_source_directory" option in location configuration section (#259).	2019-12-10 16:04:34 -08:00
Dan Helfman	df2be9620b	Mount whole repositories via "borgmatic mount" without any "--archive" flag (#253).	2019-12-06 15:58:54 -08:00
Dan Helfman	375036e409	Support for mounting an archive as a FUSE filesystem via "borgmatic mount" action, and unmounting via "borgmatic umount" (#123).	2019-11-25 14:56:20 -08:00
Dan Helfman	78ff734e6c	Add note about error logs only flowing to Healthchecks for the "create" action.	2019-11-17 19:10:11 -08:00
Dan Helfman	2cc743cf47	With "borgmatic check", consider Borg warnings as errors (#247).	2019-11-17 19:06:28 -08:00
Dan Helfman	50f62d73b7	When using the Healthchecks monitoring hook, include borgmatic logs in the payloads for completion and failure pings (#241).	2019-11-17 16:54:27 -08:00
Dan Helfman	26a89de790	Higher resolution BorgBase logo.	2019-11-14 12:39:33 -08:00
Dan Helfman	c2276b18c5	Add troubleshooting documentation for MySQL lock table errors (#244).	2019-11-14 10:33:47 -08:00
Dan Helfman	1e8edc05e9	Marketing.	2019-11-14 09:34:53 -08:00
Dan Helfman	9ee6151999	Add link to unofficial Fedora package of borgmatic that's more up-to-date.	2019-11-13 14:59:49 -08:00
Dan Helfman	4c38810a32	Add note about rsyslog rate limiting.	2019-11-12 12:32:32 -08:00
Dan Helfman	bf0d38ff2a	Update docs about MySQL/MariaDB database dumps and restores (#228).	2019-11-12 11:59:01 -08:00
Dan Helfman	e4f0a336c2	Fix installation path in docs.	2019-11-07 11:09:27 -08:00
Dan Helfman	68459c6795	Add note about setting PATH environment variable when installing borgmatic.	2019-11-07 11:05:41 -08:00
Dan Helfman	17fda7281a	Monitor backups with Cronhub hook integration. Fix Healthchecks/Cronitor hooks to respect dry run.	2019-11-07 10:08:44 -08:00
Dan Helfman	31d3bc9bd8	In documentation, clarify when Healthchecks/Cronitor hooks fire in relation to other hooks (#238).	2019-11-06 09:44:46 -08:00
Dan Helfman	2115eeb6a2	Upgrade your borgmatic configuration to get new options and comments via "generate-borgmatic-config --source" (#239).	2019-11-06 09:31:00 -08:00
Dan Helfman	e6d8c736d0	Documentation feedback: Don't hard-code Python 3.7 for Black.	2019-11-03 14:08:19 -08:00
Dan Helfman	505bb778fa	Fix logging docs typo.	2019-11-02 12:54:03 -07:00
Dan Helfman	a9104ed090	Handle log file error more consistently with other error. Add --log-file-verbosity flag. Add docs.	2019-11-02 11:23:18 -07:00
Dan Helfman	8fd46b8c70	Monitor backups with Cronitor hook integration.	2019-11-01 11:33:15 -07:00
Dan Helfman	e3dd545345	Extract files to a particular directory via "borgmatic extract --destination" flag. Also rename "--restore-path" to "--path" to reduce confusion.	2019-11-01 10:00:26 -07:00
Dan Helfman	589fc30fc8	To orient the reader, add "borgmatic" to the top of each documentation page.	2019-10-31 22:04:38 -07:00
Dan Helfman	bd3c51fc5a	Documentation for database restores (#229).	2019-10-31 21:45:47 -07:00
Dan Helfman	ca23c3b8b3	Remove unnecessary word from documentation.	2019-10-30 10:55:40 -07:00
Dan Helfman	74607fdd43	Documentation on how to develop borgmatic's documentation.	2019-10-30 10:54:42 -07:00
Dan Helfman	b53684a8f0	Fix incorrect link to hooks documentation.	2019-10-29 09:53:45 -07:00
Dan Helfman	f055f5dea8	Clarify borgmatic restore example with no leading slash.	2019-10-28 12:00:54 -07:00
Dan Helfman	5e3c2da79c	Database dump hooks documentation (#225).	2019-10-23 15:35:37 -07:00
Dan Helfman	c12c47cace	Fix "borgmatic list --successful" with a slightly better heuristic for listing successful (non-checkpoint) archives.	2019-10-16 10:24:58 -07:00
Dan Helfman	d6aaab8a09	Remove parentheses from docs sentence.	2019-10-15 13:02:54 -07:00
Dan Helfman	128ebf04ce	Dead man's switch via healthchecks.io integration (#223) + new monitoring documentation.	2019-10-15 10:49:14 -07:00
Dan Helfman	b1941bcce9	Automatically rewrite links to localhost when developing on docs locally.	2019-10-14 13:13:41 -07:00
Dan Helfman	7b3b28616d	Add "borgmatic list --successful" flag to only list successful (non-checkpoint) archives (#86).	2019-10-13 15:58:11 -07:00
Dan Helfman	59e1cac92c	Correct Arch Linux borgmatic package link.	2019-10-11 14:35:07 -07:00
Dan Helfman	b1f0287fdb	Add documentation link to community AUR (Arch Linux) borgmatic package.	2019-10-11 13:35:57 -07:00
Dan Helfman	99c35d4077	"flags" -> "actions" a few places in the docs.	2019-10-11 10:46:30 -07:00
Dan Helfman	07b9ff61f2	Remove documentation link to the AUR (Arch Linux) borgmatic package, which apparently has been deleted.	2019-10-11 10:42:19 -07:00
Dan Helfman	f573c1810a	Add a suggestion form to all documentation pages, so users can submit ideas for improving the documentation.	2019-10-10 14:27:48 -07:00
Dan Helfman	1d37b14356	More detailed error alerting via runtime context available in "on_error" hook (#174).	2019-10-01 12:23:16 -07:00
Dan Helfman	e14ebee4e0	User-defined hooks for global setup or cleanup that run before/after all actions. (#192).	2019-09-28 16:18:10 -07:00
Dan Helfman	386979ebb4	Mention --stats option in documentation.	2019-09-23 13:13:34 -07:00
Dan Helfman	d6ac7a9192	Upgrade various dependencies.	2019-09-19 13:04:59 -07:00
Dan Helfman	d959fdbf8d	Document new "check --only" command-line flag.	2019-09-19 11:50:29 -07:00
Daniel M. Capella	9a5117db14	Consistently point to stable Borg docs	2019-09-14 17:30:28 -04:00
Dan Helfman	e25f2c4e6c	Clarify documentation/schema about on_error hook running if there's an error in another hook (#202).	2019-07-19 09:25:01 -07:00
Dan Helfman	7ad8f9ac6f	Link to borgmatic-binary installation method.	2019-07-13 15:40:26 -07:00
Dan Helfman	2add3ff7ad	Fix redirect.	2019-07-05 09:19:51 -07:00
Dan Helfman	0602ca1862	Add how-to redirect. Fix capitalization.	2019-07-05 09:03:08 -07:00
Dan Helfman	e973802fc1	Iterate on how-to document name wording.	2019-07-05 08:57:25 -07:00
Dan Helfman	2bdf6dfd70	Merge branch 'master' of ssh://projects.torsion.org:3022/witten/borgmatic	2019-07-05 08:52:06 -07:00
duncanbetts	5587f48bda	Update 'docs/how-to/run-preparation-steps-before-backups.md'	2019-07-05 14:39:21 +00:00
Dan Helfman	fe39453598	Change example filename to be more descriptive.	2019-06-30 17:23:09 -07:00
Dan Helfman	9c75063c05	Unbreak console snippet in docs.	2019-06-30 17:09:34 -07:00
Dan Helfman	5cf2ef1732	Add note to documentation about using spaces instead of tabs for indentation, as YAML does not allow tabs (#199).	2019-06-30 16:58:01 -07:00
Dan Helfman	f35e6ea7ad	Upgrade base layers.	2019-06-27 15:38:00 -07:00
Dan Helfman	90595e9c18	Only log to syslog when run from a non-interactive console (e.g. a cron job). Related to #197.	2019-06-27 14:41:21 -07:00
Dan Helfman	90925c9428	Provide tips about old-style flags for those on older versions.	2019-06-23 16:42:23 -07:00
Dan Helfman	acd6772148	Update documentation to refer to dashless action sub-commands.	2019-06-22 22:09:50 -07:00
Dan Helfman	cd91dbd4f7	Include sub-command help in documentation.	2019-06-22 22:04:56 -07:00
Dan Helfman	74ac148747	Disable console color via "color" option in borgmatic configuration output section (#191).	2019-06-19 20:48:54 -07:00
Dan Helfman	de94001508	Change default syslog verbosity to show errors only.	2019-06-16 21:57:14 -07:00