Commit graph

402 commits

Author SHA1 Message Date
Dan Helfman
08d01d8bcd Documentation formatting. 2023-11-08 17:57:31 -08:00
Dan Helfman
eef69e23ee Document the possible units of times for a configured check frequency. 2023-11-08 17:53:59 -08:00
Dan Helfman
12b75f9075 Update documentation about logging changes from version 1.8.3 (#665). 2023-11-06 21:13:46 -08:00
Dan Helfman
2da43239f6 Fix docs: minor typos (#781).
Reviewed-on: https://projects.torsion.org/borgmatic-collective/borgmatic/pulls/781
2023-11-03 00:59:29 +00:00
debuglevel
4beef36d3c Update docs/how-to/inspect-your-backups.md 2023-11-02 23:14:31 +00:00
debuglevel
eacfbd742b Typo 2023-11-02 23:13:45 +00:00
debuglevel
82a85986b6 Typo 2023-11-02 22:57:46 +00:00
Dan Helfman
ef448e2dd1 Add a "skip_actions" option to skip running particular actions (#701). 2023-10-31 21:54:41 -07:00
Dan Helfman
09594c85bf Be more explicit in documentation that you don't have to use an environment variable for passphrases. 2023-10-10 09:34:55 -07:00
Dan Helfman
e07efdf68f Add documentation note about using includes for specifying passphrases (#769). 2023-10-10 09:16:58 -07:00
Dan Helfman
1fed44f905 Add documentation note about sudo and sudoers "secure_path" option (#757). 2023-10-09 14:15:54 -07:00
Dan Helfman
3eff2c4248 Add Grafana Loki badge to integrations documentation. 2023-10-05 09:06:06 -07:00
Dan Helfman
9587fc2366 Update Apprise documentation to use sudo for pipx install (#715). 2023-10-04 22:54:11 -07:00
Dan Helfman
f011431463 Apprise hook documentation (#715). 2023-10-04 19:23:53 -07:00
Dan Helfman
10933fd55b Fix for borgmatic not stopping Borg immediately when the user presses ctrl-C (#761). 2023-09-27 08:52:00 -07:00
Dan Helfman
af422ad705 Add documentation note about upgrading multiple pipx installations of borgmatic. 2023-09-18 13:46:41 -07:00
Dan Helfman
b540e63c0e Updated documentation so "sudo borgmatic" works for pipx borgmatic installations (#757). 2023-09-17 22:46:33 -07:00
Dan Helfman
5a56208922 Fix documentation typo. 2023-09-15 10:18:35 -07:00
Dan Helfman
0205748db8 Update documentation to recommend installing/upgrading borgmatic with pipx instead of pip. 2023-09-04 16:25:10 -07:00
Dan Helfman
d0a8251ad2 Add borgmatic version introducing Loki hook to docs (#743). 2023-08-27 20:30:13 -07:00
Dan Helfman
32019ea8f3 Add documentation for Grafana Loki hook (#743). 2023-08-25 10:52:00 -07:00
Dan Helfman
6dca7c1c15 Add "key export" action to export a copy of the repository key (#345). 2023-08-07 12:28:39 -07:00
Dan Helfman
fd8c56c6be Add brief source code reference documentation. 2023-08-06 23:44:31 -07:00
Dan Helfman
193dd93de2 Fork a MariaDB database hook from the MySQL database hook (#727). 2023-08-04 13:22:44 -07:00
Dan Helfman
8a94b9e2f1 Mention "store_config_files" in docs (#725). 2023-08-03 22:11:02 -07:00
Dan Helfman
e9bd5f4e1d Add documentation and NEWS link (#732). 2023-08-01 21:12:49 -07:00
Dan Helfman
f6f06551f0 Multiple configuration includes with a single "!include" (#732). 2023-08-01 14:12:35 -07:00
Dan Helfman
88adb5b3de
Add docs for database restore params and config bootstrap (#326, #697).
Merge pull request #74 from diivi/docs/database-restore-params-and-config-bootstrap
2023-07-31 11:56:32 -07:00
Divyansh Singh
59465b256d
Apply suggestions from code review 2023-07-31 23:50:46 +05:30
Divyansh Singh
adfb89ee65 improve docs - wittens suggestions 2023-07-29 00:16:04 +05:30
Dan Helfman
c11dcdef0a Fix some "borgmatic" capitalization issues. 2023-07-26 23:38:08 -07:00
Dan Helfman
309f67e860 Fix documentation comma grammar issues. 2023-07-18 23:27:45 -07:00
Divyansh Singh
1f415a24b8 add docs for database restore params and config bootstrap 2023-07-15 12:27:54 +05:30
Dan Helfman
04fb351a11 Order documentation navigation sections. 2023-07-13 20:20:48 -07:00
Dan Helfman
da78929415 To prevent argument parsing errors on ambiguous commands, drop support for multiple consecutive flag values. 2023-07-13 19:25:14 -07:00
Dan Helfman
2453ecad42 More documentation updates based on section removal (#721). 2023-07-11 22:10:57 -07:00
Dan Helfman
d2fa205476 Update documentation for section removal (#721). 2023-07-11 19:42:14 -07:00
Dan Helfman
9cafc16052 For "borgmatic borg", pass the repository to Borg via a Borg-supported environment variable (#575). 2023-07-03 00:08:54 -07:00
Dan Helfman
fbbfc684ce Add referral link for Hetzner. 2023-07-02 22:14:36 -07:00
Dan Helfman
bb6004fc4f Revamp "borg" action to support REPOSITORY and ARCHIVE env vars instead of implicitly injecting repository/archive into the Borg command (#575). 2023-06-26 14:35:07 -07:00
Dan Helfman
c3004c6090 Some brief documentation on running only checks (#364). 2023-06-25 22:49:36 -07:00
Dan Helfman
e4e455ee45 Deprecate validate-borgmatic-config in favor of new "config validate" action (#529). 2023-06-23 10:11:41 -07:00
Dan Helfman
bc93401a70 Codespell fixes. 2023-06-21 13:14:54 -07:00
Dan Helfman
1b90da5bf1 Deprecate generate-borgmatic-config in favor if new "config generate" action (#529). 2023-06-21 12:19:49 -07:00
Dan Helfman
b10aee3070 Remove upgrade-borgmatic-config command for upgrading borgmatic 1.1.0 INI-style configuration (#529). 2023-06-19 23:17:59 -07:00
Dan Helfman
9152fed249 Add a documentation troubleshooting note for MySQL/MariaDB authentication errors (#399). 2023-06-15 14:55:57 -07:00
Dan Helfman
e15bec30e6 Mention some hang edge cases in database limitations (#710). 2023-06-13 23:34:58 -07:00
Dan Helfman
a6425b8867 Fix moved Arch Linux borgmatic URL. 2023-06-04 22:21:16 -07:00
Dan Helfman
caf654366c Document work-around for colons in YAML strings (#708). 2023-06-03 10:19:34 -07:00
Dan Helfman
518aeabb2a Document verbosity levels (#484). 2023-05-30 22:25:27 -07:00
Dan Helfman
ba845d4008 Codespell saves the day. 2023-05-15 23:25:13 -07:00
Dan Helfman
645d29b040 Fix archive checks being skipped even when particular archives haven't been checked recently (#688). 2023-05-15 23:17:45 -07:00
ennui
c6126a9226 Docs: add Gentoo Linux to other ways to install 2023-05-13 11:22:47 +00:00
ennui
62b11ba16b Docs: add Gentoo Linux to other ways to install 2023-05-13 11:20:47 +00:00
Dan Helfman
4aae7968b8
Add fish shell completions support (#686).
Merge pull request #70 from isaec/feat/fish-completions
2023-05-06 16:00:25 -07:00
Isaac
b7fe2a5031
lowercase fish in docs 2023-05-04 13:27:57 -07:00
Dan Helfman
a60d7fd173 Run "borgmatic borg" action without capturing output so interactive prompts and flags like "--progress" still work. 2023-04-30 15:43:41 -07:00
Isaac
f7e4024fca
add to readme 2023-04-28 14:02:06 -07:00
Dan Helfman
22b84a2fea Switch to Docker Compose for dev-docs script, so podman-docker is no longer needed for Podman users. 2023-04-22 10:07:40 -07:00
Dan Helfman
065be1d9d4 More inclusive language. 2023-04-20 14:28:04 -07:00
Dan Helfman
3b21ce4ce8 Rename "master" development branch to "main" to use more inclusive language (#684). 2023-04-19 21:43:08 -07:00
Dan Helfman
9f5769f87b Make docs/schema a little more container agnostic / less Docker specific. 2023-04-16 15:41:17 -07:00
Dan Helfman
991e08f16d Add Unraid borgmatic installation link to docs. 2023-04-15 09:13:13 -07:00
Dan Helfman
1c67db5d62 Add documentation for "borgmatic restore --schema" (#375). 2023-04-14 16:40:58 -07:00
Dan Helfman
4a94c2c9bf Selectively omit list values when including configuration files (#672). 2023-04-13 14:39:36 -07:00
Dan Helfman
08843d51d9 Replace "sequence" with "list" in docs for consistency. 2023-04-12 10:30:23 -07:00
Dan Helfman
ea9213cb03 Spelling. 2023-04-11 22:12:57 -07:00
Dan Helfman
1ea4433aa9 Selectively shallow merge certain mappings or sequences when including configuration files (#672). 2023-04-11 21:49:10 -07:00
Dan Helfman
4c0e2cab78 View the results of configuration file merging via "validate-borgmatic-config --show" flag (#673). 2023-04-11 10:49:09 -07:00
Dan Helfman
31a2ac914a Add optional support for running end-to-end tests and building documentation with rootless Podman instead of Docker. 2023-04-10 14:26:54 -07:00
Dan Helfman
4cd7556a34 Add "log_file" command hook context to NEWS and docs (#413). 2023-04-06 13:58:37 -07:00
Dan Helfman
080c3afa0d Fix documentation referring to "archive_name_format" in wrong configuration section. 2023-04-05 14:00:21 -07:00
Dan Helfman
616eb6b6da Fix error with "info --match-archives" and fix "--match-archives" overriding logic (#666). 2023-04-04 21:25:10 -07:00
Dan Helfman
00d1dea94e Bump version for release. 2023-04-03 16:11:25 -07:00
Dan Helfman
7e6bee84b0 Add "--log-file-format" flag for customizing the log message format (#658). 2023-04-02 23:06:36 -07:00
Dan Helfman
9712d00680 Add "match_archives" option (#588). 2023-04-01 23:57:55 -07:00
Dan Helfman
275e99d0b9 Add codespell link to documentation. 2023-04-01 14:38:52 -07:00
Dan Helfman
2934d0902c Code spell checking on every test run! 2023-04-01 11:03:59 -07:00
Divyansh Singh
32ab17fa46 merge 2023-04-01 22:12:41 +05:30
Divyansh Singh
6054ced931 fix: run typos 2023-04-01 22:10:32 +05:30
Dan Helfman
f256908b27 Document wording tweaks (#479). 2023-03-31 15:36:59 -07:00
Dan Helfman
3f78ac4085 Automatically use the "archive_name_format" option to filter which archives get used for borgmatic actions that operate on multiple archives (#479). 2023-03-31 15:21:08 -07:00
Dan Helfman
010b82d6d8 Remove unnecessary cd in dev documentation. 2023-03-28 12:45:39 -07:00
Dan Helfman
d96f2239c1 Update OpenBSD borgmatic link. 2023-03-27 23:43:39 -07:00
Dan Helfman
1bcdebd1cc Fix multiple repositories example. 2023-03-27 23:16:44 -07:00
Dan Helfman
489ae080e5 Update docs with a few more "path:" repositories references (#635). 2023-03-27 21:49:31 -07:00
Dan Helfman
61c7b8f13c Add optional repository labels so you can select a repository via "--repository yourlabel" at the command-line (#635). 2023-03-27 15:54:55 -07:00
Dan Helfman
3e8e38011b
Labels for repositories (#635).
Merge pull request #57 from diivi/feat/tag-repos
2023-03-27 15:46:22 -07:00
Divyansh Singh
8bef1c698b add feature to docs 2023-03-27 22:16:39 +05:30
Dan Helfman
f56fdab7a9 Add troubleshooting documentation on PostgreSQL/MySQL authentication errors. 2023-03-25 17:08:17 -07:00
Dan Helfman
8c0eea7229 Add additional documentation link to environment variable feature. Rename constants section. 2023-03-25 08:56:25 -07:00
Dan Helfman
19e95628c3 Add documentation and NEWS for custom constants feature (#612). 2023-03-24 23:47:05 -07:00
Dan Helfman
739a58fe47 Rename scripts/run-full-dev-tests to scripts/run-end-to-end-dev-tests and make it run end-to-end tests only. 2023-03-24 16:24:00 -07:00
Dan Helfman
9851abc2e1 Add documentation on backing up a database running in a container (#649). 2023-03-24 15:18:49 -07:00
Dan Helfman
6351747da5 Add NixOS package link to installation docs. 2023-03-19 09:02:47 -07:00
Dan Helfman
e6605c868d Clarify check frequency default behavior (#653). 2023-03-17 10:09:36 -07:00
Nain
c6829782a3 Fix --editable (mode) option given --user as arg
--user option should be before, or after `--editable .` not in between.
Before seems better.
2023-03-15 06:50:47 -04:00
Dan Helfman
d3086788eb Document how to list database dumps in an archive. 2023-03-08 16:09:41 -08:00
Dan Helfman
8d860ea02c
Enhanced docs with info on fetching mysql database size
Merge pull request #46 from Jelle-SamsonIT/patch-3
2023-03-08 15:52:28 -08:00
Dan Helfman
b343363bb8 Change the default action order to: "create", "prune", "compact", "check" (#304). 2023-03-08 14:05:06 -08:00