Divyansh Singh
903507bd03
code review
2023-03-04 01:27:07 +05:30
Divyansh Singh
af1cc27988
feat: add dump-restore support for sqlite databases
2023-03-02 23:55:16 +05:30
Dan Helfman
2a36a2a312
Add "--repository" flag to the "rcreate" action. Add "--progress" flag to the "transfer" action.
2023-02-26 23:22:23 -08:00
Dan Helfman
2814ac3642
Update Borg 2.0 documentation links.
2023-02-26 16:44:43 -08:00
Clemens Lang
8c7d7e3e41
setup: Add link to MacPorts package
2023-02-15 10:47:59 +01:00
Dan Helfman
b811f125b2
Clarify "checks" configuration documentation for older versions of borgmatic ( #639 ).
2023-02-12 21:42:43 -08:00
Dan Helfman
061f3e7917
Remove related documentation links.
2023-01-26 16:12:01 -08:00
Dan Helfman
6055918907
Upgrade documentation image dependencies.
2023-01-26 16:11:41 -08:00
Dan Helfman
30cca62d09
Add configuration options for database command customization ( #630 ).
2023-01-26 14:59:17 -08:00
Dan Helfman
113c0e7616
Update documentation about changes to "all" database restores ( #438 , #560 ).
2023-01-26 10:53:58 -08:00
Dan Helfman
22c750b949
Mention "before_actions" command hook in soft failure documentation ( #631 ).
2023-01-25 13:01:52 -08:00
Dan Helfman
6f3b23c79d
Lowercase borgmatic in documentation.
2022-12-23 14:12:48 -08:00
Macguire Rintoul
116f1ab989
add borgmatic minimum version to compact docs
2022-12-23 13:32:01 -08:00
Dan Helfman
f67c544be6
Optionally dump "all" PostgreSQL databases to separate files instead of one combined dump file ( #438 , #560 ).
2022-12-15 22:59:42 -08:00
Dan Helfman
1ef82a27fa
Clarify data/archives check implicit enabling.
2022-12-12 16:03:05 -08:00
Dan Helfman
6837dcbf42
Clarify documentation about transferring archives between related repositories.
2022-12-10 12:59:44 -08:00
Dan Helfman
694d376d15
Clarify documentation about multiple repositories and separate configuration files ( #613 ).
2022-11-21 13:33:01 -08:00
Dan Helfman
b627d00595
More consistency checks documentation edits.
2022-11-14 15:13:47 -08:00
Dan Helfman
9bd8f1a6df
Clarify consistency check configuration.
2022-11-14 14:58:42 -08:00
Dan Helfman
6aeb74550d
Clarify examples in include merging and deep merging documentation ( #607 ).
2022-10-28 19:33:19 -07:00
Dan Helfman
82b072d0b7
Update documentation to mention using blake2 with "transfer" action.
2022-10-17 15:04:30 -07:00
Dan Helfman
018c0296fd
Document that special file exclusion also excludes symlinks to special files ( #596 ).
2022-10-15 10:14:46 -07:00
Dan Helfman
a31ce337e9
Skip auto-exclusion of special files when user explicitly sets read_special to true ( #587 ).
2022-10-06 11:07:43 -07:00
Dan Helfman
ba8fbe7a44
Add "break-lock" action for removing any repository and cache locks leftover from Borg aborting ( #357 ).
2022-10-04 13:42:18 -07:00
Dan Helfman
2774c2e4c0
Add support for Borg 2's "--match-archives" flag (replaces "--glob-archives") ( #591 ).
2022-10-03 22:50:37 -07:00
Dan Helfman
80e95f20a3
Add "borgmatic borg" documentation note about interactive prompts.
2022-09-20 14:01:47 -07:00
Dan Helfman
858b0b9fbe
Note version of borgmatic needed for "borgmatic borg" action ( #586 ).
2022-09-13 09:05:18 -07:00
Dan Helfman
9cc043f60e
Update "find" command in documentation to work on BSDs and not just Linux ( #583 ).
2022-09-11 20:02:30 -07:00
Dan Helfman
80b8c25bba
Update docs about "source_directories" being optional.
2022-08-25 13:24:26 -07:00
Dan Helfman
317dc7fbce
Add "before_actions" and "after_actions" command hooks that run before/after all the actions for each repository, update docs to cover per-repository configurations ( #463 ).
2022-08-21 21:48:37 -07:00
Dan Helfman
97fad15009
Switch to more accessible header permalink anchors in documentation.
2022-08-21 21:48:07 -07:00
Dan Helfman
462326406e
Drop only-style actions like "--create", rename "prune --files" to "prune --list", and add "--list" alias to "create" and "export-tar" ( #571 ).
2022-08-21 14:25:16 -07:00
Dan Helfman
bbdf4893d1
Clarify --format flag in documentation.
2022-08-19 15:27:03 -07:00
Dan Helfman
dbef0a440f
Merge branch 'master' into patch-2
2022-08-19 15:16:17 -07:00
Dan Helfman
22628ba5d4
Update ssh:// examples in documentation to use relative paths on the remote machine ( #557 ).
2022-08-19 12:00:40 -07:00
Dan Helfman
8576ac86b9
Fix incorrect version in documentation ( #557 ).
2022-08-19 09:44:31 -07:00
Dan Helfman
7dee6194a2
Add new "transfer" action for Borg 2 ( #557 ).
2022-08-18 23:06:51 -07:00
Dan Helfman
00255a2437
Various documentation edits for Borg 2 ( #557 ).
2022-08-18 10:19:11 -07:00
Dan Helfman
b40e9b7da2
Ignore archive filter parameters passed to list action when --archive is given ( #557 ).
2022-08-18 09:59:48 -07:00
Dan Helfman
28d847b8b1
Warn and tranform on non-ssh://-style repositories ( #557 ).
2022-08-17 10:13:11 -07:00
Dan Helfman
2a1c6b1477
Update documentation with newly required ssh:// repository syntax for Borg 2 ( #557 ).
2022-08-16 11:41:35 -07:00
Dan Helfman
cc04bf57df
Update list action for Borg 2 support, add rinfo action, and update extract consistency check for Borg 2.
2022-08-15 15:04:40 -07:00
Dan Helfman
622caa0c21
Support for Borg 2's rcreate and rinfo sub-commands ( #557 ).
2022-08-12 14:53:20 -07:00
Jelle @ Samson-IT
3720f22234
reworded and added 'all' caveat
2022-07-13 22:03:51 +02:00
Jelle @ Samson-IT
f7c8e89a9f
update format specifier syntax link to use anchor
2022-07-13 21:52:21 +02:00
Jelle @ Samson-IT
ba377952fd
Added link to borgbackup list --format docs
...
I kept searching for this link, so it's time to add it to official docs.
2022-07-13 13:52:48 +02:00
Jelle @ Samson-IT
1fdec480d6
Added some info about fetching mysql database size
2022-07-13 13:29:45 +02:00
Dan Helfman
6005426684
Update documentation about configuring multiple consistency checks or multiple databases ( #559 ).
2022-07-03 22:24:25 -07:00
Dan Helfman
673ed1a2d3
Clarify check frequency documentation in regards to multiple configuration files.
2022-07-02 09:40:49 -07:00
Dan Helfman
f1ffa1da1d
Add another recommended flag to the backup documentation ( #554 ).
2022-06-30 16:54:22 -07:00
Dan Helfman
1fc028ffae
In documentation, be more explicit about default actions ( #554 ).
2022-06-29 21:32:00 -07:00
Dan Helfman
2e0b2a308f
Clarify --files flag action in documentation ( #554 ).
2022-06-29 09:20:13 -07:00
Dan Helfman
8336165f23
Update documentation with environment variable escaping ( #546 ).
2022-06-23 10:25:46 -07:00
Dan Helfman
aa013af25e
Remove some whitespace around "New in version ..." documentation labels.
2022-06-16 20:49:15 -07:00
Dan Helfman
cc32f0018b
Start formalizing how new features are flagged by version in documentation.
2022-06-16 20:23:16 -07:00
Dan Helfman
dfc4db1860
Document environment variable interpolation ( #546 ).
2022-06-16 15:30:53 -07:00
Dan Helfman
35706604ea
Upgrade documentation base images.
2022-06-16 15:22:59 -07:00
Dan Helfman
dc4e7093e5
Remove link to related software that hasn't seen updates in the past couple years.
2022-06-09 19:31:50 -07:00
Dan Helfman
0e90a80680
Add links in documentation for ntfy monitoring hook ( #543 ).
2022-06-09 13:41:22 -07:00
Gavin Chappell
a8b8d507b6
add a hook for sending push notifications via ntfy.sh
2022-06-09 21:10:38 +01:00
Dan Helfman
331a503a25
Document the borgmatic version in which "borgmatic list --find" is available ( #541 ).
2022-06-03 16:55:54 -07:00
Dan Helfman
d14f22e121
Add "borgmatic list --find" flag for searching for files across multiple archives ( #541 ).
2022-06-03 15:12:14 -07:00
Dan Helfman
80ec3e7d97
Deprecate "borgmatic list --successful" flag, as listing only non-checkpoint (successful) archives is now the default in newer versions of Borg.
2022-06-02 20:35:39 -07:00
Dan Helfman
cd834311eb
Clarify completion docs.
2022-06-01 10:57:23 -07:00
adidalal
87f3c50931
setup: add macOS
2022-06-01 15:56:40 +00:00
Dan Helfman
8fa90053cf
Add "borgmatic check --force" flag to ignore configured check frequencies ( #523 ).
2022-05-28 19:29:33 -07:00
Dan Helfman
b3682b61d1
Add another note about the consistency checks schema in old versions ( #523 ).
2022-05-28 19:03:45 -07:00
Dan Helfman
ad0e2e0d7c
Tweak default check frequency to 1 month ( #523 ).
2022-05-28 15:49:50 -07:00
Dan Helfman
e76bfa555f
Reduce the default consistency check frequency and support configuring the frequency independently for each check ( #523 ).
2022-05-28 14:42:19 -07:00
Dan Helfman
77b84f8a48
Add Bash completion script so you can tab-complete the borgmatic command-line.
2022-05-26 10:27:53 -07:00
Dan Helfman
316a22701f
Add documentation note about multiple merge limitation ( #380 ).
2022-05-25 23:12:42 -07:00
Dan Helfman
54933ebef5
Change connection failures for monitoring hooks to be warnings instead of errors ( #439 ).
2022-05-24 15:50:04 -07:00
Dan Helfman
02781662f8
Change monitoring hooks to specify the ping URL / integration key as a named option.
2022-05-23 20:02:10 -07:00
Dan Helfman
255cc6ec23
When deep merging common configuration, merge colliding list values by appending them ( #531 ).
2022-05-20 15:28:28 -07:00
Dan Helfman
51fc37d57a
Improve the error message when a configuration override contains an invalid value ( #528 ).
2022-05-20 13:38:53 -07:00
Dan Helfman
1921f55a9d
Add emojis to documentation table of contents to make it easier to find particular how-to and reference guides at a glance.
2022-05-20 11:11:35 -07:00
Dan Helfman
fbd381fcc1
Clarify manual database extraction documentation.
2022-05-20 10:06:19 -07:00
Dan Helfman
cd88f9f2ea
Better explain where to find the dump file when doing a manual restore ( #510 ).
...
Reviewed-on: https://projects.torsion.org/borgmatic-collective/borgmatic/pulls/510
2022-05-20 16:33:21 +00:00
Dan Helfman
788281cfb9
When a configuration include is a relative path, load it from either the current working directory or from the directory containing the file doing the including ( #532 ).
2022-05-19 17:15:05 -07:00
Dan Helfman
cd234b689d
Link to additional borgmatic Docker image.
2022-05-12 12:00:12 -07:00
Dan Helfman
92354a77ee
Mention that database dumps consumed disk space prior to borgmatic 1.5.3.
2022-05-09 16:08:47 -07:00
Dan Helfman
48ff3e70d1
Clarify documentation about include merging mappings vs. values.
2022-05-08 14:48:42 -07:00
Dan Helfman
d58d450628
Remove stale borgmatic binary link.
2022-04-30 09:50:40 -07:00
Dan Helfman
dee9c6e293
Remove link to stale borgmatic Docker image.
2022-04-30 09:46:08 -07:00
Dan Helfman
897c4487de
Add mention in documentation about multiple backup scheduling needs ( #511 ).
2022-04-28 11:16:31 -07:00
Dan Helfman
13bae8c23b
Typo.
2022-04-26 10:12:02 -07:00
Dan Helfman
525266ede6
Deep merging when including common configuration ( #381 ).
2022-04-25 21:18:37 -07:00
Dan Helfman
d045eb55ac
Add mention of sudo's "secure_path" option in borgmatic installation documentation ( #513 ).
2022-04-23 14:29:55 -07:00
Dan Helfman
bdc26f2117
Add note about old, pre-1.6.0 hooks behavior.
2022-04-22 19:58:28 -07:00
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
palto42
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