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
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
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
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
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
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
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
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
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
c2276b18c5
Add troubleshooting documentation for MySQL lock table errors ( #244 ).
2019-11-14 10:33:47 -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
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
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